登录查看更多内容

What are the top scripting best practices for ArcGIS Pro?

由人工智能和领英社区提供技术支持

ArcGIS Pro is a powerful tool for spatial analysis, mapping, and data management. However, to automate tasks, customize workflows, and extend functionality, you need to use scripting with arcpy, the Python site package for ArcGIS. Scripting can save you time, improve your productivity, and enhance your creativity. But it also requires some best practices to ensure your code is efficient, readable, and maintainable. Here are some of the top scripting best practices for ArcGIS Pro that you should follow.

此文章中的业界达人

由社区从 7 条内容中精选。了解更多

Swaroop Humane, PMP?

Project Manager | PMP? | CSM? | SAFe? 6.0 Agilist | Prince2? | ITIL? | Agile Scrum Master
Abdelghafour Benkhelifa

Associate Project Manager @ 4EI | GIS Specialist | Remote Sensing | Geospatial Intelligence | Python | Ecology
Billy Hales, Ph.D.

Graduate Assistant Lecturer at Texas A&M University Global Navigational Satellite Systems, GIScience, Remote Sensing…

1 Choose the right IDE

An integrated development environment (IDE) is a software application that provides a comprehensive set of tools for writing, editing, debugging, and running code. ArcGIS Pro comes with its own IDE, called Python Window, which allows you to interact with the current project and run arcpy commands. However, Python Window has some limitations, such as lack of autocomplete, syntax highlighting, and code formatting. Therefore, you may want to use an external IDE, such as PyCharm, Visual Studio Code, or Spyder, which offer more features and flexibility. You can also configure these IDEs to work with ArcGIS Pro by setting up the Python interpreter and environment variables.

添加您的观点

Swaroop Humane, PMP?

Project Manager | PMP? | CSM? | SAFe? 6.0 Agilist | Prince2? | ITIL? | Agile Scrum Master
举报内容
Explore advanced ArcGIS Pro scripting practices like modular coding and error handling to improve efficiency and code readability. Choosing the right Python Integrated Development Environment (IDE) enhances the scripting experience, providing features like auto-completion and debugging tools, streamlining the development process for better GIS outcomes.

已翻译

赞
Kashan Muneer

Digital Solutions Architect | WordPress & Front End Developer | GIS Specialist | Social Media Strategist
举报内容
When scripting in ArcGIS Pro, use clear and meaningful names for variables and functions. Add comments to explain complex parts of the code. Opt for arcpy's geoprocessing tools and arcpy.da cursors for better performance. Organize your code into functions or modules for reuse. Include error handling for smoother troubleshooting. Integrate the ArcGIS Python API for web GIS tasks. Test scripts before deployment, and consider version control for collaborative work. These simple practices make your scripts more understandable, efficient, and easier to maintain in ArcGIS Pro.

已翻译

赞

2 Use consistent naming conventions

Naming conventions are the rules and guidelines for naming variables, functions, classes, and other elements in your code. Using consistent naming conventions makes your code more readable, understandable, and organized. It also helps you avoid errors and conflicts, such as using reserved keywords or overwriting existing names. ArcGIS Pro follows the PEP 8 style guide for Python, which recommends using lowercase letters and underscores for variables and functions, and uppercase letters for constants. For example, use input_layer, buffer_distance, and MAX_VALUE instead of inputLayer, bufferDistance, and max_value.

添加您的观点

Swaroop Humane, PMP?

Project Manager | PMP? | CSM? | SAFe? 6.0 Agilist | Prince2? | ITIL? | Agile Scrum Master
举报内容
When scripting in ArcGIS Pro, follow best practices like using consistent naming conventions. For instance, naming variables descriptively (e.g., "layer_name" instead of "x") improves code readability. This ensures that others (or your future self) can easily understand and maintain the script, fostering efficient GIS scripting.

已翻译

赞

3 Document your code

