Use formatted string literals; update how modules are imported

Author: pmacMaps

download_and_extract_layer_from_agol.py

@@ -13,57 +13,59 @@
 #
 # Created:     7/9/2020
 #
-# Updated:     12/23/2021
+# Updated:     9/21/2022
 # -------------------------------------------------------------------------------
 
 # import modules
 import arcpy
-import datetime
-import sys
-import os
-import zipfile
 from arcgis.gis import GIS
+from datetime import date
+from os import path
+from os import makedirs
+from os import environ
+from os import listdir
+import zipfile
+import sys
 
 try:
     # allow content to be overwritten
     arcpy.env.overwriteOutput = True
 
     # Time stamp variables
-    date_today = datetime.date.today()
+    date_today = date.today()
     # Date formatted as month-day-year (1-1-2017)
     formatted_date_today = date_today.strftime("%m-%d-%Y")
     # date for sub-directory name
     date_dir = date_today.strftime("%m%d%Y")
 
     # Create text file for logging results of script
-    log_file = r'Path\To\Directory\Report File {}.txt'.format(date_today)
+    log_file = path.join(r'Path\To\Directory', f'Report File {date_today}.txt')
     # variable to store messages for log file. Messages written in finally statement at end of script
     log_message = ''
 
     # 1. create new sub-directory using current date within parent directory
     # new directories are created within this directory
     parent_dir = r'Path\To\Directory'
     # output directory
-    out_dir = r'{}\{}'.format(parent_dir, date_dir)
+    out_dir = path.join(parent_dir, date_dir)
     # create sub-directory with current date
-    os.mkdir(out_dir)
+    makedirs(out_dir)
     # add message
-    log_message += '\nCreated directory "{}" in "{}"\n'.format(
-        date_dir, out_dir)
+    log_message += f'\nCreated directory "{date_dir}" in "{out_dir}"\n'
 
     # reference to ArcGIS Online (AGOL) or Portal
     # URL to AGOL organization or Portal
     portal = ''
     # username
     # create environment variable to store username; pass that variable name into get() method
-    user = os.environ.get('user_name_environment_variable')
+    user = environ.get('user_name_environment_variable')
     # password
     # create environment variable to store pasword; pass that variable name into get() method
-    password = os.environ.get('password_environment_variable')
+    password = environ.get('password_environment_variable')
     # create AGOL/Portal object
     # adding parameter "verify_cert=False" may resolve connection issues
     gis = GIS(portal, user, password)
-    log_message += '\nConnected to {}\n'.format(portal)
+    log_message += f'\nConnected to {portal}\n'
 
     # 1. Download an item (i.e., feature service) from ArcGIS Online/Portal
     # name of item for use in script
@@ -80,15 +82,15 @@
     # Delete the item after it downloads to save space (optional step)
     result.delete()
     # add message
-    log_message += '\nDownloaded "{}"\n'.format(item_name)
+    log_message += f'\nDownloaded "{item_name}"\n'
 
     # 2. Unzip item
     # zipped file downloaded
     # you will need to export and download the item to learn what it's filename will be
     # enhancement to make to script > set "download_path" to join between out_dir and a file in that directory that ends with ".zip"
     download_file = 'SomeFileName.zip'
     # directory where zipped file is located
-    download_path = os.path.join(out_dir, download_file)
+    download_path = path.join(out_dir, download_file)
     # unzip file
     with zipfile.ZipFile(download_path, "r") as z:
         z.extractall(out_dir)
@@ -106,33 +108,33 @@
     # If not, you'll need to update the following to work with your download format
 
     # get list of contents in "out_dir" directory
-    dir_contents = os.listdir(out_dir)
+    dir_contents = listdir(out_dir)
     # placeholder for extracted file geodatabase
     in_gdb = ''
 
     # loop through directory and create object for file geodatabase
     # assumed only one file geodatabase exists in this location
     for content in dir_contents:
         if content.endswith('.gdb'):
-            in_gdb = os.path.join(out_dir, content)
+            in_gdb = path.join(out_dir, content)
 
     # copy feature class to persistant geodatatbase
-    arcpy.Copy_management(os.path.join(in_gdb, feature_class),
-                          os.path.join(out_gdb, feature_class))
+    arcpy.Copy_management(path.join(in_gdb, feature_class),
+                          path.join(out_gdb, feature_class))
 
     # add message
-    log_message += '\nCopied data from "{}" to "{}"\n'.format(in_gdb, out_gdb)
+    log_message += f'\nCopied data from "{in_gdb}" to "{out_gdb}"\n'
 # If an error occurs running geoprocessing tool(s) capture error and write message
 except (Exception, EnvironmentError) as e:
     tbE = sys.exc_info()[2]
     # add the line number the error occured to the log message
-    log_message += "\nFailed at Line {}\n".format(tbE.tb_lineno)
+    log_message += f"\nFailed at Line {tbE.tb_lineno}\n"
     # add the error message to the log message
