topic Re: SetParameterAsText To View Python Tool Results in Python Questions

SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Sun, 12 Dec 2021 00:58:20 GMT

I have the following which I can successfully get my desired results with the input prompt standalone script. Yet, I prefer that a tool I created to be used and display the results. What am I missing in order to view the results?

#Import Modules
import csv,os,arcpy

#Set variables
ifile  = open('PythonShellSave.csv','r')
reader = csv.reader(ifile)
featureclass = input("Name of the feature class ? ")
#featureclass = arcpy.GetParameterAsText(0)
 
#Set path location of Excel (CSV) file 
path = 'C:\WriteMxdInfoToExcel'
os.chdir(path)

#CSV Module terminology row is horizontal & field is vertical;column is horizontal & row is vertical for excel.
for row in reader:
          for field in row:
              if field == featureclass:
                  print row [4] + " " + featureclass
                 
arcpy.SetParameterAsText(1,row)

#Close Excel (CSV) file
ifile.close()

Re: SetParameterAsText To View Python Tool Results

DanPatterson_Retired — Wed, 08 Jun 2016 22:00:16 GMT

are you wanting to see the equivalent of a print statement within arcmap?

if so AddMessage—Help | ArcGIS for Desktop

you may find it easier to accumulate messages then just include 2 lines so you can 'print' witnin and out arcmap

.....

msg += "more stuff"

arcpy.AddMessage(msg) # for inside arcmap

print(msg) # python 2 and 3 compliant

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Wed, 08 Jun 2016 22:03:36 GMT

Yes equivalent of a print statement within arcmap.

I just want to view results.

I will take a look about AddMessage, thank you.

Re: SetParameterAsText To View Python Tool Results

DanPatterson_Retired — Wed, 08 Jun 2016 22:12:46 GMT

for example your line

print row [4] + " " + featureclass

could be

msg = row[4] + " " + featureclass

print(msg)

arcpy.AddMessage(msg)

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Sun, 12 Dec 2021 00:58:22 GMT

