nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to check if in an Edit Session using python and arcpy

VishalShah2

I am currently working on a tool that uses the updateCursor function but the tool needs to be in an edit session to use. However some who may use the tool may end up not being in an edit session before running the tool and get an error. Rather than come ask me every time about the error, I'd like to implement an if statement in the script in the beginning that checks if the user is currently in an edit session, if they are then run tool. if not, a dialogue box explaining they need to be in an edit session and ask if they want the script to turn editor on. Formatted as such:

<SPAN class="comment token">#if edit session is on:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#run tool</SPAN>
<SPAN class="comment token">#elif edit session is off:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#dialogue box explaining user has to be in edit session and asking if they want the script to turn editor on (Yes or no option):</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#if yes:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#run tool</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#if no:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="comment token">#quit</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

I am trying to do this without using the work done by Mark Cederholm as referenced in this post: How do I access ArcObjects from Python?, and code examples provided by Matt Wilkie in his "Snippits.py" file.

Trouver plus de publications taguées avec

Accepted answers

All comments

Lake_Worth_BeachAdmin

just start an edit session regardless its original state in the beginning of the script.

VishalShah2

So I believe doing it this way may actually work in a sense to get the Message Box using the python add-ins module. However, one issue I am having is doing the check to see which value from the message box the user selected. This is the first thing that happens when the user selects to use this tool. This is an add-in portion of the tool. Any help on figuring out how to call on the value in the Message Box will be helpful. The mb_type here is 4 so that the message box type is yes/no. Other mb_types and information about python add-ins can be found here. So my issue is figuring out how to see if the Message Box value the user selected was a yes or a no.

<SPAN class="keyword token">import</SPAN> arcpy
<SPAN class="keyword token">import</SPAN> pythonaddins
<SPAN class="keyword token">import</SPAN> os

toolPath <SPAN class="operator token">=</SPAN> r<SPAN class="string token">'path to toolboox.tbx'</SPAN>
workspace <SPAN class="operator token">=</SPAN> <SPAN class="string token">'some workspace'</SPAN>
editor <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>da<SPAN class="punctuation token">.</SPAN>Editor<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN>