Documenting your code means adding comments, docstrings, and metadata that explain the purpose, logic, and functionality of your code. Documenting your code helps you and others understand what your code does, how it works, and how to use it. It also makes your code more reusable, maintainable, and shareable. You can use single-line comments (#) or multi-line comments (""" """) to add notes and explanations to your code. You can also use docstrings (""" """) to provide a summary and description of your functions and classes, as well as their parameters and return values. Finally, you can use metadata to provide information about your script tool, such as its name, label, description, and parameters.

添加您的观点

Abdelghafour Benkhelifa

Associate Project Manager @ 4EI | GIS Specialist | Remote Sensing | Geospatial Intelligence | Python | Ecology
举报内容
Some best practices for ArcGIS Scripting: - Logging: Incorporate logging to track the progress of your script and troubleshoot issues. Log messages should be informative and relevant. - Toolboxes and Script Tools: When applicable, package your scripts as geoprocessing tools or script tools within ArcGIS Pro toolboxes using parameter values for better integration and usability.

已翻译

赞
Swaroop Humane, PMP?

Project Manager | PMP? | CSM? | SAFe? 6.0 Agilist | Prince2? | ITIL? | Agile Scrum Master
举报内容
In ArcGIS Pro scripting, document your code by adding comments that explain its purpose and functions. Imagine writing a note to someone else (or yourself) who might read the code later. This practice aids understanding, making it easier to troubleshoot, modify, or share the script with others in the GIS community.

已翻译

赞

4 Handle errors and exceptions

Errors and exceptions are events that occur when something goes wrong in your code, such as syntax errors, logical errors, or runtime errors. Handling errors and exceptions means using techniques to prevent, detect, and respond to these events, such as using try-except blocks, raising custom exceptions, and logging messages. Handling errors and exceptions helps you avoid crashes, bugs, and data loss. It also helps you improve your code quality, performance, and user experience. You can use the arcpy.GetMessages() function to get the messages from the geoprocessing tools that you run in your code. You can also use the logging module to create and manage log files that record the events and errors in your code.

添加您的观点

Swaroop Humane, PMP?

Project Manager | PMP? | CSM? | SAFe? 6.0 Agilist | Prince2? | ITIL? | Agile Scrum Master
举报内容
In ArcGIS Pro scripting, handle errors and exceptions to prevent unexpected issues. Imagine if your script encounters a problem—it can gracefully handle it instead of crashing. For example, using a try-except block can catch errors and execute alternative actions, ensuring your script runs smoothly even in challenging situations.

已翻译

赞

5 Optimize your code

Optimizing your code means using techniques to improve the speed, efficiency, and reliability of your code, such as using built-in functions, iterators, and generators, avoiding unnecessary loops and calculations, and using arcpy.da cursors instead of arcpy cursors. Optimizing your code helps you reduce the execution time, memory usage, and resource consumption of your code. It also helps you achieve better results, accuracy, and quality. You can use the timeit module to measure the execution time of your code snippets. You can also use the arcpy.env.overwriteOutput property to overwrite existing output files without deleting them manually.

添加您的观点

Billy Hales, Ph.D.

Graduate Assistant Lecturer at Texas A&M University Global Navigational Satellite Systems, GIScience, Remote Sensing, Graph-Theoretical Application in Geosciences, Geospatial Data Visualization, River Science
举报内容
This particular section is very ArcPy-centric. Equivalent functionality can be achieved with open-source and easily acquired tools/frameworks, like geopandas. Using geopandas I will discuss a common iterator: geopandas.iterrows(). One way to speed up a loop is to filter out results that you do not wish to focus on, in contrast for testing each record each time loop iterates. This is especially true if your loop has boilerplate that must be executed at the beginning. Example: id1 = list(range(2500)) id2 = id1[:] id2.reverse() gdf = gpd.GeoDataFrame(geometry=foo, data={‘bar’:id1, ‘bas’:id2},crs=fooby.crs) indices = gdf.loc[(gdf[‘bar’]>1000)&(gdf[‘bas’]%6==0)].index.values for index, feat in df.loc[indices].iterrows(): …

已翻译

赞

6 Test and debug your code

Testing and debugging your code means using techniques to find and fix errors, bugs, and anomalies in your code, such as using breakpoints, print statements, and assert statements, and using tools such as PyLint, PyTest, and ArcGIS Pro Debugger. Testing and debugging your code helps you ensure your code works as expected, meets the requirements, and follows the standards. It also helps you enhance your code functionality, security, and usability. You can use the Python Window in ArcGIS Pro to test and debug your code interactively. You can also use the Run button in the IDE to run your code and check the output and messages.

添加您的观点

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?

添加您的观点

Geographic Information Systems (GIS)

+ 关注

给文章评分

我们借助人工智能创建了此文章。您认为这篇文章怎么样？

很棒不太好

举报此文章

查看全部

What are the top scripting best practices for ArcGIS Pro?

1

2

3

4

5

6

7

1 Choose the right IDE

2 Use consistent naming conventions

3 Document your code

4 Handle errors and exceptions

5 Optimize your code

6 Test and debug your code

7 Here’s what else to consider

Geographic Information Systems (GIS)

给文章评分

感谢您的反馈

更多Geographic Information Systems (GIS)相关文章

更多相关阅读内容

What are the top scripting best practices for ArcGIS Pro?

1

2

3

4

5

6

7

1 Choose the right IDE

2 Use consistent naming conventions

3 Document your code

4 Handle errors and exceptions

5 Optimize your code

6 Test and debug your code

7 Here’s what else to consider

Geographic Information Systems (GIS)

给文章评分

感谢您的反馈

查看其他技能