topic Re: Zip File Script & if name == 'main': in Python Questions

Zip File Script & if name == 'main':

JaredPilbeam1 — Sat, 11 Dec 2021 14:19:15 GMT

#11/17/2016
#
#take all of the shapefiles in a directory and compress them into individual zip files
#
#########################################################################################

#import workspace

import arcpy, os
from arcpy import env
from os import path as p
import RemoveAddLayer
import zipfile
arcpy.overwriteOutput = True


def ZipShapes(path, outpath):
    arcpy.env.workspace = path
    shapes = arcpy.ListFeatureClasses()

#iterate through list of shapefiles
    for shape in shapes:
        name = p.splitext(shape)[0]
        print name
        zip_path = p.join(out_path, name + '.zip')
        zip = zipfile.ZipFile(zip_path, 'w', compression=zipfile.ZIP_DEFLATED)
        zip.write(p.join(path,shape), shape)
        for f in arcpy.ListFiles('%s*' %name):
            if not f.endswith('.shp'):
                zip.write(p.join(path,f),f)
        print 'All file written to %s' %zip_path
        zip.close()


if __name__ == '__main__':

    path = r"Z:\Jared\Python Scripts"
    outpath = r"W:\Data"

    ZipShapes(path, outpath)
        ‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Only a novice at Python. Using ArcMap for Desktop 10.3. My ultimate objective is to send some shapefiles to a zip file using script. I ran the above based on someone's existing script.

1.) What is if __name__ == '__main__': doing in this scenario?

From what I understand you can use this when importing another Python script? That's why I have the "RemoveAddLayer" script as an import at the top. I may be completely wrong?

