Is it pythonic to import inside functions?

PEP 8 says:

• Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants.

On occation, I violate PEP 8. Some times I import stuff inside functions. As a general rule, I do this if there is an import that is only used within a single function.

Any opinions?

EDIT (the reason I feel importing in functions can be a good idea):

Main reason: It can make the code clearer.

• When looking at the code of a function I might ask myself: "What is function/class xxx?" (xxx being used inside the function). If I have all my imports at the top of the module, I have to go look there to determine what xxx is. This is more of an issue when using from m import xxx. Seeing m.xxx in the function probably tells me more. Depending on what m is: Is it a well-known top-level module/package (import m)? Or is it a sub-module/package (from a.b.c import m)?
• In some cases having that extra information ("What is xxx?") close to where xxx is used can make the function easier to understand.

Solution 1:

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.

Solution 2:

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.

Solution 3:

Here are the four import use cases that we use

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

2. Choices for Import. At the top.

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

3. Conditional Import. Used with JSON, XML libraries and the like. At the top.

   try:
       import this as foo
   except ImportError:
       import that as foo
   

4. 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.