I have recently started learning more about Python Packages and Modules. I'm currently busy updating my existing modules so that that can be run as script or imported as a module into my other code. I'm not sure how to construct my input arguments within my module and pass them to the main() function within my module. I've have written my my main() function and called it under if __name__ == '__main__' passing the input arguments. The inputs are currently hard coded to show what I'm trying to achieve. Any help in how to correctly construct my input arguments that the user will pass, which will then be passed onto the main function will be appreciated. As mentioned I'm trying to be able to use the following as a script when used directly or imported as a module into my other code and run from there. If I import it as a module would I call the main() function when importing it? Is the following structure correct in how I have written the following? Any advice is appreciated. ''' Created on March 12, 2017 Create a new ArcHydro Schema File Geodatabase and Rasters Folder @author: PeterW ''' # import site-packages and modules import re from pathlib import Path import arcpy # set environment settings arcpy . env . overwriteOutput = True def archydro_rasters_folder ( workspace ) : """Create rasters folder directory if it doens't already exist""" model_name = Path ( workspace ) . name layers_name = re . sub ( r "\D+" , "Layers" , model_name ) layers_folder = Path ( workspace , layers_name ) if layers_folder . exists ( ) : arcpy . AddMessage ( "Rasters folder: {0} exists" . format ( layers_name ) ) else : layers_folder . mkdir ( parents = True ) arcpy . AddMessage ( "Rasters folder {0} created" . format ( layers_name ) ) def archydro_fgdb_schema ( schema , dem , workspace ) : """Create file geodatabase using XML schema and set coordinate system based on input DEM if it doesn't already exist""" model_name = Path ( workspace ) . name fgdb = "{0}.gdb" . format ( model_name ) if arcpy . Exists ( str ( Path ( workspace , fgdb ) ) ) : arcpy . AddMessage ( "{0} file geodatabase exists" . format ( fgdb ) ) else : new_fgdb = arcpy . CreateFileGDB_management ( str ( workspace ) , fgdb ) import_type = "SCHEMA_ONLY" config_keyword = "DEFAULTS" arcpy . AddMessage ( "New {0} file geodatabase created" . format ( fgdb ) ) arcpy . ImportXMLWorkspaceDocument_management ( new_fgdb , schema , import_type , config_keyword ) arcpy . AddMessage ( "ArcHydro schema imported" ) projection = arcpy . Describe ( dem ) . spatialReference projection_name = projection . PCSName feature_dataset = Path ( workspace , fgdb , "Layers" ) arcpy . DefineProjection_management ( str ( feature_dataset ) , projection ) arcpy . AddMessage ( "Changed projection to {0}" . format ( projection_name ) ) def main ( workspace , dem , schema ) : """main function to create rasters folder and file geodatabase""" archydro_rasters_folder ( workspace ) archydro_fgdb_schema ( schema , dem , workspace ) if __name__ == '__main__' : main ( workspace = r "E:\Projects\2016\01_Bertrand_Small_Projects\G113268\ArcHydro\Model04" , dem = r "E:\Projects\2016\01_Bertrand_Small_Projects\G113268\ArcHydro\DEM2\raw" , schema = r "E:\Python\Masters\Schema\ESRI_UC12\ModelBuilder\Schema\Model01.xml" )

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 pass arguments to main function in module?

PeterWilson

I have recently started learning more about Python Packages and Modules. I'm currently busy updating my existing modules so that that can be run as script or imported as a module into my other code. I'm not sure how to construct my input arguments within my module and pass them to the main() function within my module.

I've have written my my main() function and called it under if __name__ == '__main__' passing the input arguments. The inputs are currently hard coded to show what I'm trying to achieve. Any help in how to correctly construct my input arguments that the user will pass, which will then be passed onto the main function will be appreciated.

As mentioned I'm trying to be able to use the following as a script when used directly or imported as a module into my other code and run from there. If I import it as a module would I call the main() function when importing it? Is the following structure correct in how I have written the following? Any advice is appreciated.

<SPAN class="string token">'''
Created on March 12, 2017

Create a new ArcHydro Schema

File Geodatabase and Rasters

Folder

