topic Re: Creating an Addin Extension that Responds to a Python Script in ArcObjects SDK Questions

Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Thu, 23 Aug 2012 23:27:02 GMT

I want to know if it is possible to create an Add-in extension that listens for map refresh events to specifically respond to the actions of a python script?

I envision adding a hidden text object into a specific kind of map that will at first indicate to the Add-in Extension that nothing needs to be done. When the Python script runs it will write to that text object to set a flag telling the Extension that it is processing a change to the map, so ignore any map refresh actions during the script processing. Just prior to completion of the Python script, the Python script will update the Text Object to say that it just finished and needs the Extension to do its thing. Then the Python script will refresh the map. I assume the Add-in Extension can detect the map refresh event triggered by the Python script, read the text object to detect that python wants the extension to run and then the extension can fire its action on the map. When the extension finishes it will reset the text object back to the state indicating that nothing needs to be done by the extension.

Does this sound like it will work?

I want the Add-in to detect when arcpy.mapping finishes updating everything that it can in the map, and then have the extension change the data frame clipping geometry to match a feature's shape according to the current definition query on a layer that the python script set. I do not want the user to have to push another button after the Python script finishes to do things that Python seemingly cannot do, and I do not want the Add-in to do the Python script actions. I do not see any other way to have Python trigger an ArcObjects action within the currently open map, since the ctypes functionality says it is limited to basic C++ types and I do not see a way to pass a hook for the current map to an ArcObjects DLL method from Python.

Please correct me if I am wrong about any of this or if there is a better approach to do what I want.

Re: Creating an Addin Extension that Responds to a Python Script

JochenManegold — Fri, 24 Aug 2012 11:10:45 GMT

What about that: embed your Python script into a Python script tool inside a custom toolbox. Extent your add-in with a button. If the user clicks the button, the add-in runs the script tool (synchron) and after it finished, it does the other stuff with ArcObjects. For deployment (to the assembly cache) you can add the custom toolbox as a resource to the add-in. The code for using an embedded toolbox is something like that:

// Initialize the geoprocessor.
IGeoProcessor2 gp = new GeoProcessorClass();
// Add the toolbox.
string strPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
string strToolbox = strPath + "\\PythonTools.tbx";
gp.AddToolbox(strToolbox);
// Generate the array of parameters.
IVariantArray parameters = new VarArrayClass();
parameters.Add(inString);
// Execute the model tool by name.
IGeoProcessorResult result = gp.Execute("Reply", parameters, null);
// Ergebnis zurückliefern
string reply = result.GetOutput(0).GetAsText();

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Fri, 24 Aug 2012 15:22:11 GMT

What about that: embed your Python script into a Python script tool inside a custom toolbox. Extent your add-in with a button. If the user clicks the button, the add-in runs the script tool (synchron) and after it finished, it does the other stuff with ArcObjects. For deployment (to the assembly cache) you can add the custom toolbox as a resource to the add-in. The code for using an embedded toolbox is something like that:

// Initialize the geoprocessor.
IGeoProcessor2 gp = new GeoProcessorClass();
// Add the toolbox.
string strPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
string strToolbox = strPath + "\\PythonTools.tbx";
gp.AddToolbox(strToolbox);
// Generate the array of parameters.
IVariantArray parameters = new VarArrayClass();
parameters.Add(inString);
// Execute the model tool by name.
IGeoProcessorResult result = gp.Execute("Reply", parameters, null);
// Ergebnis zurückliefern
string reply = result.GetOutput(0).GetAsText();

I do not think this will work for me. My python script tool is unconventional and is not merely designed to act as a geoprocessing tool. It acts like a form object with user interface capabilities. I do not want the user to simply feed parameters to the tool. I intend for them to interact with the tool.

