topic Re: Differences between Notebook execution and Toolbox execution in Python Questions

Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Tue, 29 Mar 2022 15:24:44 GMT

Greetings..I'm running a Python script in the Notebook environment and it works as expected. If I try to run as a standalone script in a Toolbox, it fails unexpectedly. Is there a difference, and what are the differences, between the Notebook runtime and the Script/Toolbox runtime?

Thanks

Re: Differences between Notebook execution and Toolbox execution

DuncanHornby — Tue, 29 Mar 2022 15:48:55 GMT

What's the error message?

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Tue, 29 Mar 2022 16:11:09 GMT

Hey Duncan, thanks for the reply. I don't get an error message, just inconsistent behaviour. For instance, if I use the JoinField function in the Notebook environment between a feature and a table, it behaves as expected. If I run the same script as a Toolbox script, it does not error, completes as expected but fails to make, or maybe save, the join. Is there some automatic functionality in the Notebook environment that saves that join result for me that doesn't exist in the Toolbox environment?

I should add, this is early days for me in Python, so speak to me like I'm a Labrador Retriever... 🙂

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Tue, 29 Mar 2022 17:12:49 GMT

Another thought..are the Environment settings different in the Notebook runtime vs the Script runtime? Things like, AutoCommit, Maintain Fully Qualified Field Names. Do I need to explicitly set these values or are they inherited from the APRX environment at runtime for both the Notebook and Tool Script environments?

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Tue, 29 Mar 2022 18:21:09 GMT

Further information. I'm actually creating a table using the TableToTable Conversion function. The table gets created, is added to my local geodb, is added to my map and then joined to an existing feature. If i perform these tasks in the Notebook environment, the join is added successfully. If it do this in the Toolbox environment, it does not create/save the join. If the table already exists (ie I don't create it in my script..) then it will create and save the join correctly. So it would appear that something in the TableToTable conversion function is not the same in Notebook vs Toolbox. Is there some necessity to "save" the table in a special fashion to make it available to the subsequent calls in the Toolbox environment? It's successfully added to my geodb and map in the Toolbox environment but it fails to execute the join correctly. Fairly annoying...

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Tue, 29 Mar 2022 20:05:28 GMT

So this is the same issue I believe.

https://community.esri.com/t5/python-questions/arcgis-pro-python-addjoin/td-p/1016171/page/2

Re: Differences between Notebook execution and Toolbox execution

DuncanHornby — Wed, 30 Mar 2022 09:15:55 GMT

Scott,

Without seeing your code it's difficult to offer up a solution. I have to confess I don't use the notebook environment, and see little use for it.

I would normally develop a script in an IDE such as spyder and either run it there directly or paste it into the python console or wire it up to a script tool interface, which sounds like what you are doing.

I would be surprised if notebook implements environmental settings in a different way to toolbox so my suspicion is that its a flaw in the code and if you shared it with some of your data and I too replicate the problem then that would be good evidence to log a bug with esri.

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Wed, 30 Mar 2022 14:20:13 GMT

Thanks Duncan. I messed around last night doing some stuff and realized that my issue is likely the referencing of items in my current ArcPro session in the Notebook environment vs trying to access these items from a standalone script. I think this is a fundamental thing I have to understand better. For instance, in a standalone script, can i get a handle on the aprx, then a map, then add a layer in the map from a standalone script? Within the Notebook environment it's implicit where these things are going. From standalone, I'm not sure I'm accessing the map etc correctly to be able to add and modify layers.

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Wed, 30 Mar 2022 14:39:42 GMT

Here is a little snippet. This fails to add the table when run as standalone. I'm not sure that I am addressing the aprx correctly and it's not able to add or save the table addition. Any insight would be great.

import arcpy

# set geodb to be worked on
arcpy.env.workspace = r"C:\LocalWork\SLN_Replacement\SLN_Replacement.gdb"
#aprx = arcpy.mp.ArcGISProject("CURRENT")
aprx = arcpy.mp.ArcGISProject(r"C:\LocalWork\SLN_Replacement\SLN_Replacement.aprx")
m = aprx.listMaps("Map")[0]