-    log_message += "\nError: {}\n".format(e)
+    log_message += f"\nError: {str(e)}\n"
 finally:
     # write message to log file
     try:
         with open(log_file, 'w') as f:
             f.write(str(log_message))
     except:
-        pass
+        pass

enterprise_geodatabase_maintenance_tasks.py

@@ -3,23 +3,24 @@
 # on an enterprise (sde) geodatabase
 # connections to the database are closed, and all users are disconnected
 # before running tools.  database connections are opened at the end
+# Updated: 9/21/2022
 
 # import modules
 import arcpy
-import os
 import sys
-import datetime
 import time
+from datetime import date
+from os import path
 
 # capture the date the script is being run
-date_today = datetime.date.today()
+date_today = date.today()
 # convert date format to month-day-year (1-1-2020)
 formatted_date_today = date_today.strftime("%m-%d-%Y")
 # placeholder for messages for text file
 log_message = ''
 # text file to write messages to
 # TODO: update path
-log_file = r'C:\GIS\Results\Database_Maint_Report_{}.txt'.format(date_today)
+log_file = path.join(r'C:\GIS\Results', f'Database_Maint_Report_{date_today}.txt')
 
 try:
     # database connection
@@ -37,59 +38,58 @@
     # Next, for feature datasets get all of the datasets and featureclasses
     # from the list and add them to the master list.
     for dataset in arcpy.ListDatasets("", "Feature"):
-        arcpy.env.workspace = os.path.join(dbase, dataset)
+        arcpy.env.workspace = path.join(dbase, dataset)
         data_list += arcpy.ListFeatureClasses() + arcpy.ListDatasets()
     # add message
-    log_message += '{} : Created list of feature classes and tables in geodatabase\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"{time.strftime('%I:%M%p')} : Created list of feature classes and tables in geodatabase\n"
 
     # close database from accepting connections
     arcpy.AcceptConnections(dbase, False)
     # remove existing users
     arcpy.DisconnectUser(dbase, 'ALL')
     # add message
-    log_message += '\n{} : Disconnected users and closed connections to the geodatabase\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"\n{time.strftime('%I:%M%p')} : Disconnected users and closed connections to the geodatabase\n"
 
     # run analyze datasets
     arcpy.AnalyzeDatasets_management(dbase, 'SYSTEM', data_list, 'ANALYZE_BASE', 'ANALYZE_DELTA', 'ANALYZE_ARCHIVE')
     # add message
-    log_message += '\n{} : Ran "Analyze Datasets" tool\n'.format(time.strftime('%I:%M%p'))
-
+    log_message += f"\n{time.strftime('%I:%M%p')} : Ran 'Analyze Datasets' tool\n"
     # run rebuild indexes
     arcpy.RebuildIndexes_management(dbase, 'SYSTEM', data_list, 'ALL')
     # add message
-    log_message += '\n{} : Ran "Rebuild Indexes" tool\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"\n{time.strftime('%I:%M%p')} : Ran 'Rebuild Indexes' tool\n"
 
     # run compress
     arcpy.Compress_management(dbase)
      # add message
-    log_message += '\n{} : Ran "Compress" tool\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"\n{time.strftime('%I:%M%p')} : Ran 'Compress' tool\n"
 
     # run analyze datasets
     arcpy.AnalyzeDatasets_management(dbase, 'SYSTEM', data_list, 'ANALYZE_BASE', 'ANALYZE_DELTA', 'ANALYZE_ARCHIVE')
     # add message
-    log_message += '\n{} : Ran "Analyze Datasets" tool\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"\n{time.strftime('%I:%M%p')} : Ran 'Analyze Datasets' tool\n"
 
     # run rebuild indexes
     arcpy.RebuildIndexes_management(dbase, 'SYSTEM', data_list, 'ALL')
      # add message
-    log_message += '\n{} : Ran "Rebuild Indexes" tool\n'.format(time.strftime('%I:%M%p'))
+    log_message += f"\n{time.strftime('%I:%M%p')} : Ran 'Rebuild Indexes' tool\n"
 
     # allow database to accept connections
     arcpy.AcceptConnections(dbase, True)
 # If an error occurs running geoprocessing tool(s) capture error and write message
 except (Exception, EnvironmentError) as e:
     tbE = sys.exc_info()[2]
     # Write the line number the error occured to the log file
-    log_message += "\nFailed at Line {}\n".format(tbE.tb_lineno)
+    log_message += f"\nFailed at Line {tbE.tb_lineno}\n"
     # Write the error message to the log file
-    log_message += "Error: {}".format(str(e))
+    log_message += f"Error: {str(e)}"
 finally:
     # write message to log file
     try:
         # allow database to accept connections
         arcpy.AcceptConnections(dbase, True)
          # add message
-        log_message += '\n{} : Opened connections to the geodatabase\n'.format(time.strftime('%I:%M%p'))
+        log_message += f"\n{time.strftime('%I:%M%p')} : Opened connections to the geodatabase\n"
         # write messages to text file
         with open(log_file, 'w') as f:
             f.write(str(log_message))

export_layers_to_file_geodatabase_and_excel.py