I have adapted the script tool's ToolValidator to responds to each action by the user so that as they make choices, that action changes the options that work for other parameters according to the databases the user is querying. The interface ensures that the user ends up with inputs that will return valid results when the actual geoprocessing takes place. For example, if a user inputs a date range, the ToolValidator reads the database to make sure that there is data that extends to both limits of the range, and corrects the range if it does not. It also responds to the date range change by altering the list of Primary Roads that the user can choose to only be those roads that actually had events within the date range. When the user chooses a Primary Road, the validator makes sure it is in the list, and then updates the lists of intersecting roads that connect to the chosen Primary road. As the user chooses intersecting roads and sets offsets from that intersection that will ultimately create point events or a road segment event when the actual georocessing takes place, the interface makes sure that any offsets will remain on the road and corrects the user's entries if they do not.

This interactive experience is essential to the tool's use and converting to it a mere geoprocessing tool called by ArcObjects would defeat my purpose. I am aware that with .Net I could design a form using ArcObjects, but I have no interest in doing that.

Therefore the python script tool dialog must actually be opened by the user and only the user can determine when they are happy with the parameters values they have chosen within the dialog to trigger the actual geoprocessing actions of the tool.

Given my objectives and restrictions, do you still think your suggestion could somehow be adapted to work?

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Fri, 24 Aug 2012 16:08:05 GMT

I want to know if it is possible to create an Add-in extension that listens for map refresh events to specifically respond to the actions of a python script?

I envision adding a hidden text object into a specific kind of map that will at first indicate to the Add-in Extension that nothing needs to be done. When the Python script runs it will write to that text object to set a flag telling the Extension that it is processing a change to the map, so ignore any map refresh actions during the script processing. Just prior to completion of the Python script, the Python script will update the Text Object to say that it just finished and needs the Extension to do its thing. Then the Python script will refresh the map. I assume the Add-in Extension can detect the map refresh event triggered by the Python script, read the text object to detect that python wants the extension to run and then the extension can fire its action on the map. When the extension finishes it will reset the text object back to the state indicating that nothing needs to be done by the extension.

Does this sound like it will work?

I want the Add-in to detect when arcpy.mapping finishes updating everything that it can in the map, and then have the extension change the data frame clipping geometry to match a feature's shape according to the current definition query on a layer that the python script set. I do not want the user to have to push another button after the Python script finishes to do things that Python seemingly cannot do, and I do not want the Add-in to do the Python script actions. I do not see any other way to have Python trigger an ArcObjects action within the currently open map, since the ctypes functionality says it is limited to basic C++ types and I do not see a way to pass a hook for the current map to an ArcObjects DLL method from Python.

Please correct me if I am wrong about any of this or if there is a better approach to do what I want.

At first thought, your pattern sounds like the observer pattern, notify registered observers when an event occurs, except you're using two different languages, so I'm not sure how you would connect the two.

At second thought, there is: com.esri.arcgis.carto.IActiveViewEventsFocusMapChangedEvent Which might work.

Lastly, Add-ins respond to user initiated events, so I'm not sure how you would initiate the tool, button, menu, utility object or extension that should be listening for the events from python.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Fri, 24 Aug 2012 16:17:25 GMT

My python script tool is unconventional and is not merely designed to act as a geoprocessing tool. It acts like a form object with user interface capabilities. I do not want the user to simply feed parameters to the tool. I intend for them to interact with the tool. I am aware that with .Net I could design a form using ArcObjects, but I have no interest in doing that.

Can I interest you in writing a Java add-in? 😄

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Fri, 24 Aug 2012 16:40:43 GMT

At first thought, your pattern sounds like the observer pattern, notify registered observers when an event occurs, except you're using two different languages, so I'm not sure how you would connect the two.

At second thought, there is: com.esri.arcgis.carto.IActiveViewEventsFocusMapChangedEvent Which might work.

Lastly, Add-ins respond to user initiated events, so I'm not sure how you would initiate the tool, button, menu, utility object or extension that should be listening for the events from python.

