I know there's a ton of other material here and @ SE regarding this subject, but conceptually i'm just stuck. In an effort to improve the modularity of my code, I'm trying to get better at importing existing functions into scripts. I'm stuck on successfully passing arguments captured within the script to the imported module. Ideally I just want to use the script and pass it a handful of client identifiers (arguments) and have those cascade down into several modules called up in the script. Like: functiontest2('identifier') some crude code: functiontest2.py from HarvestTable import HarvestTableReport import sys HarvestThing = sys . argv [ 1 ] HarvestTableReport ( HarvestThing ) HarvestTable.py import numpy as np import pandas as pd import arcpy def HarvestTableReport ( HarvestID ) : table = "\\\\fileshare\SDE_CONNECTIONS\\LV_NEXUS.sde\\LV_NEXUS.DATAOWNER.NORTHEAST\\clientGDB.featureclass" HUID = HarvestID whereClause = """ "LV_HARVEST_UNIT_ID" = '{0}' """ . format ( HUID ) tableArray = arcpy . da . TableToNumPyArray ( table , [ 'SUPER_TYPE' , 'STRATA' , 'OS_TYPE' , 'STAND_NUMB' , 'SILV_PRES' , 'ACRES' ] , where_clause = whereClause ) df = round ( pd . DataFrame ( tableArray ) , 1 ) report = df . groupby ( [ 'SUPER_TYPE' ] ) . apply ( lambda sub_df : sub_df . pivot_table ( index = [ 'STRATA' , 'OS_TYPE' , 'STAND_NUMB' , 'SILV_PRES' ] , values = [ 'ACRES' ] , aggfunc = np . sum , margins = True , margins_name = 'TOTAL' ) ) # this is creating a new row at level(1) called grand total # set it equal to the sum of ACRES where level(1) != 'Total' so you are not counting the calculated totals in the total sum report . loc [ ( '' , 'GRAND TOTAL' , '' , '' , '' ) , : ] = report [ report . index . get_level_values ( 1 ) != 'TOTAL' ] . sum ( ) print ( whereClause ) return np . round ( report , 1 ) if __name__ == '__main__' : HarvestTableReport ( )

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 function in module?

ZacharyHart

I know there's a ton of other material here and @ SE regarding this subject, but conceptually i'm just stuck. In an effort to improve the modularity of my code, I'm trying to get better at importing existing functions into scripts. I'm stuck on successfully passing arguments captured within the script to the imported module. Ideally I just want to use the script and pass it a handful of client identifiers (arguments) and have those cascade down into several modules called up in the script. Like: functiontest2('identifier')

some crude code:

functiontest2.py

<SPAN class="keyword token">from</SPAN> HarvestTable <SPAN class="keyword token">import</SPAN> HarvestTableReport
<SPAN class="keyword token">import</SPAN> sys
HarvestThing <SPAN class="operator token">=</SPAN> sys<SPAN class="punctuation token">.</SPAN>argv<SPAN class="punctuation token">[</SPAN><SPAN class="number token">1</SPAN><SPAN class="punctuation token">]</SPAN>

HarvestTableReport<SPAN class="punctuation token">(</SPAN>HarvestThing<SPAN class="punctuation token">)</SPAN>
‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

HarvestTable.py

<SPAN class="keyword token">import</SPAN> numpy <SPAN class="keyword token">as</SPAN> np
<SPAN class="keyword token">import</SPAN> pandas <SPAN class="keyword token">as</SPAN> pd
<SPAN class="keyword token">import</SPAN> arcpy
    
