Merge remote-tracking branch 'origin/main' into main

Author: fabanc

images/clone-environment.png

@@ -2,15 +2,28 @@
 from openlocationcode import openlocationcode as olc
 
 # https://github.com/google/open-location-code/blob/master/python/openlocationcode_test.py
+# https://grid.plus.codes/
 
 
 def check_spatial_reference(feature_class):
+    """
+    Check if the feature class is using the Geographic Reference System WGS84 (Lat / Long). The wkid should be 4326.
+    An exception will be raised if that's not the case.
+    :param feature_class: The feature class that will be used to generate the Open Location Code.
+    :return:
+    """
     sr = arcpy.Describe(feature_class).spatialReference
     if sr.factoryCode != 4326:
         raise ValueError('The input feature class must be in WHS84 (WKID 4326)')
 
 
-def validate_plus_code_length(code):
+def validate_plus_code_length(code_length):
+    """
+    Validate if the Plus Code Length is valid. That does not account for the character '+' added by the API. The
+    function will raise an exception if the number of character used is not valid.
+    :param code_length: The number of characters used to encode the Open Location Code.
+    :return: None
+    """
 
     # Those are the number of digit required from the specifications.
     valid_codes_length = [
@@ -23,9 +36,9 @@ def validate_plus_code_length(code):
         12  # Level 6
     ]
 
-    if code not in valid_codes_length:
+    if code_length not in valid_codes_length:
         raise ValueError('Valid Plus Code must be one of the following value: {}'.format(
-            ', '.join([str(code) for code in valid_codes_length])
+            ', '.join([str(code_length) for code_length in valid_codes_length])
         ))
 
 
@@ -56,7 +69,7 @@ def generate_plus_code(feature_class, plus_code_field, code_length):
 
     :param feature_class: The input feature class. The EPSG must be 4326
     :param plus_code_field: The field that will contain the plus codes.
-    :param code_length: The maximum length for the plus code.
+    :param code_length: The number of characters used to encode the Open Location Code.
     :return:
     """
 
@@ -69,16 +82,14 @@ def generate_plus_code(feature_class, plus_code_field, code_length):
     # Validate the field is long enough to accomodate the code.
     validate_code_field_length(feature_class, plus_code_field, code_length)
 
-    count = 0
+    # Get the number of features. This will be used to set a progress bar.
+    count_features = int(arcpy.management.GetCount(feature_class)[0])
+    arcpy.SetProgressor('step', 'Computing Plus Codes ...', 0, count_features, 1)
+
     with arcpy.da.UpdateCursor(feature_class, ['SHAPE@XY', plus_code_field, 'OID@']) as input_cursor:
         for input_row in input_cursor:
 
             oid = input_row[-1]
-            count += 1
-
-            if count % 100000 == 0:
-                arcpy.AddMessage('Processed {} rows so far ...'.format(count))
-
             try:
                 longitude = input_row[0][0]
                 latitude = input_row[0][1]
@@ -89,6 +100,8 @@ def generate_plus_code(feature_class, plus_code_field, code_length):
                 arcpy.AddWarning(
                     'Something went wrong with feature OID: {} - Error Message: {}'.format(oid, ex.message)
                 )
+            finally:
+                arcpy.SetProgressorPosition()
 
 
 if __name__ == '__main__':