How do I find the modules that are available for import from within a package?

Question

Is there a way of knowing which modules are available to import from inside a package?

score 3 · Accepted Answer · edited May 23 '17 at 12:19

3

Many packages will include a list called __all__, which lists the member modules. This is used when python does from x import *. You can read more about that here.

If the package does not define __all__, you'll have to do something like the answer to a question I asked earlier, here.

edited May 23 '17 at 12:19

Community

1
1

answered Mar 18 '09 at 11:35

DNS

37,249
18
95
132

score -1 · Answer 2 · answered Mar 18 '09 at 12:57

-1

You have the source.

Look at the files inside the package directory. Those modules are available for you to import.

answered Mar 18 '09 at 12:57

S.Lott

384,516
81
508
779

There are many ways for there to be files inside the package (a directory) which are *not* modules available for import. The Python import mechanism knows the difference, so it seems reasonable for it to expose that functionality rather than having everyone re-invent it. – bignose Jan 29 '10 at 12:16

score -1 · Answer 3 · answered Mar 18 '09 at 19:08

dir([object]);

Without arguments, dir() return the list of names in the current local scope. With an argument, attempt to return a list of valid attributes for that object.

So, in the case of a module, such as 'sys':

>>> import sys
>>> dir(sys)
['__displayhook__', '__doc__', '__excepthook__', '__name__', '__stderr__', '__stdin__', '__stdout__', '_current_frames', '_getframe', 'api_version', 'argv', 'builtin_module_names', 'byteorder', 'call_tracing', 'callstats', 'copyright', 'displayhook', 'exc_clear', 'exc_info', 'exc_type', 'excepthook', 'exec_prefix', 'executable', 'exit', 'getcheckinterval', 'getdefaultencoding', 'getdlopenflags', 'getfilesystemencoding', 'getrecursionlimit', 'getrefcount', 'hexversion', 'maxint', 'maxunicode', 'meta_path', 'modules', 'path', 'path_hooks', 'path_importer_cache', 'platform', 'prefix', 'ps1', 'ps2', 'pydebug', 'setcheckinterval', 'setdlopenflags', 'setprofile', 'setrecursionlimit', 'settrace', 'stderr', 'stdin', 'stdout', 'subversion', 'version', 'version_info', 'warnoptions']

That's all there is to it.

That lists all attributes, not just sub-modules, so it doesn't answer the question. — bignose, Jan 29 '10 at 12:18

score -2 · Answer 4 · answered Mar 18 '09 at 11:51

-2

import fred

print dir(fred)

answered Mar 18 '09 at 11:51

Phil

4,377
3
21
10

That lists all attributes, not just sub-modules, so it doesn't answer the question. – bignose Jan 29 '10 at 12:17

How do I find the modules that are available for import from within a package?

4 Answers4