If you want something more generic with a time stamp (sorry about the %formatting instead of the {} .format style...haven't updated it for a while)

import time
import arcpy

def timeStamp():
    """
    returns time stamp.
    """
    return time.strftime(' --  %B %d - %H:%M:%S')

def myMsgs(message):
    arcpy.AddMessage(message + ' %s' %(timeStamp()))
    print(message)     # + ' %s' %(timeStamp()))

then if you enter

myMsgs("you message here with whatever formatting {0}".format(variableToFormat))

the myMsgs will work in either without having to add both lines. works for me (in my_utils.py file) but it is a pain when I have to share my code on the forums.

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Thu, 09 Jun 2016 14:57:02 GMT

Thank you for the input. However I am not familiar enough with the time module nor what the % means. I am not aware of .format either. As you can see I am beginner and I am just learning and attempting to properly use the Add Message, which I am still working on.

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Sun, 12 Dec 2021 00:58:25 GMT

Sorry about that Devin, I did a quick copy paste. Here is a simpler version with the time module removed. I just have that in there so I could get a time stamp on each message so I knew how long each process was taking...not a necessary component at all. This sample imports arcpy, creates the simple myMsgs function and has five samples using it with the function. This should work in the python window, or if you run it in a arcpy script (.py file).

Sample 1: just text

Sample 2: a variable

Sample 3: some text, two variables and a blank line after The {#} line up with the variables in the .format( ) part. The # isn't mandatory, but good practice and allow you to reorder or even repeat the use of a variable in the list

Sample 4: some text and some math with the number variable

Sample 5: reusing one of the variables in the list.

These formats work with both the print and AddMessage

import arcpy

def myMsgs(message):  
    arcpy.AddMessage(message)
    print(message)    
    

somethingToPrint = "print this message"
aNumber = 5

myMsgs("printing just a line of text I type here")
myMsgs(somethingToPrint)
myMsgs("printing {0} with a number {1} with a blank line after \n".format(somethingToPrint, aNumber))
myMsgs("printing with a number + 1: {0} ".format(aNumber + 1))
myMsgs("{1}: printing {0} with a number {1} with a blank line after \n".format(somethingToPrint, aNumber))

Hope this helps

edit: btw, you should check out and bookmark Dan Patterson 's Py... blog for many hints and other links.

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Thu, 09 Jun 2016 16:44:34 GMT

Thank you for taking the time to further explain. Will this work in a script that I am using with a tool I created? To automatically display message to results? I tested out the function but it is not automatic when run and seen in python shell. However, as mentioned, my actual goal is to use it as a tool.

I will take a look at the Blog, thanks.

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Thu, 09 Jun 2016 17:22:26 GMT

yes, it should. The function will know if it is in a script or in the window and print as needed, while ignoring the other. I use this all the time since I switch between the two and it's a hassle to change and/or have both.

Tip: if you are tying to debug but don't know where it is crashing, you can put lots of these within your code maybe even right after each process... I many times do simple numbered statements just to see how far it gets so I can track down an issue..

...a process

myMsgs("here1)

..another process

myMsgs("here2)

Of course you would want something more meaningful for your final script,

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Sun, 12 Dec 2021 00:58:28 GMT

I am trying to have Add message for the variable, but I am having trouble calling the function with the variable.

#Import Modules
import csv,os,arcpy,time 

#Set variables
ifile  = open('PythonShellSave.csv','r')
reader = csv.reader(ifile)
featureclass = input("Name of the feature class ? ")
#featureclass = arcpy.GetParameterAsText(0)

#Set path location of Excel (CSV) file 
path = 'C:\Users\WriteMxdInfoToExcel'
os.chdir(path)

# Create function
def myMsgs(message):  
    arcpy.AddMessage(message)
     
#CSV Module terminology row is horizontal & field is vertical;column is horizontal & row is vertical for excel
for row in reader:
          for field in row:
              if field == featureclass:
                  final = row[4] + " " + featureclass
                  print final
                  myMsgs (final)
                 
#Close Excel (CSV) file
ifile.close()

Re: SetParameterAsText To View Python Tool Results

DanPatterson_Retired — Thu, 09 Jun 2016 17:48:57 GMT

put

print(message)

inside the def after or before the adrcpy add message

get used to print statments using brackets is print("stuff") get ready for python 3

use raw format in paths (ie add an r r"c:\mypath\some.txt"

you will get a failure if you don't 'string' stuff

def myMsgs(message):

""" a test """

msg = "not another message... {0}".format(message)

print(msg)

arcpy.Addmessage(msg)

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Thu, 09 Jun 2016 17:55:29 GMT

you don't need to import time since you are not using.

change path = 'C:\Users\WriteMxdInfoToExcel' to path = r'C:\Users\WriteMxdInfoToExcel'

(see dan's blog on file names)

I would add

arcpy.env.workspace = path

and remove the os.chdir(path)

include for the arcy.AddMessage and the print in the myMsgs function or you will have to change each time. Get used to using print(message) with the parans since the next version of python will require it. Again, Dan points to some good resources for what's coming.

Try those things and see if you get further.

....edit....what Dan said....

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Sun, 12 Dec 2021 00:58:31 GMT

Good points, I have used py 3 several times and had issues not being able to print until I learned about needing parenthesis. So good practice to use them in py 2 as well since it will work.

I would only use the r' raw for paths that were not for my pc, but I will include it every time now.

I made the other suggested changes and trying to grasp what Rebecca and Dan said to arrive at the edited code which states message has not been defined after running the script.

#Import Modules
import csv,os,arcpy

#Set variables
ifile  = open('PythonShellSave.csv','r')
reader = csv.reader(ifile)
featureclass = input("Name of the feature class ? ")
#featureclass = arcpy.GetParameterAsText(0)

#Set path location of Excel (CSV) file 
path = r'C:\UsersWriteMxdInfoToExcel'
arcpy.env.workspace = path

#Create Function
def myMsgs(message):
    arcpy.AddMessage(msessage)
    print (message)

#CSV Module terminology row is horizontal & field is vertical;column is horizontal & row is vertical for excel
for row in reader:
          for field in row:
              if field == featureclass:
                  final = row[4] + " " + featureclass
                  print (final)
                  myMsgs(message)
                 
#Close Excel (CSV) file
ifile.close()

Re: SetParameterAsText To View Python Tool Results

DanPatterson_Retired — Thu, 09 Jun 2016 20:44:20 GMT

your first variable should be

message = "" # two double or two single quotes

also

print(message) # no spaces between print and the bracket

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Thu, 09 Jun 2016 20:50:49 GMT

if you are going to us

myMsgs(message)

as you show in line 25, then you need to have a

myMsgs(final)

just link you are trying to print in line 24....which line 24 could be commented out.

the myMsgs(message) assuming that the variable "message" is already set, and passes the value of it to the function. if you want that line to stay as is, then add

message = final

before that....assuming "final" is a good variable.

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Thu, 09 Jun 2016 21:46:11 GMT

I will take a look at the Blog, thanks.

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Sun, 12 Dec 2021 00:58:33 GMT

I believe this reflects your comments.

#Import Modules
import csv,os,arcpy

#Set variables
ifile  = open('PythonShellSave.csv','r')
reader = csv.reader(ifile)
featureclass = input("Name of the feature class ? ")
#featureclass = arcpy.GetParameterAsText(0)

#Set path location of Excel (CSV) file 
path = r'C:\Users\dunderwood\Documents\My Python Scripts\WriteMxdInfoToExcel'
arcpy.env.workspace = path

#Create Function
def myMsgs(message):
    arcpy.AddMessage(message)
    print(message)

#CSV Module terminology row is horizontal & field is vertical;column is horizontal & row is vertical for excel
for row in reader:
          for field in row:
              if field == featureclass:
                  final = row[4] + " " + featureclass
                  #print(final)
                  message = final
                  myMsgs(message)
                 
#Close Excel (CSV) file
ifile.close()

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Thu, 09 Jun 2016 22:27:56 GMT

Not running it myself, if it works in the python window, I would think it would run as a tool. One more warning, try to keep away from any spaces or special characters in file names/paths. I may work, but it will come back to bite you at some points. Also, keep filenames and field names short, i.e. not ThisIsAFieldNameForWhoKnowsWhat

How To Name Things In ArcGIS in Curtis Price's Blog

Re: SetParameterAsText To View Python Tool Results

DevinUnderwood2 — Thu, 09 Jun 2016 22:59:20 GMT

Make sense, I will make note of creating better naming conventions.

Interesting how when I run it as a tool the results yield successful but the add message doesn't appear.

Maybe my tool parameters are set incorrectly.

The tool works fine as I use a dropdown to navigate to location of featureclass. This is straight forward.

The output I am not entirely sure about.

Re: SetParameterAsText To View Python Tool Results

RebeccaStrauch__GISP — Thu, 09 Jun 2016 23:22:09 GMT

hmm. Not sure off hand why the AddMessage wouldn't show up in results. here i part of the results from one of my tools that is under construction....all those with the date/time tacked on the end are myMsgs