arcgis.env module

The env module provides a shared environment used by the different modules. It stores globals such as the currently active GIS, the default geocoder and so on. It also stores environment settings that are common among all geoprocessing tools, such as the output spatial reference.

active_gis

arcgis.env.active_gis

The currently active GIS, that is used for analysis functions unless explicitly specified when calling the functions. Creating a new GIS object makes it active unless set_active=False is passed in the GIS constructor.

analysis_extent

arcgis.env.analysis_extent

The processing extent used by analysis tools, specified as an arcgis.geometry.Envelope.

out_spatial_reference

arcgis.env.out_spatial_reference

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries. If process_spatial_reference is specified and out_spatial_reference is not specified, the output geometries are in the spatial reference of the process spatial reference.

process_spatial_reference

arcgis.env.process_spatial_reference

The spatial reference that the geoprocessor will use to perform geometry operations. If specified and out_spatial_reference is not specified, the output geometries are in the spatial reference of the process spatial reference.

return_z

arcgis.env.return_z

If true, Z values will be included in the geoprocessing results if the features have Z values. Otherwise Z values are not returned. The default is False.

return_m

arcgis.env.return_m

If true, M values will be included in the results if the features have M values. Otherwise M values are not returned. The default is False.

verbose

arcgis.env.verbose

#: If True, messages from geoprocessing tools will be printed to stdout. #: In any case, all geoprocessing messages are available through Python logging module.