topic Re: Why doesn't Python script add output automatically to map? in Python Questions

Why doesn't Python script add output automatically to map?

KirstynAlex — Sun, 12 Dec 2021 01:49:26 GMT

This is the first Python script I've written in a few years, so this is probably a rookie question.

I wrote this script that creates 3 different buffers around a point shapefile, and it works, but doesn't automatically add the buffers to the map, it just saves them in the specified workspace. In my Geoprocessinng options I have it set to add outputs to map and it works with all ESRI tools but not my script. Any ideas? Thanks in advance!

Here is my script:

# Script Name: EpicenterBuffers
# Description: Creates 10, 50, and 100 KM
#              buffers around an epicenter
# Created By:  Kirstyn Pittman
# Date:        11/24/14


import arcpy
arcpy.env.workspace = r"H:\Drafting Department\Python\EpicenterBuffers"
shp = "Location"
distanceList = ["10 kilometers","50 kilometers","100 kilometers"]
# Loop through each distance in the distanceList
for dist in distanceList:
    outName = shp+"_"+dist
    arcpy.Buffer_analysis(shp, outName, dist)
print "Finished Buffering"

Re: Why doesn't Python script add output automatically to map?

TimothyHales — Mon, 24 Nov 2014 17:45:46 GMT

Try:

arcpy.addOutputsToMap = true

env(arcpy)

Re: Why doesn't Python script add output automatically to map?

KirstynAlex — Mon, 24 Nov 2014 17:54:21 GMT

Thanks! I tried that, gives me this error though:

Executing: EpicenterBuffer C:\GISData\10345_01_VineyardPointe\LOCATION.shp

Start Time: Mon Nov 24 09:56:05 2014

Running script EpicenterBuffer...

<type 'exceptions.NameError'>: name 'true' is not defined

Failed to execute (EpicenterBuffer).

Failed at Mon Nov 24 09:56:06 2014 (Elapsed Time: 1.00 seconds)

Re: Why doesn't Python script add output automatically to map?

TimothyHales — Mon, 24 Nov 2014 17:56:46 GMT

It accepts a Boolean value, so that should have been capitalized. 0/1 or True/False

Re: Why doesn't Python script add output automatically to map?

KirstynAlex — Mon, 24 Nov 2014 18:14:22 GMT

Oh I see! Well I didn't get an error that time and the tool still worked like it did before--still doesn't add the outputs to ArcMap but adds them to my workspace. Not sure what the problem is!

Re: Why doesn't Python script add output automatically to map?

RichardFairhurst — Mon, 24 Nov 2014 18:36:51 GMT

A standalone python script is not a geoprocessing tool, and the import of arcpy does not replicate all of the behaviors that operate within an open session of ArcMap. Environment settings that apply directly to an open session of ArcMap are ignored by Python scripts, such as arcpy.overwriteOutputs = True and arcpy.addOutputsToMap = True; but they are exposed through arcpy to control the user experience in an open session of ArcMap (i.e., whatever arcpy did to these settings will persist and affect how ArcMap responds when the user tries to save over a file or run a geoprocessing tool, so a programmer can control user capabilities).

You need to explicitly do these tasks with arcpy. You have to use the arcpy.mapping.AddLayer method to have your script add layers after creating new data. You also cannot overwrite data, and have to test if it exists and then delete it with arcpy.Exists() and arcpy.Delete_management() (the Exist sample code demonstrates this).

Re: Why doesn't Python script add output automatically to map?

KirstynAlex — Mon, 24 Nov 2014 18:51:30 GMT

Thank you, I understand!

Re: Why doesn't Python script add output automatically to map?

curtvprice — Tue, 25 Nov 2014 04:37:48 GMT

If you set up the python script as a script tool with parameters for your output feature classes they will be added to your map - when the script is run as a script tool from ArcMap. If you are generating the pathnames inside the script, the output parameters would be set up as derived parmeters and you would return their values using the arcpy SetParameterAsText method.

This is all covered in the help on script tools.

Re: Why doesn't Python script add output automatically to map?

Zeke — Tue, 25 Nov 2014 13:01:29 GMT

Wait - are you saying that if I set arcpy.overwriteOutput = True in a stand alone script run from an IDE (PyScripter, in my case) it has no effect? Or maybe I'm misunderstanding. That's not my takeaway from the help files, 'Environment values set within scripts only apply to the execution of the script'.‌ Am I missing something?

Re: Why doesn't Python script add output automatically to map?

RichardFairhurst — Tue, 25 Nov 2014 14:09:39 GMT

Yes, I am saying that based on years of having that environment parameter ignored. I left it in my scripts, but always get errors that I am trying to overwrite existing files if that is the only parameter used to overwrite files in my script. It was only the Exist() method and Delete_management() methods that have allowed me to use Scheduler or Idle for my scripts. I don't think that option works at all outside of the Python window inside a live session of ArcMap or perhaps a tool run within an open ArcMap session. Python has no innate interactions with ArcMap, and importing arcpy does not set your script up with full a Desktop like environment without interacting with an actual ArcMap session.

Re: Why doesn't Python script add output automatically to map?

RichardFairhurst — Tue, 25 Nov 2014 15:11:45 GMT

I just tested it to make sure nothing has changed. A script run in Idle with the env.overwriteOutputs = True setting produces errors like this when attempting to overwrite an output with a tool.

Traceback (most recent call last):

File "C:\Python26\ArcGIS10.0\temp_sums.py", line 26, in <module>

arcpy.Statistics_analysis(intable, outtable, stats)

File "C:\Program Files (x86)\ArcGIS\Desktop10.2\arcpy\arcpy\analysis.py", line 1089, in Statistics

raise e

ExecuteError: Failed to execute. Parameters are not valid.

ERROR 000725: Output Table: Dataset \\agency\agencydfs\CustomApps\rfairhur\Layers\Application.gdb\PARCELS_ASSESSOR_SUMS already exists.

Failed to execute (Statistics).

If the quote is true that env settings have no effect outside the script, then I have to consider this behavior a bug, since overwriteOutputs has never worked inside my scripts run from Idle. However, this bug has existed since the old GP syntax and has never been addressed since python geoprocessing scripts were developed.

Based on Curtis' post it does seem that the overwrite outputs works as a tool. However, most of my scripts are for after hours batch processing, so it does not help me in that case. The Exists() and Delete_management() approach will work in any set up, so I recommend using it to avoid a gotcha if you want to do stand alone scripts.

Re: Why doesn't Python script add output automatically to map?

Zeke — Tue, 25 Nov 2014 15:48:17 GMT

Hmm... not getting an error in a script I just wrote, but maybe it's not overwriting either? Will have to check this out. Good to know.

Re: Why doesn't Python script add output automatically to map?

MatthewHowe — Sun, 12 Dec 2021 01:49:29 GMT

Instead of adding it in the main script, it works by adding it to the start of the validation script. In my case, a plot that I created with Matplotlib was being added to the TOC in the current ArcMap session. This prevented it from happening. If it isn't adding automatically, just switch the boolean to True.

import arcpy
class ToolValidator(object):
"""Class for validating a tool's parameter values and controlling
the behavior of the tool's dialog."""

arcpy.env.addOutputsToMap = False‍‍‍‍‍‍‍‍‍‍‍‍