<SPAN class="keyword token">def</SPAN> <SPAN class="token function">HarvestTableReport</SPAN><SPAN class="punctuation token">(</SPAN>HarvestID<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
    table <SPAN class="operator token">=</SPAN> <SPAN class="string token">"\\\\fileshare\SDE_CONNECTIONS\\LV_NEXUS.sde\\LV_NEXUS.DATAOWNER.NORTHEAST\\clientGDB.featureclass"</SPAN>
    HUID <SPAN class="operator token">=</SPAN> HarvestID
    whereClause <SPAN class="operator token">=</SPAN> <SPAN class="string token">""" "LV_HARVEST_UNIT_ID" = '{0}' """</SPAN><SPAN class="punctuation token">.</SPAN>format<SPAN class="punctuation token">(</SPAN>HUID<SPAN class="punctuation token">)</SPAN>
    tableArray <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>da<SPAN class="punctuation token">.</SPAN>TableToNumPyArray<SPAN class="punctuation token">(</SPAN>table<SPAN class="punctuation token">,</SPAN> <SPAN class="punctuation token">[</SPAN><SPAN class="string token">'SUPER_TYPE'</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">'STRATA'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'OS_TYPE'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'STAND_NUMB'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'SILV_PRES'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'ACRES'</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN> where_clause <SPAN class="operator token">=</SPAN> whereClause<SPAN class="punctuation token">)</SPAN>
    df <SPAN class="operator token">=</SPAN> round<SPAN class="punctuation token">(</SPAN>pd<SPAN class="punctuation token">.</SPAN>DataFrame<SPAN class="punctuation token">(</SPAN>tableArray<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="number token">1</SPAN><SPAN class="punctuation token">)</SPAN>
    report <SPAN class="operator token">=</SPAN> df<SPAN class="punctuation token">.</SPAN>groupby<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">[</SPAN><SPAN class="string token">'SUPER_TYPE'</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>apply<SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">lambda</SPAN> sub_df<SPAN class="punctuation token">:</SPAN>  sub_df<SPAN class="punctuation token">.</SPAN>pivot_table<SPAN class="punctuation token">(</SPAN>index<SPAN class="operator token">=</SPAN><SPAN class="punctuation token">[</SPAN><SPAN class="string token">'STRATA'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'OS_TYPE'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'STAND_NUMB'</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'SILV_PRES'</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN> values<SPAN class="operator token">=</SPAN><SPAN class="punctuation token">[</SPAN><SPAN class="string token">'ACRES'</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">,</SPAN>aggfunc<SPAN class="operator token">=</SPAN>np<SPAN class="punctuation token">.</SPAN>sum<SPAN class="punctuation token">,</SPAN> margins<SPAN class="operator token">=</SPAN><SPAN class="token boolean">True</SPAN><SPAN class="punctuation token">,</SPAN>margins_name<SPAN class="operator token">=</SPAN> <SPAN class="string token">'TOTAL'</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
    <SPAN class="comment token"># this is creating a new row at level(1) called grand total</SPAN>
    <SPAN class="comment token"># set it equal to the sum of ACRES where level(1) != 'Total' so you are not counting the  calculated totals in the total sum</SPAN>
    report<SPAN class="punctuation token">.</SPAN>loc<SPAN class="punctuation token">[</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">''</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="string token">'GRAND TOTAL'</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">''</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">''</SPAN><SPAN class="punctuation token">,</SPAN><SPAN class="string token">''</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="punctuation token">:</SPAN><SPAN class="punctuation token">]</SPAN> <SPAN class="operator token">=</SPAN> report<SPAN class="punctuation token">[</SPAN>report<SPAN class="punctuation token">.</SPAN>index<SPAN class="punctuation token">.</SPAN>get_level_values<SPAN class="punctuation token">(</SPAN><SPAN class="number token">1</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">!=</SPAN> <SPAN class="string token">'TOTAL'</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">.</SPAN>sum<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
    <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN>whereClause<SPAN class="punctuation token">)</SPAN>
    <SPAN class="keyword token">return</SPAN> np<SPAN class="punctuation token">.</SPAN>round<SPAN class="punctuation token">(</SPAN>report<SPAN class="punctuation token">,</SPAN><SPAN class="number token">1</SPAN><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>
    HarvestTableReport<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>‍</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>

Encuentra más publicaciones etiquetadas con

Accepted answers

JoshuaBixby

The line

HarvestThing <SPAN class="">=</SPAN> sys<SPAN class="">.</SPAN>argv<SPAN class="">[</SPAN><SPAN class="">1</SPAN><SPAN class="">]</SPAN>

is saying to take the first command line argument and pass it to HarvestThing. Since you are importing the module and not calling it from the command line with arguments, you are getting an IndexError.

All comments

ZacharyHart

It's my understanding that when you call a second script from a first script, __name__ = main in the first script but not in the second script: __name__ = the script name itself (sans .py extension) and both of them need to be in the same directory.

This right here is something I really need to get my head around! I keep getting confused on this.

LukeWebb

You are basically there and its looking good!

Im probably using incorrect concepts for advanced/correct coding, but I like to keep it simpler!

What you have basically created in your file functiontest2.py is what I like to call an interface or GUI.

I would rename this file:

harvest_report_commandline.py

<SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">from</SPAN> HarvestTable <SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">import</SPAN> HarvestTableReport
<SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">import</SPAN> sys
HarvestThing <SPAN class="" style="color: #a67f59; background: rgba(255, 255, 255, 0.5); border: 0px; font-weight: inherit;">=</SPAN> sys<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">.</SPAN>argv<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">[</SPAN><SPAN class="" style="color: #990000; border: 0px; font-weight: inherit;">1</SPAN><SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">]</SPAN>

HarvestTableReport<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">(</SPAN>HarvestThing<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">)</SPAN>

Now to run this, you run it from cmd as you are probably familiar, passing in the sys argument.

Often, I would then make another interface/gui file, so that I can easily test it inside an IDE. Something like this:

harvest_report_python.py

<SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">from</SPAN> HarvestTable <SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">import</SPAN> HarvestTableReport

HarvestThing <SPAN class="" style="color: #a67f59; background: rgba(255, 255, 255, 0.5); border: 0px; font-weight: inherit;">=</SPAN> 'MY ID'
HarvestTableReport<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">(</SPAN>HarvestThing<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">)</SPAN>

Further down the line, I would also make a .tbx file, so it works inside arcmap as a toolbox! Something like:

harvest_report_ArcTool.py

class harvestArcToolGUI(object):

    def __init__(self):
        self.label = 'Harvest Report'
        self.description = 'Get your report here!'

        self.parameters = [
            parameter('Harvest ID', 'HarvestID', 'String'),
        ]

    def execute(self, parameters, messages):
        '''
        Reference the business logic captured in your object defined
        separately in the module, preferably above.
        '''

        inHarvestID = parameters[0].value

        ###Tool Logic

        execTool = HarvestTable.HarvestTableReport (inHarvestID)

        return







Now, if you make changes to the orginal HarvestTable.py,    all the other interfaces will be running the updated code.

ZacharyHart

ok, that makes way more sense and I had success using the python cmd prompt and supplying an arrangement. thanks so much!

So is there a way to run a script from the interactive python window, or is my solution more like creating a master module that just calls up a bunch of my other single-purpose modules? Let me try to explain what I'm hoping to achieve. Often while working along in Pro (although I could be doing the same in Jupyter Lab I guess) I want to pull some info for a given client or property. So each module might have a single function that generates a report. Rather than run each module, I want to run all of them in one script/master module. The only argument that needs to be passed to each module is like a client identifier so this should be pretty straightforward. I'd prefer to not have to jump out to the python command prompt but also don't want the overhead of rolling these up into a script tool in a Pro toolbox.

JoeBorgione

If I understand it correctly, you want to call a script from another, passing variables set up in the first script? If so, here is the basic template with which to do so.

<SPAN class="comment token"># -*- coding: utf-8 -*-</SPAN>
<SPAN class="string token">"""
Created on Thu May 16 14:20:43 2019
@author: JBorgione
save  this as script1.py
"""</SPAN>
var1 <SPAN class="operator token">=</SPAN> <SPAN class="string token">'A'</SPAN>
var2 <SPAN class="operator token">=</SPAN> <SPAN class="string token">'B'</SPAN>
var3 <SPAN class="operator token">=</SPAN> <SPAN class="string token">'C'</SPAN>

<SPAN class="keyword token">import</SPAN> Script2‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<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 class="comment token"># -*- coding: utf-8 -*-</SPAN>
<SPAN class="string token">"""
Created on Thu May 16 14:31:01 2019
@author: JBorgione
script2.py  is called from script1.py
"""</SPAN> 
<SPAN class="keyword token">from</SPAN> __main__ <SPAN class="keyword token">import</SPAN> <SPAN class="operator token">*</SPAN>

<SPAN class="keyword token">def</SPAN> <SPAN class="token function">main</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN> 
    <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN>var3<SPAN class="punctuation token">)</SPAN> 
    <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN>var2<SPAN class="punctuation token">)</SPAN> 
    <SPAN class="keyword token">print</SPAN><SPAN class="punctuation token">(</SPAN>var1<SPAN class="punctuation token">)</SPAN> 

<SPAN class="keyword token">if</SPAN> __name__ <SPAN class="operator token">==</SPAN> <SPAN class="string token">'Script2'</SPAN><SPAN class="punctuation token">:</SPAN> 
    main<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>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

It's my understanding that when you call a second script from a first script, __name__ = main in the first script but not in the second script: __name__ = the script name itself (sans .py extension) and both of them need to be in the same directory.

See a post of mine earlier this spring which directs you to this site

JoshuaBixby

The line

HarvestThing <SPAN class="">=</SPAN> sys<SPAN class="">.</SPAN>argv<SPAN class="">[</SPAN><SPAN class="">1</SPAN><SPAN class="">]</SPAN>

ZacharyHart

I've had so many different tweaks to this it's been hard to keep track (kinda banging my head against the wall here). In the current permutation shown above if I attempt to import functiontest2 into the python window in Pro I receive the following error:

Traceback <SPAN class="punctuation token">(</SPAN>most recent call last<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
  File <SPAN class="string token">"<string>"</SPAN><SPAN class="punctuation token">,</SPAN> line <SPAN class="number token">1</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">in</SPAN> <SPAN class="operator token"><</SPAN>module<SPAN class="operator token">></SPAN>
  File <SPAN class="string token">"\\fileshare\SCRIPTS\functiontest2.py"</SPAN><SPAN class="punctuation token">,</SPAN> line <SPAN class="number token">3</SPAN><SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">in</SPAN> <SPAN class="operator token"><</SPAN>module<SPAN class="operator token">></SPAN>
    HarvestThing <SPAN class="operator token">=</SPAN> sys<SPAN class="punctuation token">.</SPAN>argv<SPAN class="punctuation token">[</SPAN><SPAN class="number token">1</SPAN><SPAN class="punctuation token">]</SPAN>
IndexError<SPAN class="punctuation token">:</SPAN> list index out of range<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

JoshuaBixby

So what errors or unexpected behaviors are you getting? If errors, please post specific errors with traceback. If unexpected results, please post what you expect and what you are actually getting.

DanPatterson_Retired

line 5, first script... you passed to the imported function, and it tried to return something, but you didn't do anything with it

i_m_Back = HarvestTableReport(HarvestThing) # ---- returned from your imported

print("Returned to you {}".format(i_m_Back))<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Únete a la Conversación

Los miembros registrados pueden publicar, seguir actualizaciones y más. ¿Nuevo aquí? Regístrate gratis.

Enlaces Rápidos

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