@@ -11,26 +11,26 @@
 #
 # Created:     4/4/2019
 #
-# Updated:     12/28/2021
+# Updated:     9/21/2022
 # -------------------------------------------------------------------------------
 
 import arcpy
-import datetime
 import sys
-import os
+from os import path
+from os import makedirs
+from datetime import date
 
 try:
     # Time stamp variables
-    date_today = datetime.date.today()
+    date_today = date.today()
     # Date formatted as month-day-year (1-1-2017)
     formatted_date_today = date_today.strftime("%m-%d-%Y")
     # date for file geodatabase name
     date_gdb = date_today.strftime("%m%d%Y")
 
     # Create text file for logging results of script
     # update this variable
-    log_file = r'[path]\[to]\[location]\Report File Name {}.txt'.format(
-        formatted_date_today)
+    log_file = path.join(r'[path]\[to]\[location]', f'Report File Name {formatted_date_today}.txt')
     # variable to store messages for log file. Messages written in finally statement at end of script
     log_message = ''
 
@@ -40,37 +40,36 @@
     # layers
     # update this variable
     # recommended to use underscores in naming convention of second element of sub-list
-    layers = [[os.path.join(geodatabase, r'Name of Layer'), 'Name_of_Layer'], [os.path.join(
-        geodatabase, r'Name of Layer'), 'Name_of_Layer'], [os.path.join(geodatabase, r'Name of Layer'), 'Name_of_Layer']]
+    layers = [[path.join(geodatabase, r'Name of Layer'), 'Name_of_Layer'], [path.join(
+        geodatabase, r'Name of Layer'), 'Name_of_Layer'], [path.join(geodatabase, r'Name of Layer'), 'Name_of_Layer']]
 
     # 1. create new directory
     # parent directory
     # update this variable
     parent_dir = r'[path]\[to]\[location]'
     # output directory
-    out_dir = r'{}\{}'.format(parent_dir, date_gdb)
+    out_dir = path.join(parent_dir, date_gdb)
     # create sub-directory with current date
-    os.mkdir(out_dir)
+    makedirs(out_dir)
     # add message
-    log_message += '\nCreated directory "{}" in {}\n'.format(date_gdb, out_dir)
+    log_message += f'\nCreated directory "{date_gdb}" in {out_dir}\n'
 
     # 2. create file geodatabase
     # parameters
     # update this variable
-    out_gdb_name = r'Name_of_Geodatabase_{}'.format(date_gdb)
-    out_gdb = os.path.join(out_dir, '{}.gdb'.format(out_gdb_name))
+    out_gdb_name = f'Name_of_Geodatabase_{date_gdb}'
+    out_gdb = path.join(out_dir, f'{out_gdb_name}.gdb')
     # geoprocessing
     arcpy.CreateFileGDB_management(out_dir, out_gdb_name, '10.0')
     # add message
-    log_message += '\nCreated file geodatabase "{}" in directory "{}"\n'.format(
-        out_gdb_name, out_dir)
+    log_message += f'\nCreated file geodatabase "{out_gdb_name}" in directory "{out_dir}"\n'
 
     # 3. Export layers to file geodatabase
     for fc in layers:
         # export feature class
         arcpy.FeatureClassToFeatureClass_conversion(fc[0], out_gdb, fc[1])
         # add message
-        log_message += '\nCopied {} layer to {}\n'.format(fc[1], out_gdb)
+        log_message += f'\nCopied {fc[1]} layer to {out_gdb}\n'
     # end for
 
     # 4. update Latitude Longitude fields in feature classes
@@ -96,23 +95,21 @@
                 cursor.updateRow(row)
             # end for
             # update your message
-            log_message += '\nCompleted updating Latitude and Longitude records for "{}" layer\n'.format(
-                fc)
+            log_message += f'\nCompleted updating Latitude and Longitude records for "{fc}" layer\n'
         # end cursor
         # convert to Excel
-        arcpy.TableToExcel_conversion(fc, os.path.join(
-            out_dir, '{}.xls'.format(fc)), "ALIAS")
+        arcpy.TableToExcel_conversion(fc, path.join(
+            out_dir, f'{fc}.xls'), "ALIAS")
         # add message
-        log_message += '\nExported {} layer to Microsof Excel format\n'.format(
-            fc)
+        log_message += f'\nExported {fc} layer to Microsof Excel format\n'
     # end for
 # If an error occurs running geoprocessing tool(s) capture error and write message
 except (Exception, EnvironmentError) as e:
     tbE = sys.exc_info()[2]
     # add the line number the error occured to the log message
-    log_message += "\nFailed at Line {}\n".format(tbE.tb_lineno)
+    log_message += f"\nFailed at Line {tbE.tb_lineno}\n"
     # add the error message to the log message
-    log_message += "\nError: {}\n".format(str(e))
+    log_message += "\nError: {str(e)}\n"
 finally:
     try:
         if cursor:
@@ -124,4 +121,4 @@
         with open(log_file, 'w') as f:
             f.write(str(log_message))
     except:
-        pass
+        pass