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; } } }

What is Parameter.name used for in python toolbox

LizEidsness

According to the python toolbox documentation, a Parameter's name attribute is:

The parameter name as shown in the tool's syntax in Python.

Right. That doesn't mean much. What is it used for? Can I reference a parameter with it in code?

So some tool dialog's get burdened with parameters. Are we really supposed to refer to all by index and remember the order? When we move things around, renumber our code?

There's got to be a better way, but I'm still looking.

Find more posts tagged with

Accepted answers

danielri

If a name is set for a parameter the name is available for interrogation. You could do this.

paramName = parm0.name

You could write a function to search for a given name and return the parameter index. See http://pro.arcgis.com/en/pro-app/arcpy/classes/parameter.htm and http://pro.arcgis.com/en/pro-app/arcpy/functions/getparameter.htm for more information.

along the lines of:

def getParamByName(pName):

iArgCount=arcpy.GetArgumentCount()</CODE><CODE>  # Note, a pIndex of -1 indicates parameter not found

  pIndex= -1

  iCount=0

while (iCount<iArgCount):

param=arcpy.GetParameter(iCount)

if param.name==pName:

pIndex=iCount

iCount=iCount+1

return pIndex;

All comments

RobertMEIER

create a function that writes the parameters to a dictionary keyed with the parameter name.

def createparamsDict(params):

dictParams = {}

for x in range(0, len(params) - 1):
p = params[x]
dictParams[p.name] = p

return dictParams

Then call that at the start of your execute function

paramdict = createparamsDict(parameters)

Then you can just refer to the parameters by thier name.

arcpy.AddMessage(paramdict["storm_pipes"].valueAsText)
arcpy.AddMessage(paramdict["storm_pipes"].datatype)

LizEidsness

So essentially, it's just an attribute of the object. If I want to make it useful, I have to wrap my own code around it.

Thanks,

danielri

If a name is set for a parameter the name is available for interrogation. You could do this.

paramName = parm0.name

along the lines of:

def getParamByName(pName):

iArgCount=arcpy.GetArgumentCount()</CODE><CODE>  # Note, a pIndex of -1 indicates parameter not found

  pIndex= -1

  iCount=0

while (iCount<iArgCount):

param=arcpy.GetParameter(iCount)

if param.name==pName:

pIndex=iCount

iCount=iCount+1

return pIndex;

LizEidsness

Right, but that's not what I mean. In a Python Toolbox specifically, when a parameter is defined, there is a name assigned.

param0 <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>Parameter<SPAN class="punctuation token">(</SPAN>
&nbsp;&nbsp;&nbsp; displayName<SPAN class="operator token">=</SPAN><SPAN class="string token">"Input Features"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp; name<SPAN class="operator token">=</SPAN><SPAN class="string token">"in_features"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp; datatype<SPAN class="operator token">=</SPAN><SPAN class="string token">"GPFeatureLayer"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp; parameterType<SPAN class="operator token">=</SPAN><SPAN class="string token">"Required"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp; direction<SPAN class="operator token">=</SPAN><SPAN class="string token">"Input"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

What is the "name" used for?

If I have a toolbox with say 20 things in it (Perhaps exessive, but it's just an example), if I add a parameter in the middle let's say param8, or move things around, param9 becoms param10, and 10-19 increment. All my

value_name = parameters[9].value calls also have to change, and I have to keep track. By index.

It would be useful to do something like parameters["in_features"] as in the above example. But it's not possible, so what is "name" used for?

danielri

Within a python program you can do this to get the values from the Model Process that called it.

#Check to see if we have the expected number of parameters, in this case 2

if arcpy.GetParameterCount !=2:
print "Script requires two arguments (table file name and a field name)."
raise Exception

# Gets the value from the Model Process
theFileName= arcpy.getparameterastext(0)

theFieldName= arcpy.getparameterastext(1)

Some coders also use

theFileName= sys.argv[1].lower()

theFieldName=sys.argv[2].lower()

In this case sys.argv[0] would be the name of the 'program' itself.

Rich

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.