python-import-guardian

Release 0.2.2

A static-analysis Python import guardian.

Homepage PyPI

Keywords
import, guardian, static-analysis, imports, lint, python
License
MIT
Install
pip install python-import-guardian==0.2.2

Documentation

Python Import Guardian README

What is it?

python-import-guardian is a static-analysis import guardian for Python. It can be used to control explictly which Python modules and packages can be imported by a given set of modules and packages in your project.

When is this useful?

Let's say you have a project with two major components — a client and a server. Both of these components live in the same repository (for the sake of argument) and both use a common set of shared code for various functions — for example to determine how certain hashes are calculated or some such.

The code may be laid out thus:

    /myproject
      |
      |- client/
      |- server/
      |- shared/

Conceptually, you only ever want client and shared code to be installed on client machines and server and shared code on server machines. Modules in client and server may import from shared, but not from each other, and shared may import from neither — this ensures that you have a good separation of concerns between client and server code whilst maintaining some shared code and good DRY principles.

python-import-guardian allows you to define how you want these modules to relate to each other when it comes to which module can import what from where. For our example project, a simple importguardian.json file at the top of the project tree might look like this:

    {
        "forbidden_modules": {
            "server": {
                "forbidden_from": [
                    "client",
                    "shared"
                ]
            },
            "client": {
                "forbidden_from": [
                    "server",
                    "shared"
                ]
            }
        }
    }

The forbidden_modules declaration here maps Python modules to a list of the modules or packages which may not import them. So in this case: server may not be imported by client or shared, and client may not be imported by server or shared. forbidden_modules is a deny-list, so shared can be imported by anything because it isn't mentioned as a forbidden module.

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
8
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
6

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.2.2
0.2.1
0.1.3
0.1.1
0.1
0.0.3
0.0.2
0.0.1

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2022-04-29 22:15:49 UTC

Login to resync this project