2.) The RemoveAddLayer script (that's imported at the top) is what I created to update Streets and Address Points layers. Should I save these to a folder in the script and then set that as the path variable in the ZipFiles2 script?

There was no error when I ran this but also no file was put into the outpath folder.

Edit: @Rebecca: Thanks, I took your advice and put the script in instead of the image.

Re: Zip File Script & if name == 'main':

RebeccaStrauch__GISP — Sat, 11 Dec 2021 14:19:18 GMT

sorry...not answering your questions righ now, but I noticed one thing that will cause an issue. you will need an

import zipfile

in the first script shown.

When asking for help, always best to format the program instead of having images. at the top of the editor window

... More ... Syntax highlighter -> Python

then copy in you scripts. Also including the software version is helpful, and any error codes when you are test the code.

BTW, I have a couple versions for zipping, I'll include both below...one is commented out. both were working, but the second one worked better for me.

import arcpy
import os
def myMsgs(message):
  arcpy.AddMessage("{0}".format(message))
  print("{0}".format(message)  )

'''
# other option for zipping, but other zipws function is working well.
import sys, zipfile
def zip(src, toZip):
  #zf = zipfile.ZipFile("%s.zip" % (dst), "a", zipfile.ZIP_DEFLATED)
  zf = zipfile.ZipFile("{0}a.zip".format(os.path.join(path,toZip)), "a", zipfile.ZIP_DEFLATED)
  abs_src = os.path.abspath(src)
  for dirname, subdirs, files in os.walk(src):
    for filename in files:
      absname = os.path.abspath(os.path.join(dirname, filename))
      arcname = absname[len(abs_src) + 1:]
      #print 'zipping %s as %s' % (os.path.join(dirname, filename), arcname)
      myMsgs('zipping {0} as {1}'.format(filename, arcname))
      zf.write(absname, arcname)
  zf.close()'''

#**********************************************************************
# Import sys and zipfile modules for zip function
# Paramaeters:
#   path: folder to os.walk thru...ignores .lock and other .zip files
#   toZip: file to write
#   fcbase:  filter for files to zip
# keep = False -hardcoded..True puts files in "path folder", False at root of .zip
#**********************************************************************
import sys, zipfile
#keep = False   # keep = True puts files in "path folder", False puts files at root of .zip
def zipws(path, toZip, fcBase, keep=False):
  #zf = zipfile.ZipFile("%s.zip" % (toZip), "w", zipfile.ZIP_DEFLATED)
  zf = zipfile.ZipFile("{0}.zip".format(os.path.join(toZip, fcBase)), "a", zipfile.ZIP_DEFLATED)
  path = os.path.normpath(path)
  # os.walk visits every subdirectory, returning a 3-tuple
  #  of directory name, subdirectories in it, and file names
  #  in it.
  #
  for (dirpath, dirnames, filenames) in os.walk(path):
    # Iterate over every file name #
    for file in filenames:
      # Ignore .lock files and other .zip files#
      if fcBase in file and not file.endswith('.lock') and not file.endswith('.zip'):
        myMsgs("        Adding {0}...".format(os.path.join(path, dirpath, file)))
        try:
          if keep:
            zf.write(os.path.join(dirpath, file),
                     os.path.join(os.path.basename(path), os.path.join(dirpath, file)[len(path)+len(os.sep):]))
          else:
            zf.write(os.path.join(dirpath, file),            
                     os.path.join(dirpath[len(path):], file)) 

        except Exception, e:
          arcpy.AddWarning("    Error adding {0}: {1}".format(file, e))

  return None
#**********************************************************************
# end of function zipws 
#**********************************************************************
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Zip File Script & if name == 'main':

DarrenWiens2 — Thu, 17 Nov 2016 22:35:15 GMT

I'll probably not get this 100% technically correct, but here goes:

Each script is blessed with a '__name__'. If the script is the main executing file, it gets the name '__main__'. You can also import any .py file as a module, like you did with RemoveAddLayer. When the code executes within RemoveAddLayer, I assume __name__ = 'RemoveAddLayer', or something similar, but definitely not '__main__'.

On the flipside, if you ran a different script that imported the script you've posted above, __name__ != __main__, so that part wouldn't execute. You would still have access to the ZipShapes() function in the first script, though. Clear as mud?

edit: there is lots and lots written out there. Search for '__main__' or '__name__'.

Re: Zip File Script & if name == 'main':

DanPatterson_Retired — Thu, 17 Nov 2016 22:41:46 GMT

assuming Rebecca's edits are good-to-go, the 'if __name__.... section is designed to be used if the script is run as a standalone script, not when it is imported.

That script, if checked and run, would have looked in the Jared folder for stuff to compress and output it the the W folder by running the Zip... def passing the two parameters to it. If the script were imported, then the def could be used but you would have to provide your own parameters to it for it to run.

To be official here are the docs 29.4. __main__ — Top-level script environment — Python 3.5.2 documentation

in that example the function main() would run if the script were run as a script, but not if imported. It doesn't need to be a function called main, it is a convention which I often break

See the recent poll

EDIT

I gave some examples in there

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Sat, 11 Dec 2021 14:19:20 GMT

#11/17/2016
#
#take all of the shapefiles in a directory and compress them into individual zip files
#
#########################################################################################

#import workspace

import arcpy, os
from arcpy import env
from os import path as p
import RemoveAddLayer
import zipfile

arcpy.overwriteOutput = True


def ZipShapes(path, outpath):
    arcpy.env.workspace = path
    shapes = arcpy.ListFeatureClasses()

#iterate through list of shapefiles
    for shape in shapes:
        name = p.splitext(shape)[0]
        print name
        zip_path = p.join(out_path, name + '.zip')
        zip = zipfile.ZipFile(zip_path, 'w', compression=zipfile.ZIP_DEFLATED)
        zip.write(p.join(path,shape), shape)
        for f in arcpy.ListFiles('%s*' %name):
            if not f.endswith('.shp'):
                zip.write(p.join(path,f),f)
        print 'All file written to %s' %zip_path
        zip.close()


if __name__ == '__main__':

    path = r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will"
    outpath = r"W:\Data"

    ZipShapes(path, outpath)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Here's the same code as I did originally. The only thing I changed is the path variable. But I got this error (below):

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Fri, 18 Nov 2016 20:32:50 GMT

Rebecca,

Might be glaringly obvious, but where did you set your variables in the second script?

Re: Zip File Script & if name == 'main':

DarrenWiens2 — Fri, 18 Nov 2016 20:50:45 GMT

out_path and outpath are different.

Re: Zip File Script & if name == 'main':

RebeccaStrauch__GISP — Fri, 18 Nov 2016 21:08:08 GMT

Lol. Not glaringly obvious. That was just a snippet of the two functions I had found that worked for me. This us part of a larger script/tool. I'm not at a place I can access the full script right (on iPad) now so can't show where I set the variable s (might be able to get later if really helpful for you). The reason I went with the second option is because it had the option of putting all my (shape) files at the root level, versus having a folder within the zip with the files. For my needs, I did not want the extra layer ( but in some cases it would be nice, I guess). These are scripts I found in the web, with maybe minir tweaks for my needs.

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Fri, 18 Nov 2016 21:16:23 GMT

They are, thanks for noticing.

After correcting them I ran it and got this error which is new to me:

Re: Zip File Script & if name == 'main':

RebeccaStrauch__GISP — Fri, 18 Nov 2016 21:43:09 GMT

I'm curious, why do you have shape files in what appears to be a SDE database?

path = r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will"

Maybe the shapes are coming from a different location and I am misreading. But if they are, can you export them to shape files in a temp folder and zop from there?

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Fri, 18 Nov 2016 21:57:53 GMT

path = r"Z:\Jared\Python Scripts"

That was my mistake. It's meant to be the above path. I had, in fact, set that path to an SDE until I realized it was the wrong path. In the RemoveAddLayer module (used in this script) I have that SDE path as my workspace.

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Sat, 11 Dec 2021 14:19:23 GMT

Ok, let me follow up as I'm still not sure how to call another module to this Zipfiles2.py script.

How can I call RemoveAddLayer.py from Zipfiles2.py? Both of these scripts run correctly. I'm not too worried how sloppy RemoverAddLayer.py might look. My concern is being able to call it while running ZipFiles2.py.

In a nutshell, RemoveAddLayer.py is meant to update the Streets and Address Points layers from the SDE (as I work for local government and these things change once and a while). First, it updates by removing the old layers. Second, it adds new ones straight from the SDE. Third, these are copied to a folder. And then by running ZipFiles.py I can successfully zip them and then save them in our Data folder where they are accessed from our website.

So, my goal is to bridge the gap and not run these two scripts separately.

Thanks!

#RemoveAddLayer.py
import arcpy
from arcpy import env

env.workspace = r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will"

#set path to mxd 
mxd = arcpy.mapping.MapDocument(r"Z:\Jared\Data_Request.mxd")

#reference the dataframe
for df in arcpy.mapping.ListDataFrames(mxd):
    print df
#reference the layers to be removed
    for lyr in arcpy.mapping.ListLayers(mxd, "gisedit.DBO.Address_Points", df):
        arcpy.mapping.RemoveLayer(df, lyr)
        print lyr
        for lyr in arcpy.mapping.ListLayers(mxd, "gisedit.DBO.Street", df):
            arcpy.mapping.RemoveLayer(df, lyr)
            print lyr
#reference the layers to be added
        addLayer = arcpy.mapping.Layer(r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will\gisedit.DBO.Address_Points")
        arcpy.mapping.AddLayer(df, addLayer, "TOP")
        print addLayer
        addLayer = arcpy.mapping.Layer(r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will\gisedit.DBO.Street")
        arcpy.mapping.AddLayer(df, addLayer, "TOP")
        print addLayer

#address points variables to be copied/saved in folder
        inFeatures = "gisedit.DBO.Address_Points"
        outLocation = r"Z:\Jared\Python Scripts\Data"
        outFeatureClass = "WillCounty_AddressPoint"

#execute and copy/save in folder. FeatureClassToFeatureClass_conversion syntax (in_features, out_path, out_name,
#       {where_clause}, {field_mapping}, {config_keyword})
        arcpy.FeatureClassToFeatureClass_conversion(inFeatures, outLocation, outFeatureClass)
        print "finished Address_Point.shp"

#variables to be copied/saved in folder
        inFeatures = "gisedit.DBO.Street"
        outLocation = r"Z:\Jared\Python Scripts\Data"
        outFeatureClass = "WillCounty_Street"

#execute and copy/save in folder. FeatureClassToFeatureClass_conversion syntax (in_features, out_path, out_name,
#       {where_clause}, {field_mapping}, {config_keyword})
        arcpy.FeatureClassToFeatureClass_conversion(inFeatures, outLocation, outFeatureClass)
        print "finished Street.shp"‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

#ZipFiles2.py
#import workspace
import arcpy
import os
from arcpy import env
from os import path as p
import zipfile
arcpy.overwriteOutput = True


def ZipShapes(path, out_path):
    arcpy.env.workspace = path
    shapes = arcpy.ListFeatureClasses()

#iterate through list of shapefiles
    for shapes in shapes:
        name = p.splitext(shapes)[0]
        print name
        print shapes
        zip_path = p.join(out_path, name + '.zip')
        zip = zipfile.ZipFile(zip_path, 'w', compression=zipfile.ZIP_DEFLATED)
        zip.write(p.join(path,shapes), shapes)
        for f in arcpy.ListFiles('%s*' %name):
            if not f.endswith('.shp'):
                zip.write(p.join(path,f),f)
        print 'All file written to %s' %zip_path
        zip.close()
         

if __name__ == '__main__':

    path = r"Z:\Jared\Python Scripts\Data"
    
    out_path = r"W:\Data"

    ZipShapes(path, out_path)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Zip File Script & if name == 'main':

RebeccaStrauch__GISP — Sat, 11 Dec 2021 14:19:26 GMT

My take....I would make RemoveAddLayer your main script, including moveing wrapping it in the '__main__" section. Then you cou either just keep the ZipShapes function in the same file (above the __main__ is ok), or

from ZipFiles2 import *

and then you should be able to call it.

Note: I have not tested or looked at it in detail, but a quick glance, that is how I would approach it.

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Tue, 22 Nov 2016 19:14:47 GMT

Thanks Rebecca,

.I would make RemoveAddLayer your main script, including moveing wrapping it in the '__main__" section.

So, how is this done exactly? I'm unsure where to put this and how the syntax looks. And by going this route I should also remove lines 36-42 from ZipFiles2, correct?

Re: Zip File Script & if name == 'main':

DarrenWiens2 — Tue, 22 Nov 2016 19:32:38 GMT

You don't need to include a '__main__' section in the main script (although it is good practice), nor remove the '__main__' from an imported script (I think this might actually not be good practice).

Why you don't need a '__main__' section: when you call your script, it is read from top to bottom, executing lines as it goes. If you know that script will always be the main script (i.e. not imported as a module) then it will execute as if everything was wrapped within a '__main__' section - you just skip the part where it confirms that it is indeed the main script. The problem arises when you want different behaviour between the script as run as a main script and when it's imported. Making Python scripts modular is good practice, although to be honest, I never do it.

Why you don't need to remove the '__main__' section from the imported script: since you're importing the module, it will not be named '__main__' so that section will not execute.

Re: Zip File Script & if name == 'main':

JaredPilbeam1 — Sat, 11 Dec 2021 14:19:29 GMT

Ok, thanks all! It ran.

It ran correctly after putting the '__main__' section at the bottom of the RemoveAddLayer.py and erasing it from ZipFiles2. Then, after reading your response, Darren, I put the '__main__' section back where it was in ZipFiles2 and it also ran correctly.

Here are both scripts.

#RemoveAddLayer.py

import arcpy
from arcpy import env

env.workspace = r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will"

#set path to mxd 
mxd = arcpy.mapping.MapDocument(r"Z:\Jared\Data_Request.mxd")

#reference the dataframe
for df in arcpy.mapping.ListDataFrames(mxd):
    print df
#reference the layers to be removed
    for lyr in arcpy.mapping.ListLayers(mxd, "gisedit.DBO.Address_Points", df):
        arcpy.mapping.RemoveLayer(df, lyr)
        print lyr
        for lyr in arcpy.mapping.ListLayers(mxd, "gisedit.DBO.Street", df):
            arcpy.mapping.RemoveLayer(df, lyr)
            print lyr
#reference the layers to be added
        addLayer = arcpy.mapping.Layer(r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will\gisedit.DBO.Address_Points")
        arcpy.mapping.AddLayer(df, addLayer, "TOP")
        print addLayer
        addLayer = arcpy.mapping.Layer(r"Database Connections\ims to plainfield.sde\gisedit.DBO.MGU_Will\gisedit.DBO.Street")
        arcpy.mapping.AddLayer(df, addLayer, "TOP")
        print addLayer

#address points variables to be copied/saved in folder
        inFeatures = "gisedit.DBO.Address_Points"
        outLocation = r"Z:\Jared\Python Scripts\Data"
        outFeatureClass = "WillCounty_AddressPoint"

#execute and copy/save in folder. FeatureClassToFeatureClass_conversion syntax (in_features, out_path, out_name,
#       {where_clause}, {field_mapping}, {config_keyword})
        arcpy.FeatureClassToFeatureClass_conversion(inFeatures, outLocation, outFeatureClass)
        print "finished Address_Point.shp"

#variables to be copied/saved in folder
        inFeatures = "gisedit.DBO.Street"
        outLocation = r"Z:\Jared\Python Scripts\Data"
        outFeatureClass = "WillCounty_Street"

#execute and copy/save in folder. FeatureClassToFeatureClass_conversion syntax (in_features, out_path, out_name,
#       {where_clause}, {field_mapping}, {config_keyword})
        arcpy.FeatureClassToFeatureClass_conversion(inFeatures, outLocation, outFeatureClass)
        print "finished Street.shp"

if __name__ == '__main__':

    path = r"Z:\Jared\Python Scripts\Data"
    
    out_path = r"W:\Data"

    ZipShapes(path, out_path)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

#ZipFiles2.py
#import workspace
import arcpy
import os
from arcpy import env
from os import path as p
import zipfile
arcpy.overwriteOutput = True


def ZipShapes(path, out_path):
    arcpy.env.workspace = path
    shapes = arcpy.ListFeatureClasses()

#iterate through list of shapefiles
    for shapes in shapes:
        name = p.splitext(shapes)[0]
        print name
        print shapes
        zip_path = p.join(out_path, name + '.zip')
        zip = zipfile.ZipFile(zip_path, 'w', compression=zipfile.ZIP_DEFLATED)
        zip.write(p.join(path,shapes), shapes)
        for f in arcpy.ListFiles('%s*' %name):
            if not f.endswith('.shp'):
                zip.write(p.join(path,f),f)
        print 'All file written to %s' %zip_path
        zip.close()

if __name__ == '__main__':
    
    path = r"Z:\Jared\Python Scripts\Data"
    
    out_path = r"W:\Data"

    ZipShapes(path, out_path)‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Zip File Script & if name == 'main':

RebeccaStrauch__GISP — Tue, 22 Nov 2016 20:37:15 GMT

Good info Darren. I do make a lot of my tools modular since I reuse many of the functions...and trying to keep my main program readable. I've never included a __main__ in my scripts with just a bunch of functions, but may tr i...although typically they are just a list of function definitions.

Re: Zip File Script & if name == 'main':

DanPatterson_Retired — Tue, 22 Nov 2016 22:00:06 GMT

in my post way up top, I provided a link to There are some examples in the poll discussion

topic Re: Zip File Script & if __name__ == '__main__': in Python Questions

Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

Re: Zip File Script & if __name__ == '__main__':

topic Re: Zip File Script & if name == 'main': in Python Questions

Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':

Re: Zip File Script & if name == 'main':