@author: PeterW
'''</SPAN>
<SPAN class="comment token"># import site-packages and modules</SPAN>
<SPAN class="keyword token">import</SPAN> re
<SPAN class="keyword token">from</SPAN> pathlib <SPAN class="keyword token">import</SPAN> Path
<SPAN class="keyword token">import</SPAN> arcpy

<SPAN class="comment token"># set environment settings</SPAN>
arcpy<SPAN class="punctuation token">.</SPAN>env<SPAN class="punctuation token">.</SPAN>overwriteOutput <SPAN class="operator token">=</SPAN> <SPAN class="token boolean">True</SPAN>


<SPAN class="keyword token">def</SPAN> <SPAN class="token function">archydro_rasters_folder</SPAN><SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">"""Create rasters folder directory
&nbsp;&nbsp;&nbsp; if it doens't already exist"""</SPAN>
&nbsp;&nbsp;&nbsp; model_name <SPAN class="operator token">=</SPAN> Path<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>name
&nbsp;&nbsp;&nbsp; layers_name <SPAN class="operator token">=</SPAN> re<SPAN class="punctuation token">.</SPAN>sub<SPAN class="punctuation token">(</SPAN>r<SPAN class="string token">"\D+"</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">"Layers"</SPAN><SPAN class="punctuation token">,</SPAN> model_name<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; layers_folder <SPAN class="operator token">=</SPAN> Path<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">,</SPAN> layers_name<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">if</SPAN> layers_folder<SPAN class="punctuation token">.</SPAN>exists<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Rasters folder: {0} exists"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>layers_name<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">else</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; layers_folder<SPAN class="punctuation token">.</SPAN>mkdir<SPAN class="punctuation token">(</SPAN>parents<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Rasters folder {0} created"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>layers_name<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>


<SPAN class="keyword token">def</SPAN> <SPAN class="token function">archydro_fgdb_schema</SPAN><SPAN class="punctuation token">(</SPAN>schema<SPAN class="punctuation token">,</SPAN> dem<SPAN class="punctuation token">,</SPAN> workspace<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">"""Create file geodatabase using XML
&nbsp;&nbsp;&nbsp; schema and set coordinate system based
&nbsp;&nbsp;&nbsp; on input DEM if it doesn't already exist"""</SPAN>
&nbsp;&nbsp;&nbsp; model_name <SPAN class="operator token">=</SPAN> Path<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>name
&nbsp;&nbsp;&nbsp; fgdb <SPAN class="operator token">=</SPAN> <SPAN class="string token">"{0}.gdb"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>model_name<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">if</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>Exists<SPAN class="punctuation token">(</SPAN>str<SPAN class="punctuation token">(</SPAN>Path<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">,</SPAN> fgdb<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"{0} file geodatabase exists"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>fgdb<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">else</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; new_fgdb <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>CreateFileGDB_management<SPAN class="punctuation token">(</SPAN>str<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">,</SPAN> fgdb<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; import_type <SPAN class="operator token">=</SPAN> <SPAN class="string token">"SCHEMA_ONLY"</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; config_keyword <SPAN class="operator token">=</SPAN> <SPAN class="string token">"DEFAULTS"</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"New {0} file geodatabase created"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>fgdb<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>ImportXMLWorkspaceDocument_management<SPAN class="punctuation token">(</SPAN>new_fgdb<SPAN class="punctuation token">,</SPAN> schema<SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; import_type<SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; config_keyword<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"ArcHydro schema imported"</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; projection <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>Describe<SPAN class="punctuation token">(</SPAN>dem<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>spatialReference
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; projection_name <SPAN class="operator token">=</SPAN> projection<SPAN class="punctuation token">.</SPAN>PCSName
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; feature_dataset <SPAN class="operator token">=</SPAN> Path<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">,</SPAN> fgdb<SPAN class="punctuation token">,</SPAN> <SPAN class="string token">"Layers"</SPAN><SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>DefineProjection_management<SPAN class="punctuation token">(</SPAN>str<SPAN class="punctuation token">(</SPAN>feature_dataset<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; projection<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; arcpy<SPAN class="punctuation token">.</SPAN>AddMessage<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Changed projection to {0}"</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>projection_name<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>


<SPAN class="keyword token">def</SPAN> <SPAN class="token function">main</SPAN><SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">,</SPAN> dem<SPAN class="punctuation token">,</SPAN> schema<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">"""main function to create rasters folder
&nbsp;&nbsp;&nbsp; and file geodatabase"""</SPAN>
&nbsp;&nbsp;&nbsp; archydro_rasters_folder<SPAN class="punctuation token">(</SPAN>workspace<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; archydro_fgdb_schema<SPAN class="punctuation token">(</SPAN>schema<SPAN class="punctuation token">,</SPAN> dem<SPAN class="punctuation token">,</SPAN> workspace<SPAN class="punctuation token">)</SPAN>


<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">'__main__'</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; main<SPAN class="punctuation token">(</SPAN>workspace <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"E:\Projects\2016\01_Bertrand_Small_Projects\G113268\ArcHydro\Model04"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; dem <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"E:\Projects\2016\01_Bertrand_Small_Projects\G113268\ArcHydro\DEM2\raw"</SPAN><SPAN class="punctuation token">,</SPAN>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; schema <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"E:\Python\Masters\Schema\ESRI_UC12\ModelBuilder\Schema\Model01.xml"</SPAN><SPAN class="punctuation token">)</SPAN>
<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>‍</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><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>‍</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>

Find more posts tagged with

Accepted answers

DanPatterson_Retired

Peter...off the top of my head.... underneath ... if __name__... you should have a call to your function... it doesn't have to be called main, I use _demo() and when I am working standalone, it will run whatever is under the if __name... line

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">runme</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; do stuff here
<SPAN class="comment token"># -------------------------------------------------------------------------</SPAN>
<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">"__main__"</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""" No demo&nbsp; """</SPAN>
&nbsp;&nbsp;&nbsp; runme<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

then if you want to import the module

<SPAN class="keyword token">from</SPAN> mypackage <SPAN class="keyword token">import</SPAN> runme‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN></SPAN>

Then you can use runme whenever you want.

To test... try something simple. But your 'runme' script should have preset arguments or sys.argv[1] of its getparameteras text equivalents. In the above example, runme doesn't need any parameters. If you want to have those to be passed or read, then you need to modify the code a bit

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">runme</SPAN><SPAN class="punctuation token">(</SPAN>input_featureclass<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; do stuff here
<SPAN class="comment token"># -------------------------------------------------------------------------</SPAN>
<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">"__main__"</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""" No demo&nbsp; """</SPAN>
&nbsp;&nbsp;&nbsp; in_fc <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"\c:temp\something"</SPAN>
&nbsp;&nbsp;&nbsp; runme<SPAN class="punctuation token">(</SPAN>input_featureclass<SPAN class="operator token">=</SPAN>in_fc<SPAN class="punctuation token">)</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

then when you call runme from your main program it would be

runme(in_fc) or runme(sys.argv[1]) or runme(GetParameterAsText(0))

give it a shot

All comments

PeterWilson

Hi Joshua,

Thanks so much for your suggestions, I'll have a look at the following links that you have provided and post my completed code afterwards.

JoshuaBixby

If you are going to the effort to formalize modules and create packages, I encourage you to review the PEP 8 -- Style Guide for Python Code. There are suggested naming conventions for functions, modules, packages, and more. It would be a shame to put all this effort in and have it be difficult for others to read or maintain.

Looking at the PEP 8 Naming Conventions:

Overriding Principle
Names that are visible to the user as public parts of the API should follow conventions that reflect usage rather than implementation.

Looking at your code specifically, a name like main() is reflecting the implementation and not the usage or purpose of a function.

In terms of understanding the role of if __name__ == '__main__': , I encourage you to peruse the Command line and environment documentation if you haven't already. Also, there is a good discussion on the topic at StackOverflow: What does if __name__ == "__main__": do?<BR />

PeterWilson

Thanks Dan for all your help, I'll post my code once completed, that it might help others.

DanPatterson_Retired

I would assume that you would pass that to the called

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">runme</SPAN><SPAN class="punctuation token">(</SPAN>folder<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; 
&nbsp;&nbsp;&nbsp; may_return_stuff <SPAN class="operator token">=</SPAN> da_func1<SPAN class="punctuation token">(</SPAN>folder<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; big_output <SPAN class="operator token">=</SPAN> da_func2<SPAN class="punctuation token">(</SPAN>folder<SPAN class="punctuation token">,</SPAN> may_return_stuff<SPAN class="punctuation token">)</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="keyword token">return</SPAN> big_output

<SPAN class="comment token"># -------------------------------------------------------------------------</SPAN>
<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">"__main__"</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""" No demo&nbsp; """</SPAN>
&nbsp;&nbsp;&nbsp; folder <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"\c:temp\something"</SPAN>
&nbsp;&nbsp;&nbsp; runme<SPAN class="punctuation token">(</SPAN>in_folder<SPAN class="operator token">=</SPAN>folder<SPAN class="punctuation token">)</SPAN><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>

you import, use runme, which requires a folder which you pass to it, da_func1 need the folder to do stuff. Then da)func2, needs the result of da_func1 as well as the folder. play with a simple example and don't try to do it with your 'real' scripts/module until you get the flow you want, then emulate what works.

PeterWilson

Hi Dan

Thanks for the following, how would I set up the input arguments that need to be passed into my main() function. The reason I'm asking is that I'm calling two functions that both use the same input argument workspace.

DanPatterson_Retired

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">runme</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; do stuff here
<SPAN class="comment token"># -------------------------------------------------------------------------</SPAN>
<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">"__main__"</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""" No demo&nbsp; """</SPAN>
&nbsp;&nbsp;&nbsp; runme<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

then if you want to import the module

<SPAN class="keyword token">from</SPAN> mypackage <SPAN class="keyword token">import</SPAN> runme‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN></SPAN>

Then you can use runme whenever you want.

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">runme</SPAN><SPAN class="punctuation token">(</SPAN>input_featureclass<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; do stuff here
<SPAN class="comment token"># -------------------------------------------------------------------------</SPAN>
<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">"__main__"</SPAN><SPAN class="punctuation token">:</SPAN>
&nbsp;&nbsp;&nbsp; <SPAN class="string token">""" No demo&nbsp; """</SPAN>
&nbsp;&nbsp;&nbsp; in_fc <SPAN class="operator token">=</SPAN> r<SPAN class="string token">"\c:temp\something"</SPAN>
&nbsp;&nbsp;&nbsp; runme<SPAN class="punctuation token">(</SPAN>input_featureclass<SPAN class="operator token">=</SPAN>in_fc<SPAN class="punctuation token">)</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

then when you call runme from your main program it would be

runme(in_fc) or runme(sys.argv[1]) or runme(GetParameterAsText(0))

give it a shot

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

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