# get handle on table to add
addTab = arcpy.mp.Table(r"C:\LocalWork\SLN_Replacement\SLN_Replacement.gdb\AddressWorking")
# set flag
found = 0

# test for AddressWorking already in the Map and add if needed
tables = m.listTables()
print("Got tables list.")
if tables is not None:
for table in m.listTables():
if table.name == "AddressWorking":
print("Found AddressWorking.")
arcpy.AddMessage("Found AddressWorking.")
found = 1
if found == 0:
print("Adding AddressWorking.")
m.addTable(addTab)

# save aprx
aprx.save

# clean up
del aprx, m, tables, found

print("Done.")
arcpy.AddMessage("Done.")

Re: Differences between Notebook execution and Toolbox execution

DuncanHornby — Wed, 30 Mar 2022 15:25:57 GMT

When you say run as a "standalone script", how exactly are you doing that? Are you wiring it up to Tool script interface? If so I don't see you setting any parameters which would be expected as that is what a script tool is. Or are you running it in an IDE or python console outside ArcPro?

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Wed, 30 Mar 2022 15:31:16 GMT

So I'm basically dev'ing it in the Notebook and then saving to a .py file and running as a Tool Script. What parameters would be required? Typically. Is this well documented in the Python docs? I can look it up if so. Again, thanks for your tolerance Duncan.

Re: Differences between Notebook execution and Toolbox execution

DuncanHornby — Wed, 30 Mar 2022 15:56:34 GMT

I think the issue is with the save() method on the project. Here is my minimal code:

import arcpy p = arcpy.mp.ArcGISProject('current') m = p.listMaps('Map')[0] addTab = arcpy.mp.Table(r"C:\Scratch\fGDB_Scratch.gdb\London") m.addTable(addTab) # p.save() # This does not work! p.saveACopy(r"C:\temp\Scott\Scott2.aprx") arcpy.AddMessage("Saved!")

I connected the script to a tool script but as there are no input parameters the tool runs as this:

The Table is added as shown below:

Now if I use p.save() instead of p.saveACopy() then the table IS NOT saved to the project. This seems like a bug to me.

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Wed, 30 Mar 2022 16:51:34 GMT

I suppose if you're in the same aprx file that you're trying to save from a Tool script, the file may be locked and unable to be saved. Perhaps I'll try from another aprx and see if this the case.

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Wed, 30 Mar 2022 16:54:34 GMT

I guess another question is, is there an elegant way to run a script inside your current session other than a Tool Script or hitting the Run button inside the Notebook environment?

Re: Differences between Notebook execution and Toolbox execution

DuncanHornby — Thu, 31 Mar 2022 08:58:59 GMT

Looks like a bug introduced by ESRI in the latest version.

https://community.esri.com/t5/python-questions/project-service-aprx-object-save-error-from-pro-2/m-p/1119713#M63045

Re: Differences between Notebook execution and Toolbox execution

Scott_T_Anderson — Thu, 07 Apr 2022 16:54:11 GMT

So I've learned a few things..but not everything..about this particular situation. The functions that were failing I believe are mostly because I was trying to manipulate the aprx I was currently in using a Tool Script, which functions outside of the current environment. I don't think changes are saved automatically and I don't think they CAN be saved because I'm in the aprx in my own session outside of the Python session.

I've resigned myself to running my scripts via the Notebook interface and using CURRENT as my aprx parameter. This behaves as expected but is a bit ugly because you're running the script from the Notebook dev environment's Run button.

If anyone else stumbles into this, the difference between how a Notebook script using the CURRENT parameter vs a standalone script trying to access the current aprx file is significant. I will try to automate the script by using a button instead of a Tool script.

Thank you Duncan for endeavouring to locate my issues.