<SPAN class="keyword token">if</SPAN> editor<SPAN class="punctuation token">.</SPAN>isEditing <SPAN class="operator token">==</SPAN> <SPAN class="string token">'true'</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; pythonaddins<SPAN class="punctuation token">.</SPAN>GPToolDialog<SPAN class="punctuation token">(</SPAN>toolPath<SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'CustomExportTool'</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">elif</SPAN> editor<SPAN class="punctuation token">.</SPAN>isEditing <SPAN class="operator token">==</SPAN> <SPAN class="string token">'false'</SPAN><SPAN class="punctuation token">:</SPAN> 
&nbsp;&nbsp;&nbsp; pythonaddins<SPAN class="punctuation token">.</SPAN>MessageBox<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"You must be in an edit session to run the Custom Export Tool. If you wish to turn an edit session on, please click 'yes'. If you do not wish to turn an edit session on, please click 'no'."</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">"Turn Editor On?"</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="number token">4</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">if</SPAN> MessageBox <SPAN class="operator token">==</SPAN> <SPAN class="string token">'yes'</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; editor<SPAN class="punctuation token">.</SPAN>startEditing<SPAN class="punctuation token">(</SPAN><SPAN class="token boolean">False</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="token boolean">False</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; pythonaddins<SPAN class="punctuation token">.</SPAN>GPToolDialog<SPAN class="punctuation token">(</SPAN>toolPath<SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'CustomExportTool'</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">elif</SPAN> MessageBox <SPAN class="operator token">==</SPAN> <SPAN class="string token">'no'</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; quit‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

VishalShah2

Joshua, so it's actually a Runtime Error that says "Objects in this class cannot be updated outside an edit session [lists the feature class]." Then it says "Failed to execute (ToolName)." So there wasn't an error code you get and so I'm wondering if using exceptions would work then?

VishalShah2

I've never worked with exceptions before so I was wondering if you have an example of what it may look like and the formatting of the script so I may try that out.

IanMurray

I wonder if instead of trying to check if an edit session is going on, just check if a LOCK file is present for that workspace the file you are hoping to edit is in for the file in question. A file GDB creates a LOCK file of the same name regardless of whether it is being editted within an ArcMap Edit Session or using an Editor Object(FeatureClassName.ed.lock). Its not perfect since obviously more than one person can be accessing the dataset and create a lock on it, but at least you can check if the data is being editted at all.

Just spitballing here.

bixb0012

iamurray‌ provided some good links, I suggest you read over them.

Given the tools generates an error anywhere from "milliseconds to like 2 seconds," which is pretty quick (it isn't like it runs for tens of minutes and then errors out), I would go with a try except block. Python handles EAFP (easier to ask forgiveness than permission) much better than other languages, so generating exceptions and handling them isn't seen as a big deal. Unlike some of the code examples in the StackExchange thread that Ian referenced, you really don't want to trap all exceptions with a generic except clause. It is better to trap the specific exception relating to edit sessions because you want other errors to still propagate through to the user.

VishalShah2

Hi Joshua, so the error pops up milliseconds to like 2 seconds after you start running the tool. The tool is a custom export tool that has the function updateCursor function, which updates the fields to a particular value rather than leaving the blank fields as null values. The error states that updateCursor can not be used outside of the edit session and the rest of the tool does not run. Hence why I want to create this check to see if edit session is active and if not, to provide a prompt for the user that enables the user to select 'Yes' or 'No' to allow the script to turn an edit session on and then run the tool.

bixb0012

If an edit session doesn't exist, when exactly does the user see the error? Right away, or is it after the tool has ran for a while? What is the function or method call that is generating the error? What specifically is the error?

bixb0012

Good idea, unfortunately it doesn't seem to work. I just tested a file and enterprise geodatabase, and arcpy.da.Editor appears to only be aware of itself, i.e., isEditing() only returns True if the instantiated editor object starts an edit session.

DanPatterson_Retired

I would just bail .... totally untested of course.

<SPAN class="comment token"># -*- coding: UTF-8 -*-</SPAN>
<SPAN class="keyword token">import</SPAN> sys
<SPAN class="keyword token">import</SPAN> os
<SPAN class="keyword token">import</SPAN> arcpy

<SPAN class="comment token">#edit_me = sys.argv[1]</SPAN>
fc <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"C:\GIS\array_projects\data\Pro_base.gdb\Line"</SPAN>
workspace <SPAN class="operator token">=</SPAN> os<SPAN class="punctuation token">.</SPAN>path<SPAN class="punctuation token">.</SPAN>dirname<SPAN class="punctuation token">(</SPAN>fc<SPAN class="punctuation token">)</SPAN>
edit <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>da<SPAN class="punctuation token">.</SPAN>Editor<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">if</SPAN> edit<SPAN class="punctuation token">.</SPAN>isEditing<SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"you are in an edit session"</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="keyword token">else</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"you aren't in an edit session"</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; sys<SPAN class="punctuation token">.</SPAN>exit<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

VishalShah2

Dan, I was thinking along the lines of the format I have below. This way users wouldn't have to turn editor on manually but just have to simply click yes or no. Would this work?

<SPAN class="keyword token">if</SPAN> isEditing <SPAN class="operator token">==</SPAN> <SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; run tool
<SPAN class="keyword token">elif</SPAN> isEditing <SPAN class="operator token">==</SPAN> <SPAN class="token boolean">False</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; dialogue box pops up informing user to be <SPAN class="keyword token">in</SPAN> edit session <SPAN class="operator token">and</SPAN> ask <SPAN class="keyword token">if</SPAN> they want script to turn it on <SPAN class="keyword token">for</SPAN> them<SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">if</SPAN> yes<SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>startEditing<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">elif</SPAN> no<SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; quit<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

DanPatterson_Retired

Did you read up on the Editor in the help? It would be best to run your functionality from a tool in arctoolbox, to ensure or validate that you are in an edit session than relying on the user getting into an edit session manually

Rejoindre la conversation

Les membres connectés peuvent publier, suivre les mises à jour, et plus encore. Nouveau ici ? Inscrivez-vous gratuitement.

Liens rapides

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.