Skip to main content

Finding imports in code

Project description

unbox

Finding imports in code

To install: pip install unbox

What's here

Lots of little goodies to help you analyze the imports of your, or others' code.

A dict-like interface

The base of unbox is just the dol interface to findimports, which then allows us to offer a bunch of functionalities easily.

Say you wanted to know what dol was made of. The dol way of doing this is to make a Mapping (i.e. a key-value dict-like interface), and then do what you do with dicts...

>>> import dol
>>> import unbox
>>> s = unbox.ModuleNamesImportedByModule(dol)  # make a store containing the modules of the `dol` package
>>> # Now wee how you can do things you do with dicts
>>> len(s)
15
>>> list(s)
['dol.__init__',
 'dol.appendable',
 'dol.base',
 'dol.caching',
 'dol.core',
 'dol.dig',
 'dol.errors',
 'dol.filesys',
 'dol.mixins',
 'dol.naming',
 'dol.paths',
 'dol.signatures',
 'dol.sources',
 'dol.trans',
 'dol.util']
>>> 'dol.appendable' in s
>>> # The values of `s` are sets of modules imported by a module.
>>> s['dol.appendable']  # what does dol.appendable import?
{'collections.abc', 'dol.trans', 'time', 'types', 'typing'}

Check out ModulesImportedByModule also, which gives you a Mapping with module objects as keys, and findimports.ImportInfo instances as values.

imports_for

As an example of what you can do with this set up, have a look at imports_for. Or don't have a look; just use it, since it's quite useful.

from unbox import imports_for 
import wave
assert imports_for(wave) == {'warnings', 'builtins', 'sys', 'audioop', 'chunk', 'struct', 'collections'}

At it's base, imports_for gives you a generator of import names. With the post argument (defaulted to set) you can specify a callable that can produce the output you want; whether you want to filter the items, count them, order them, etc.

We curried a few common ones for you, for your convenience:

from unbox import imports_for
imports_for.counter  # imported names and their counts
imports_for.most_common  # imported names and their counts, ordered by most common
imports_for.first_level  # set for imported first level names (e.g. 'os' instead of 'os.path.etc.)
imports_for.first_level_count  # count of imported first level names (e.g. 'os' instead of 'os.path.etc.)
imports_for.third_party  # imported (first level) names that are not builtin names (most probably third party packages)"

Collections of python names

Check out the contents of these collections:

from unbox import (
    builtin_module_names,
    scanned_standard_lib_names,
    all_accessible_modules,
    all_accessible_pkg_names,
    all_accessible_non_pkg_module_names,
    builtin_obj_names,
    python_names
)

For example, builtin_module_names will be a set of names that are documented and importable on your system.

The scanned_standard_lib_names set is similar, but the names are obtained by scanning the local standard library file names -- so include things like easter eggs (this, antigravity).

all_accessible_modules will be the list of all modules accessible in your python path.

And so on...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unbox-0.0.18.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

unbox-0.0.18-py3-none-any.whl (30.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page