[GIS] Debugging AttributeError: ‘module’ object has no attribute ‘Parameter’ from Python Toolbox of ArcPy

arcpyattributeerrorpython-toolbox

I have a big .pyt script (python toolbox) and now i trying split it to many files (1 file – 1 tool).

In single .pyt file everything works perfectly, but when file is splited i get this message:
AttributeError: 'module' object has no attribute 'Parameter'.

Structure of files:

My Catalog:
-- toolbox.pyt
-- toolpackage:
---- configurator.py
---- __init__.py

toolbox.pyt:

# This Python file uses the following encoding: utf-8

import arcpy

from toolpackage.configurator import ToolboxConfigurator

class Toolbox(object):
  def __init__(self):
    """Define the toolbox (the name of the toolbox is the name of the .pyt file)."""
    self.label = "label"
    self.alias = "Tools"

    # List of tool classes associated with this toolbox
    self.tools = [ToolboxConfigurator]

configurator.py:

# This Python file uses the following encoding: utf-8

import arcpy

class ToolboxConfigurator(object):

  def __init__(self):
    """Define the tool (tool name is the name of the class)."""
    self.label              = u"config"
    self.description        = u""
    self.canRunInBackground = False

  def getParameterInfo(self):
    """Define parameter definitions"""
    new_config_file   = arcpy.Parameter(
      displayName     = u"?",
      name            = "new_config_file",
      datatype        = "GPBoolean",
      parameterType   = "Optional",
      direction       = "Input")
    parameters = [new_config_file]
    return parameters

  def isLicensed(self):
    """Set whether tool is licensed to execute."""
    return True

  def updateParameters(self, parameters):
    """Modify the values and properties of parameters before internal validation
    is performed.  This method is called whenever a parameter has been changed."""
    return

  def updateMessages(self, parameters):
    """Modify the messages created by internal validation for each tool
    parameter.  This method is called after internal validation."""
    return

  def execute(self, parameters, messages):
    """The source code of the tool."""

__init__.py is clear.

My error:

Traceback (most recent call last):
  File "C:\tools_v4\toolpackage\configurator.py", line 15, in getParameterInfo
    new_config_file   = arcpy.Parameter(
AttributeError: 'module' object has no attribute 'Parameter'

Best Answer

This may not be the cause for everyone, but I've identified at least one set of triggers.

  1. Run Python toolbox tool from ArcCatalog
  2. Geoprocessing history is on and includes a result from #1.
  3. When starting a new ArcCatalog session, no geoprocessing windows are open initially (such as ArcToolbox window, Python window, Results window).

If the above are all true, the Python toolbox tool will show the AttributeError: 'module' object has no attribute 'Parameter' exception.

Clearing out the history (or not logging it at all) will avoid the issue, probably why I didn't see this before as I rarely retain my history.

Right-clicking on the toolbox and using refresh will clear the error, but it will come up again in the future as long as the list above remains true. However, if the tool is importing the tool class from a separate tool file (like the case above) a refresh will not be enough. For that, I had to force it by including a reload in the .pyt, and then a refresh on the toolbox will clear the error.

# Using example of toolbox.pyt above
import toolpackage.configurator  # add import
reload(toolpackage.configurator)  # add a forced reload
from toolpackage.configurator import ToolboxConfigurator
Related Question