Nesting multiple modules within a module in script?

Question

Hi,

Just a simple question, is it possible to have multiple python modules nested within a python module? I am working on a script tool and I was thinking of nesting multiple modules within a module, but I just wanted to check to see if this is either frowned upon when it comes to scripting or if there is some other reason not to do it.

RPGIS · Answer

hi @Luke_Pinner,

I was simply asking out of curiosity. I wasn't necessarily planning on going in that direction without checking with someone who is more knowledgeable than I. I am glad that the documentation that you provided outlined the different setups in regards to namespaces. I am relatively new to scripting functions and classes, so I do not have quite a strong grasp of such concepts.

I will have to do some more research to figure out which direction would be best to take as well as experiment to see how script will behave.

There is still a lot of material in regards to all of the intricacies and functionalities of python as it pertains to GIS. I am still trying to learn what is best practice and I check with the community frequently when I don't fully understand something.

Luke_Pinner · Answer

@RPGIS wrote:Ok so, if I understand this correctly, is that a script and module are technically one in the same and that nesting multiple modules is not possible.

Yes a script and module are both just a single python file, it's more a matter of convention that scripts contain code that gets executed and modules usually just contains functions, classes and constants that are imported by other modules and scripts.

@RPGIS wrote:However, nesting multiple classes is possible. Here is what I was originally thinking.

def sample(a):
    b = a
    return b

def example(c):
        c = l
        # do something
        return c

That is a function with a nested function, not a class.  What you have there will not work. The example function can only be called from within the sample function but you return a from the sample funcction without doing anything with the example function.

Try and run that example and call example('something') you'll get a NameError: name 'example' is not defined

I think you should read up on "namespaces" before you start trying this sort of thing.

RPGIS · Answer

Ok so, if I understand this correctly, is that a script and module are technically one in the same and that nesting multiple modules is not possible. However, nesting multiple classes is possible. Here is what I was originally thinking.

def sample(a):
    b = a
    return b

def example(c):
        c = l
        # do something
        return c

If something like this isn't necessarily proper, but setting these to classes instead of modules is then I will give that a try. I was trying to figure out the best approach since I am trying to create a custom tool(s) for my department to utilize in the web. So far, the tool seems to work perfectly without nesting anything additional, but I was simply curious is all.