nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to determine in which context a python script is run?

BenoitThierry

Hello --

Python scripts can be used either as stand-alone script or as a script tool. Is there (programmatically speaking) a way to determine in which context a script is run?

Thanks

Benoit

Find more posts tagged with

Accepted answers

All comments

BenoitThierry

This does it! Thanks!

Benoit

Hi

You might try importing sys and testing sys.executable, in process that is ArcMap.exe (or Catalog).

Regards

AustinMilt

Hi

You might try importing sys and testing sys.executable, in process that is ArcMap.exe (or Catalog).

Regards

Scratch what I said. use Bruce's method (as I am about to do).

AustinMilt

I've wondered this same thing myself. Here's my (imperfect) solution applied to your problem:

def printMessage(msg):
allModules = dir()
if 'Tool Validator' in allModules: # Called from ArcMap
gp.AddMessage(msg)

else: # Called from command-line
print msg

I'm not sure if this is what you were looking for, but it has worked for me, as I just wanted to change the command-line syntax of arguments. It's a flawed method because 1) There could be a separate module called Tool Validator already loaded into Python that was not loaded by ArcMap and 2) If you don't "run script in process" then the Tool Validator module is not loaded.

Hope this helps.

bharold

Hi

You might try importing sys and testing sys.executable, in process that is ArcMap.exe (or Catalog).

Regards

BenoitThierry

One of the reason why I want to determine script context is to get a clean message output. As you can see from the included JPEG, gp.AddMessage provides a garbled text. Selecting the proper way of displaying a message (print in script context and gp.AddMessage in tool context) would allow me to avoid this problem.

But maybe is there another way of doing this I'm not aware of?

BenoÃ®t

test.jpg

DanPatterson_Retired

you can have it both ways by directing your messages to a list, then printing them when desired. for example, you can use:

messages = []
messages.append("hello")
.....
messages.append("another message")
.....
etc
then use

messages.append("finished processing")
#print messages
printMessages(messages)

and it won't matter whether you are running the script from pythonwin or arctoolbox. A note, if you terminate any process using sys.exit() make sure that you throw the printMessages line before exiting and before the geoprocessor (gp) is deleted

def printMessages(messages):
  '''provide a list of messages to this method'''
  for i in messages:
    print i
    gp.AddMessage(i)

BenoitThierry

Actually, my workflow is: (1) develop the script within Eclipse (with sys.argv), (2) debug it within Eclipse, (3) run it as a tool in ArcGIS or as a script in Windows command line.

As you see, my problem is to determine **at runtime** if the script is called as a tool from within ArcGIS or directly from PythonWin (or others). This would allow me to change the output formating/debug information displayed according to the context (for instance avoiding the use of gp.addmessage when run in command line mode). Your solution would only work to evaluate for which primary purpose the code has been developed (tool or script), right?

In other suggestion?

Benoit

JamesHood

One method might be to look at the script itself.

The input parameters will be either hard coded or not.

If for instance you inputs look similar to this: Input1 = "c:/temp/shape.shp" or Input2 = "c/project1/point.shp"
you might conclude that the script can be run as a script.

However, if the script contains inputs like these: Input1 = sys.argv[1] and Input2 = sys.argv[2] etc..
you might conclude that the script is better suited as a script tool.

Also maybe check to see if it has been loaded into an ArcToolbox already. If so it has already been converted to a script tool.

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.