Better type hinting for arcpy.env

Hayden Welch

I pretty frequently find myself using tons of magic strings and flip flopping of environment variables in my scripts.

I have implemented something that does this as best as I can here  as an example solution. It's essentially a carbon copy of the EnvManager class but with explicitly defined environments so a static type checker can help you make sure you're feeding correct values and parameters to the GPEnvironment object.

This could also be implemented in a .pyi file for EnvManager.py to allow for forwards compatibility with changes to env parameters and type hinting updates could lag behind without causing issues.

 

HannesZiegler

This idea has been implemented in ArcGIS Pro 3.4, please see the Python section of the What's New in ArcGIS Pro 3.4 topic and scroll to ArcPy.

• Improvements were made to type hints in arcpy and the arcpy.da and arcpy.charts modules. Type hints were added to ArcPy classes and geoprocessing tools including Result and Raster objects. Type hints provide an improved code authoring experience in modern integrated development environments (IDEs).

We have been gradually adding type hints to ArcPy, including EnvManager, and continue to progress these.