Scribd
Upload
152 views

Arcmap and Python

This document summarizes a presentation about using Python to customize and extend ArcMap functionality. It discusses using comtypes to access ArcObjects from Python to manipulate ArcMap, as well as using wxPython for custom forms. It provides code samples for creating a framework component extension for 9.x/10.0 and an add-in for 10.1. Tips are included for improving performance when intensive ArcObjects use is needed.

Uploaded by

Miguel Angel
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
152 views

Arcmap and Python

This document summarizes a presentation about using Python to customize and extend ArcMap functionality. It discusses using comtypes to access ArcObjects from Python to manipulate ArcMap, as well as using wxPython for custom forms. It provides code samples for creating a framework component extension for 9.x/10.0 and an add-in for 10.1. Tips are included for improving performance when intensive ArcObjects use is needed.

Uploaded by

Miguel Angel
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 29

ArcMap and Python:

Closing the VBA Gap


Mark Cederholm
UniSource Energy Services

Esri Developer Summit 2012

Using ArcObjects in Python


Esri Developer Summit 2010

ArcMap and Python: Closing the VBA Gap


Tuesday 4:30 Mesquite C

Extend Python Using C++ and ArcObjects


Wednesday 11:15 Mesquite B
Download presentations and code:
http://www.pierssen.com/arcgis/misc.htm
http://www.pierssen.com/arcgis10/python.htm
2:23:00 PM

Why Python?

ArcGIS VBA support ends after 10.0


Python is integrated with ArcMap
Geoprocessing tasks: arcpy
ArcObjects manipulation: comtypes
Custom forms: wxPython
At 10.1, the ArcGIS add-in framework
supports Python
However, debugging can be difficult in
ArcMap

2:23:00 PM

The comtypes site package:


http://starship.python.net/crew/theller/comtypes/

The wxPython site package:


http://wxpython.org/

2:23:00 PM

Modifying comtypes for 10.1:

Delete automation.pyc, automation.pyo,


safearray.pyc, safearray.pyo
Edit automation.py
Add the following entry to the
_ctype_to_vartype dictionary (line 794):
POINTER(BSTR): VT_BYREF|VT_BSTR,

2:23:00 PM

Loading common ArcMap modules

At the Python prompt:


>>> from comtypes.client import GetModule
>>> GetModule("c:/program
files/arcgis/desktop10.1/com/esriArcMapUI.olb")
[TIP: If loading one or modules fails, delete all files in the
comtypes/gen folder before trying again.]

See Snippets.py for examples of using comtypes

2:23:00 PM

Workaround: Array object


>>> import comtypes.gen.esriSystem as
esriSystem
>>> from comtypes.client import CreateObject
>>> pArray = CreateObject("{8F2B6061-AB00-11D287F4-0000F8751720}",
interface=esriSystem.IArray)

2:23:00 PM

wxPython and ArcMap

Will not work out-of-the-box in the ArcMap


Python window
Use PySimpleApp in a dedicated extension
for the application MainLoop
Destroy does not work: use Show instead
The print command will not output to
the Python window from a form

2:23:00 PM

Customizing ArcMap, Method 1:


Creating a Framework component
(9.x and 10.0)
[Sample Code: ArcMap_Python\DemoCOM]

2:23:00 PM

Requires MIDL.EXE
Obtain by downloading and installing
Windows SDK 7.1:

http://www.microsoft.com/download/en/details.aspx?id=8279

2:23:00 PM

Edit DemoExtension.idl and DemoTool.idl


to set the correct ESRI paths:

2:23:00 PM

Open Windows SDK 7.1 Command


Prompt:

2:23:00 PM

Use MIDL.EXE to produce


DemoExtension.tlb and DemoTool.tlb:
midl DemoExtension.idl
midl DemoTool.idl
Use Python to register the COM objects*:
python DemoExtension.py -regserver
python DemoTool.py -regserver
*WARNING: The file/module name is case sensitive!

2:23:00 PM

In ArcMap, add the


tool in Customize
Mode:

Activate the tool,


select a quote, and
draw a line:

2:23:00 PM

Use Python to unregister the COM objects:


python DemoExtension.py -unregserver
python DemoTool.py -unregserver

2:23:01 PM

Customizing ArcMap, Method 2:


Creating an Add-in (10.1)
[Sample Code: ArcMap_Python\DemoAddin]

2:23:01 PM

Python Add-In Wizard see Obtaining


the Python Add-In Wizard in the ArcGIS
10.1 for Desktop Help:

2:23:01 PM

Select or create a working folder and set


other properties as desired:

2:23:01 PM

Add an extension (right-click on


EXTENSIONS):

2:23:01 PM

Add a toolbar:

Add a tool:

2:23:01 PM

Click Save, navigate to folder, and add


files from sample code:

Double-click makeaddin.py to create addin:

2:23:01 PM

Double-click DemoAddin.esriaddin to
install add-in:

2:23:03 PM

In ArcMap, make sure extension is checked:

Toolbar automatically appears:

2:23:03 PM

TIP: Add script path to sys.path to enable


local imports
import os
import sys
sMyPath = os.path.dirname(__file__)
sys.path.insert(0, sMyPath)

2:23:03 PM

class DemoExtension(object):
_wxApp = None
def __init__(self):
self.enabled = True
def startup(self):
try:
from wx import PySimpleApp
self._wxApp = PySimpleApp()
self._wxApp.MainLoop()
except:
sMsg = "Error starting extension:\n" + \
traceback.format_exc()
pythonaddins.MessageBox(sMsg, "DemoAddIn")

2:23:03 PM

class DemoTool(object):
_pApp = None
_geometry = None
_sQuote = None
_dlg = None
def __init__(self):
self.enabled = True
self.cursor = 3
Not stubbed out
self.shape = "Line" # Can set to . . .
by default:
def onClick(self):
if self._dlg is None:
from QuoteDialog import QuoteDialog
self._dlg = QuoteDialog(sMyPath, self)
self._dlg.Show(True)
def deactivate(self):
if self._dlg is None:
return
self._dlg.Show(False)
def onLine(self, line_geometry):
self._geometry = line_geometry
self.DoIt()
2:23:03 PM

COM Interop: relative speed


0

10

20

30

40

50

60

70

80

90

100

C++
92

VBA
48

.NET
32

Python
24

IronPython
Java

16
Benchmark = 500+K ShapeCopy operations

2:22:58 PM

100

Some final tips:

When in doubt, check the wrapper code:


Python../Lib/site-packages/comtypes/gen
Avoid intensive use of fine-grained ArcObjects in
Python
For best performance, use C++ to create coarsegrained objects
Use geoprocessing objects and tools to simplify
supported tasks watch for performance, though
Read the desktop help to check out available
functionality in arcgisscripting (and arcpy at 10.x)

2:23:03 PM

Questions?

Mark Cederholm
mcederholm@uesaz.com
This presentation and sample code
may be downloaded at:

http://www.pierssen.com/arcgis10/python.htm
For 9.x examples, see:
http://www.pierssen.com/arcgis/misc.htm

2:23:03 PM

You might also like