GeoEco.Metadata.ArgumentMetadata

class GeoEco.Metadata.ArgumentMetadata(name, methodMetadata, typeMetadata, description=None, direction='Input', initializeToArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None, dependencies=[])

Bases: object

Metadata that describes a parameter of a method of a Python class.

Parameters:

  • name (str) – Name of the parameter, as it appears in the method’s signature. Minimum length꞉ 1.

  • methodMetadata (MethodMetadata) – The MethodMetadata for the method.

  • typeMetadata (TypeMetadata) – A TypeMetadata that describes the data type and allowed values of this parameter.

  • description (str, optional) – The parameter’s description, ideally one line of plain text (but reStructuredText is OK). Put long details in MethodMetadata.LongDescription. Minimum length꞉ 1.

  • direction (str, optional) – Direction of the parameter, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Allowed values꞉ 'Input', 'Output'. Case sensitive.

  • initializeToArcGISGeoprocessorVariable (str, optional) – The parameter value should be obtained from this geoprocessor variable, rather than from the user as a tool parameter, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

  • arcGISDisplayName (str, optional) – Name of the parameter as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

  • arcGISCategory (str, optional) – Category of the parameter as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

  • arcGISParameterDependencies (list of str, optional) – list of names of parameters that this parameter is dependent on (see ArcGIS documentation), when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise).

  • dependencies (list of object, optional) – list of Dependency objects defining software dependencies that should be checked when the value provided for this parameter is not None when the method is called (ignored otherwise).

Returns:

New ArgumentMetadata instance.

Return type:

ArgumentMetadata

Properties

property ArcGISCategory

(str or None) Category of the parameter as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

property ArcGISDisplayName

(str or None) Name of the parameter as it should appear in ArcGIS, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

property ArcGISParameterDependencies

(list of str or None) list of names of parameters that this parameter is dependent on (see ArcGIS documentation), when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise).

property Default

(object or None) The default value of the parameter as defined in the method signature, if HasDefault is True. None otherwise. Read only.

property Dependencies

(list of object) list of Dependency objects defining software dependencies that should be checked when the value provided for this parameter is not None when the method is called (ignored otherwise).

property Description

(str or None) The parameter’s description, ideally one line of plain text (but reStructuredText is OK). Put long details in MethodMetadata.LongDescription. Minimum length꞉ 1.

property Direction

(str) Direction of the parameter, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Allowed values꞉ 'Input', 'Output'. Case sensitive.

property HasDefault

(bool) True if the parameter has a default value defined in the method signature. If so, the parameter is optional. Read only.

property InitializeToArcGISGeoprocessorVariable

(str or None) The parameter value should be obtained from this geoprocessor variable, rather than from the user as a tool parameter, when the method is exposed as an ArcGIS geoprocessing tool (ignored otherwise). Minimum length꞉ 1.

property IsArbitraryArgumentList

(bool) True if the parameter an arbitrary sequence of positional arguments, traditionally written *args in the method signature and known in Python as the var-positional parameter. Read only.

property IsFormalParameter

(bool) True if the parameter is the default kind of parameter in Python, known in Python as a positional-or-keyword parameter. Read only.

property IsKeywordArgumentDictionary

(bool) True if the parameter a dictionary of arbitrarily many keyword arguments, traditionally written **kwargs in the method signature and known in Python as the var-keyword parameter. Read only.

property Method

(MethodMetadata) MethodMetadata for the class that contains this method. Read only.

property Name

(str) Name of the parameter, as it appears in the method’s signature. Read only. Minimum length꞉ 1.

property Type

(TypeMetadata) A TypeMetadata that describes the data type and allowed values of this parameter.

Methods

AppendXMLNodes

Appends the metadata to the specified xml.dom.Node object as child nodes.