GeoEco.Metadata.AddArgumentMetadata

GeoEco.Metadata.AddArgumentMetadata(method, argumentName, typeMetadata, description=None, direction='Input', initializeToArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None, cls=None, module=None, dependencies=[])

Creates an ArgumentMetadata for a method parameter and adds it to a MethodMetadata.

Parameters:

  • method (MethodType or str) – The method itself or the name of the method. If the name is given, cls must also be given.

  • argumentName (str) – Name of the parameter, as it appears in the method’s signature.

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

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

  • 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).

  • 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).

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

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

  • cls (type or str, optional) – The class containing the method, either as the class itself or the unqualified name of the class (without module or package names). Only needed if method is given as a name rather than the method itself.

  • module (ModuleType or str, optional) – The module that contains the class, either as the module object itself or the fully qualified name of the module (a.k.a. dotted module name). If not provided, the caller’s module is used.

  • dependencies (list of Dependency, 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).

Note

Before calling this function, use AddMethodMetadata() to create the MethodMetadata and add it to its class’s ClassMetadata.