Thanks for the suggestions. I was afraid of the last thing you said. The notification process I outlined would ensure that any user triggered refresh would cause the listener to respond, detect the update by Python from the text object, and perform its action. A refresh is harder for a user to avoid as a trigger than pressing another button. That approach may be my best option, but it would introduce a delay to the full completion of the update that I would rather avoid and would not be anywhere close to fully reliable.

It would be a nice enhancement of the Python arcpy interface to have it be able to call buttons or activate tools on a toolbar, but I also see the potential dangers in allowing that. I am at 10.0, so I know it cannot do that. With 10.1 Python add-ins I did not hear about anything like that.

Without being able to pass an application object hook or map to a DLL from Python, I also do not see a way to do this from the Python side. The hook would be required to get ArcObjects to trigger any button or toolbar I might build designed to work within an open ArcMap session. I would wrap the script tool inside of an ArcObjects call if ArcObjects could actually trigger the tool to actually open it's dialog and continue when the dialog closes, but I have not seen anything like that either. I also see dangers in that approach as well, since the program notification processes of the two languages would remain incompatible.

I do not think the FocusMapChanged Event helps, since I believe that only occurs when a user opens another map, not while continuing to work within a single map. But the help description is not very clear about its intended behavior.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Fri, 24 Aug 2012 16:53:24 GMT

What if you wrote a console ArcObjects application that you execute from python? I believe you can get a list of current ArcMap application references from the IAppROT interface. That might work.

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Fri, 24 Aug 2012 17:11:15 GMT

Can I interest you in writing a Java add-in? 😄

Sarcasm aside, the python script tool dialog is doing the essential things that a form in ArcObjects does, in that it listens to actions done on the form and allows me to respond. The debug time of validating user input on an ArcObjects form is nearly unending when text boxes have to take care of virtually everything and I have to write all of the validation code to restrict it to providing valid dates, numbers, and combobox lists, or knowing when to cross check each interface object at precisely the right moment during an onchange event for each interface object, etc. Interface design in ArcObjects is full of undocumented pitfalls that have wasted weeks of my time that I simply don't have to deal with on the script tool form. I am utterly tired of ArcObjects expecting me to take control of everything rather than being able to rely on well designed built-in code that takes care of at least 50% of my validation needs.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Sat, 11 Dec 2021 12:56:50 GMT

In .NET maybe it is hard to capture every possible user "oops".

In Java, it's straight-forward.

DecimalFormat.. DateFormat.. fun stuff.

If you enter junk into this text field, it will default to 0.00

        // Create an instance of DecimalFormat to limit the number of integers the user can type into certain fields.
        DecimalFormat temperatureFormat = new DecimalFormat("##0.00");

        ftfTemperature = new JFormattedTextField(new DefaultFormatterFactory(new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat)));
        ftfTemperature.addFocusListener(new FocusAdapter() {
            @Override
            public void focusGained(FocusEvent e) {
                SwingUtilities.invokeLater(new Runnable(){
                    @Override
                    public void run() {
                        ftfTemperature.selectAll();
                    }
                });
            }
        });
        ftfTemperature.setBounds(120, 8, 85, 20);
        panel.add(ftfTemperature);

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Fri, 24 Aug 2012 17:26:15 GMT

What if you wrote a console ArcObjects application that you execute from python? I believe you can get a list of current ArcMap application references from the IAppROT interface. That might work.

The IAppROT interface seems promising for connecting to any running ESRI application. Hopefully I could have Python send a text string naming the Map and test that string against the IAppROT list of running applications (realizing that only ArcMap applications would be valid).

