Is it pythonic to import inside functions?

One thing to bear in mind: needless imports can cause performance problems. So if this is a function that will be called frequently, you're better off just putting the import at the top. Of course this is an optimization, so if there's a valid case to be made that importing inside a function is more clear than importing at the top of a file, that trumps performance in most cases.

If you're doing IronPython, I'm told that it's better to import inside functions (since compiling code in IronPython can be slow). Thus, you may be able to get a way with importing inside functions then. But other than that, I'd argue that it's just not worth it to fight convention.

As a general rule, I do this if there is an import that is only used within a single function.

Another point I'd like to make is that this may be a potential maintenence problem. What happens if you add a function that uses a module that was previously used by only one function? Are you going to remember to add the import to the top of the file? Or are you going to scan each and every function for imports?

FWIW, there are cases where it makes sense to import inside a function. For example, if you want to set the language in cx_Oracle, you need to set an NLS_LANG environment variable before it is imported. Thus, you may see code like this:

import os

oracle = None

def InitializeOracle(lang):
    global oracle
    os.environ['NLS_LANG'] = lang
    import cx_Oracle
    oracle = cx_Oracle

There are two occasions where I violate PEP 8 in this regard:

Circular imports: module A imports module B, but something in module B needs module A (though this is often a sign that I need to refactor the modules to eliminate the circular dependency)
Inserting a pdb breakpoint: import pdb; pdb.set_trace() This is handy b/c I don't want to put import pdb at the top of every module I might want to debug, and it easy to remember to remove the import when I remove the breakpoint.

Outside of these two cases, it's a good idea to put everything at the top. It makes the dependencies clearer.

In the long run I think you'll appreciate having most of your imports at the top of the file, that way you can tell at a glance how complicated your module is by what it needs to import.

If I'm adding new code to an existing file I'll usually do the import where it's needed and then if the code stays I'll make things more permanent by moving the import line to the top of the file.

One other point, I prefer to get an ImportError exception before any code is run -- as a sanity check, so that's another reason to import at the top.

I use pyChecker to check for unused modules.

Here are the four import use cases that we use

import (and from x import y and import x as y) at the top

Choices for Import. At the top.

import settings
if setting.something:
    import this as foo
else:
    import that as foo

Conditional Import. Used with JSON, XML libraries and the like. At the top.
```
try:
    import this as foo
except ImportError:
    import that as foo
```
Dynamic Import. So far, we only have one example of this.
```
import settings
module_stuff = {}
module= __import__( settings.some_module, module_stuff )
x = module_stuff['x']
```
Note that this dynamic import doesn't bring in code, but brings in complex data structures written in Python. It's kind of like a pickled piece of data except we pickled it by hand.

This is also, more-or-less, at the top of a module

Here's what we do to make the code clearer:

Keep the modules short.
If I have all my imports at the top of the module, I have to go look there to determine what a name is. If the module is short, that's easy to do.
In some cases having that extra information close to where a name is used can make the function easier to understand. If the module is short, that's easy to do.

Is it pythonic to import inside functions?

Tags:

Python

Conventions

Related

Recent Posts