Do I need to import submodules directly?

Question

Let's say I have a module foo and a submodule foo.bar. If I want to use a method in foo.bar, do I need to import foo.bar directly or is importing foo sufficient?

For example, the following throws an error:

import foo

foo.bar.my_method()

and the following works:

import foo.bar

foo.bar.my_method()

But I'm not sure if this is generally what's needed, or if there's something wrong with my code itself. (I would think importing the submodule directly is generally needed... But I could have sworn I've seen code where it's not imported directly and still works fine.)

wim · Accepted Answer · 2018-04-04 02:31:28Z

20

If I want to use a method in foo.bar, do I need to import foo.bar directly or is importing foo sufficient?

You'll need to import the submodule explicitly. Executing import foo.bar will automatically import the parent module foo, and necessarily^† bind the name foo, but the reverse is not true.

But I could have sworn I've seen code where it's not imported directly and still works fine

Yes. Sometimes accessing a submodule works without the explicit import. This happens when a parent module itself imports the submodules. Never rely on that unless it's documented, because it may be an implementation detail and could change without warning after a library version upgrade.

As an example of a popular library which demonstrates both behaviors, look at requests==2.18.4. This package has submodules called sessions and help (amongst others). Importing requests will make requests.sessions available implicitly, yet requests.help will not be available until explicitly imported. You'll find when the source code of the package init is executed that the sessions submodule gets imported, but the help submodule does not.

^† _{This makes sense, because subsequent use of foo.bar requires an attribute access on an existing foo object. Note that from foo.bar import something does not bind the name foo nor foo.bar, though both modules foo and foo.bar are imported and cached into sys.modules.}

edited Apr 4, 2018 at 2:31

answered Apr 4, 2018 at 2:07

wim

370k115 gold badges686 silver badges824 bronze badges

Sign up to request clarification or add additional context in comments.

Joe Over a year ago

Oh, super helpful, thanks! In the __init__.py you linked to, what's the reason for from .sessions import session, Session if those imports aren't used in the __init__.py file directly? Just to make it so that importing requests.sessions isn't absolutely necessary?

wim Over a year ago

This is likely a convenience - pulling names up into the parent namespace. Library users can now write an import statement from requests import Session, that's shorter yet equivalent to from requests.sessions import Session.

Collectives™ on Stack Overflow

Do I need to import submodules directly?

1 Answer 1

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related