From the help on the AppRef returned by the Item method of IAppROT, it says "Note you can only use the AppRef object if your code is running inside one of the ArcGIS application processes". I assume a console ArcObjects application would meet that requirement, but I have not designed one before, so I am not sure. In any case, so far this looks like a viable option.

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Sat, 11 Dec 2021 12:56:52 GMT

        // Create an instance of DecimalFormat to limit the number of integers the user can type into certain fields.
        DecimalFormat temperatureFormat = new DecimalFormat("##0.00");

        ftfTemperature = new JFormattedTextField(new DefaultFormatterFactory(new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat)));
        ftfTemperature.addFocusListener(new FocusAdapter() {
            @Override
            public void focusGained(FocusEvent e) {
                SwingUtilities.invokeLater(new Runnable(){
                    @Override
                    public void run() {
                        ftfTemperature.selectAll();
                    }
                });
            }
        });
        ftfTemperature.setBounds(120, 8, 85, 20);
        panel.add(ftfTemperature);

Lines of Python code to restrict a script tool field to a long = None: Define the input as a Long in the parameter dialog.
Lines of Python code to restrict a script tool field to a date = None: Define the input as a Date in the parameter dialog.

Hard to get any simpler than that.

Since I have no background in using Java I can't say the code above gives me confidence that I could easily convert what I have done to a Java add-in, but I will start looking into that as another option.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Sat, 11 Dec 2021 12:56:55 GMT

This prints the title of the only mxd open on my machine, index = 0. You would probably have to make sure you have the right mxd application name by iterating over the count of open mxds and getting the title.

public class Console {

