GeoEco.ArcGIS.GeoprocessorManager.GetWrappedGeoprocessor

classmethod GeoprocessorManager.GetWrappedGeoprocessor()

Returns a weakref to an object that wraps the ArcGIS geoprocessor and logs all calls to it.

This function will return None until InitializeGeoprocessor() or SetGeoprocessor() has been called. This function returns a weakref so that callers do not inadvertently maintain references to GeoEco’s instance of the geoprocessor and prevent it from being released.

In general, all GeoEco functions that need to access the geoprocessor should obtain it by calling this function. If InitializeGeoprocessor() (recommended) or SetGeoprocessor() has not been called yet during the lifetime of the Python interpreter, it should be called first.

The wrapper object returned by this function automatically performs two kinds of logging:

  1. All geoprocessing messages reported by ArcGIS geoprocessing tools are logged as informational, warning, or error messages according to their severity.

  2. All calls to geoprocessing tools and geoprocessor functions, all instantiations of ArcGIS-provided classes, all gets and sets of attributes of those instances, and all calls to their methods are logged as debug messages that include argument values and return values.

All messages are logged to the GeoEco.ArcGIS channel using GeoEco.Logging.Logger. You can configure that channel to see how GeoEco is using ArcGIS functionality. By default, both debug and informational messages are filtered out, and only warning and error messages will be shown. You can configure logging to show informational messages to observe successful activity from geoprocessing tools that GeoEco uses. Only configure it to show debug messages when you’re trying to diagnose a problem; the volume of debug messages is so large that performance can be markedly slower.

Please see the GeoEco.Logging.Logger documentation for more information about configuring logging.

Returns:

A weakref to the wrapped ArcGIS geoprocessor that the GeoEco package is using, or None if neither InitializeGeoprocessor() nor SetGeoprocessor() has been called yet.

Return type:

object