GeoEco.Metadata.AddMethodMetadata

GeoEco.Metadata.AddMethodMetadata(method, shortDescription=None, longDescription=None, isExposedToPythonCallers=False, isExposedAsArcGISTool=False, arcGISDisplayName=None, arcGISToolCategory=None, cls=None, module=None, dependencies=[])

Creates a MethodMetadata for a method and adds it to a ClassMetadata.

Parameters:

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

  • shortDescription (str, optional) – One-line description of the method, ideally as plain text (but reStructuredText is OK).

  • longDescription (str, optional) – Detailed description of the method, formatted as reStructuredText.

  • isExposedToPythonCallers (bool, optional) – If True, the method should be part of GeoEco’s Public API. If False, the default, the method is considered part of GeoEco’s Internal API and not recommended for use by external callers.

  • isExposedAsArcGISTool (bool, optional) – If True, the method should be part of GeoEco’s Public API. If False, the default, the method is considered part of GeoEco’s Internal API and not recommended for use by external callers.

  • arcGISDisplayName (str, optional) – Name of the tool, as displayed in MGET’s ArcGIS toolbox. Ignored if isExposedAsArcGISTool is False.

  • arcGISToolCategory (str, optional) – Toolset that the tool appears under in MGET’s ArcGIS toolbox. If None, the default, the tool appears at the root level. Ignored if isExposedAsArcGISTool is False.

  • 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 prior to executing this method.

Note

Before calling this function, use AddClassMetadata() to create the ClassMetadata and add it to its module’s ModuleMetadata.