    public static void main(String[] args) {
        EngineInitializer.initializeEngine();
        initializeArcGISLicenses();
        
        try {
            IAppROT aprot = new AppROT();
            
            IApplication application = aprot.getItem(0);
            
            System.out.println(application.getDocument().getTitle());
            
        } catch (UnknownHostException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    static void initializeArcGISLicenses() {
        try {
            com.esri.arcgis.system.AoInitialize ao = new com.esri.arcgis.system.AoInitialize();
            if (ao.isProductCodeAvailable(com.esri.arcgis.system.esriLicenseProductCode.esriLicenseProductCodeArcView) == com.esri.arcgis.system.esriLicenseStatus.esriLicenseAvailable)
                ao.initialize(com.esri.arcgis.system.esriLicenseProductCode.esriLicenseProductCodeArcView);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Fri, 24 Aug 2012 17:42:42 GMT

Lines of Python code to restrict a script tool field to a long: Define the input as a Long.
Lines of Python code to restrict a script tool field to a date: Define the input as a Date.

Hard to get any simpler than that.

True. Got me there.

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Sat, 11 Dec 2021 12:56:58 GMT

public class Console {

    public static void main(String[] args) {
        EngineInitializer.initializeEngine();
        initializeArcGISLicenses();
        
        try {
            IAppROT aprot = new AppROT();
            
            IApplication application = aprot.getItem(0);
            
            System.out.println(application.getDocument().getTitle());
            
        } catch (UnknownHostException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    static void initializeArcGISLicenses() {
        try {
            com.esri.arcgis.system.AoInitialize ao = new com.esri.arcgis.system.AoInitialize();
            if (ao.isProductCodeAvailable(com.esri.arcgis.system.esriLicenseProductCode.esriLicenseProductCodeArcView) == com.esri.arcgis.system.esriLicenseStatus.esriLicenseAvailable)
                ao.initialize(com.esri.arcgis.system.esriLicenseProductCode.esriLicenseProductCodeArcView);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Do you know how to call this console application from the Python side and have Python provide a parameter? Would the Python ctypes interface be the way to go? If so then this seems to have everything I would need to chain the two together and from there could decide what I wanted Python to do and what I wanted the console application to do.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Fri, 24 Aug 2012 19:20:55 GMT

Doesn't python have an OS module that you can call?

os.system(your application, your parameter)

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Sat, 11 Dec 2021 12:57:01 GMT

Doesn't python have an OS module that you can call?

os.system(your application, your parameter)

My question is now answered and the solution is much better than my original idea.

Using the method below I can now create a Python script that calls an ArcMap Console Application and that passes an argument with a name of the map that Python wants the Console Application to update. The Console Application is able use the IAppROT interface to get an application hook to the Map that Python wants updated and can then do things using ArcObjects code that arcpy mapping cannot do. Python can pass as many additonal standard C type (char, int, date, etc.) arguments that the Console Application may need to coordinate its actions with the Python script. I am fairly certain that the Console application can pass back a result to Python using the method outlined below as well.

Therefore, there is no need to wait on the user to do anything to coordinate the triggering of the code, or to use an Add-in extension event listener, or store notification text objects in the map to handle communications between Python and ArcObjects.

The Python subprocess.check_call method works for calling an ArcMap Desktop Console Application with arguments in this format:

from subprocess import check_call
check_call(["DesktopConsoleApplication1.exe", "Collision_Segment_Diagram2.mxd"])

The following ArcMap Desktop Console Application code worked to notify me whether or not a map is open and whether or not it matches the title python passed as an agrument to the console application:

using System;
using System.Collections.Generic;
using System.Text;
using ESRI.ArcGIS.esriSystem;
using ESRI.ArcGIS.Framework;

namespace DesktopConsoleApplication1
{
    class Program
    {
        private static LicenseInitializer m_AOLicenseInitializer = new DesktopConsoleApplication1.LicenseInitializer();

        [STAThread()]
        static void Main(string[] args)
        {
            //ESRI License Initializer generated code.
            m_AOLicenseInitializer.InitializeApplication(new esriLicenseProductCode[] { esriLicenseProductCode.esriLicenseProductCodeArcView, esriLicenseProductCode.esriLicenseProductCodeArcEditor, esriLicenseProductCode.esriLicenseProductCodeArcInfo },
            new esriLicenseExtensionCode[] { });
            //ESRI License Initializer generated code.
        try
        {
            IAppROT aprot = new AppROT();
            IApplication application = null;
            for(int a = 0; a < aprot.Count; a++)
            {
                application = aprot.get_Item(a);
                System.Console.WriteLine("Application Title = " + application.Document.Title);

                foreach (string curItem in args)
                {
                    System.Console.WriteLine("Args: " + curItem);
                    if (application.Document.Title == curItem)
                    {
                         System.Console.WriteLine("The map was found!  Do something!");
                    }
                    else
                    {
                        System.Console.WriteLine("The open map does not match that title.");
                    }
                }
            }
            if (aprot.Count == 0)
            {
                System.Console.WriteLine("No ArcMap application is open");
            }
            //System.Console.ReadLine();  //Uncomment this line if you want to have the console pause before closing.
        }
        catch (Exception e)
        {
            Console.WriteLine("{0} Exception caught.", e);
        }
            //Do not make any call to ArcObjects after ShutDownApplication()
            m_AOLicenseInitializer.ShutdownApplication();
        }
    }
}

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Sun, 26 Aug 2012 00:10:52 GMT

I spoke too soon. While the script and console application work perfectly when I run the Python script from Idle, it hangs when I run the same code from within a script tool. The Console application window opens, but the parameters never get read when the script tool runs the code.

Anyway, I know how to get the Data Frame Clip Geometry updated from the ArcObjects side, but I still need to find a way to connect it automatically to the Python code at runtime.

If the parameters are all that is hanging it up, I may be able to eliminate the need for any parameters on the Console application by using the original technique I suggested of using an intermediate text object for passing parameter information between Python and ArcObjects. That would be acceptable for my needs. However, I will have to do additional testing to be certain that the Console application will run from a script tool and not hang if parameters are eliminated.

Edit:

It hangs without parameters as well from a script tool. Now I am looking at the subprocess options to see if it can create a shell that works within the script tool, but I am not optimistic.

Edit2:

The shell option causes an error and using call instead of check_call hangs also. So it looks like a script tool does not work with a Console application at all. Bummer.

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Sat, 11 Dec 2021 12:57:04 GMT

        // Create an instance of DecimalFormat to limit the number of integers the user can type into certain fields.
        DecimalFormat temperatureFormat = new DecimalFormat("##0.00");

        ftfTemperature = new JFormattedTextField(new DefaultFormatterFactory(new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat),new NumberFormatter(temperatureFormat)));
        ftfTemperature.addFocusListener(new FocusAdapter() {
            @Override
            public void focusGained(FocusEvent e) {
                SwingUtilities.invokeLater(new Runnable(){
                    @Override
                    public void run() {
                        ftfTemperature.selectAll();
                    }
                });
            }
        });
        ftfTemperature.setBounds(120, 8, 85, 20);
        panel.add(ftfTemperature);

Leo:

Could you screen shot what this code actually produces as far as an interface that the user would see? Searching help on Java Add-ins has left me completely in the dark on what this code would end up looking like or how it launches or anything. Is the Java IDE environment text based only for defining the form or does it have visual drag and drop tools? I need the real basics to get oriented to decide if I want to even attempt to go down this path. How is building a Java add-in any different from building a .Net add-in?

Re: Creating an Addin Extension that Responds to a Python Script

RichardFairhurst — Mon, 27 Aug 2012 00:36:27 GMT

I have decided to give my original idea a try and set up a listener for the AfterDraw event in an Add-in extension.

Even though Python's refresh of an ActiveView does not seem to trigger the extension code, it appears that this approach will work because the mere act of closing the geoprocessing results window when the script is done triggers the extension code to detect an AfterDraw event if that dialog covered any portion of the map. This behavior should be nearly unavoidable. Even if closing that tool dialog does not work, if anything covers a portion of the map for even a moment, like a messagebox or a dockable window expansion, the code is triggered and should be able to evaluate the map configuration to determine if it needs to execute its custom code. And failing all of that if any other user action triggers a refresh the code will fire.

At this point I mainly need to identify the optimum code sequence to ensure that the AfterDraw event always fires in connection with the proper ActiveView (the LayoutView) and that it quickly determines when it does or does not need to implement its custom behavior. The map must be in Layout view because the Python code I have written ensures this is the view when it finishes running, and if that is the case it should then determine if the Text object exists in the map, and if that is the case it should detect if the Text object has the proper information for executing the code. If there are any suggestions on how to best optimize such code, I would appreciate them. I will continue experimenting in the meantime.

Re: Creating an Addin Extension that Responds to a Python Script

LeoDonahue — Mon, 27 Aug 2012 15:47:54 GMT

Leo:
Could you screen shot what this code actually produces as far as an interface that the user would see?

Weather screenshot is attached.

Searching help on Java Add-ins has left me completely in the dark on what this code would end up looking like or how it launches or anything.

The code is not Java "Add-in" code. It is Java Swing.

Is the Java IDE environment text based only for defining the form or does it have visual drag and drop tools? I need the real basics to get oriented to decide if I want to even attempt to go down this path.

It has visual drag and drop. I'm running Eclipse 3.7.1 See ide screenshot.

How is building a Java add-in any different from building a .Net add-in?

I was about to dabble in building a .NET add-in over the weekend to answer that question for myself. Aside from the obvious IDE configuration differences and language patterns, add-ins should be relatively the same. I think the ArcObjects API still favors COM when it comes to GUI development, and that is based on my experience with displaying Java Dialogs to the end user of Add-ins within ArcMap, specifically JOptionPane. I will say that my specific issue with JOptionPane is partly due to the JRE living on top of a COM operating system. I've seen the C#.NET Visual Studio Express IDE enough to know that switching from Java to C# using Visual Studio Express would be a pain getting used to the way you work with the add-in config.xml file and the way you refactor, and then there is all of the fun Windows issues still looming about in .NET when it comes to registering dlls. But anything you learn for the first time sticks with you as the "easy way".