Skip to main content

Automatically manage __all__ variable in Python packages.

Project description

Automatically manage the __all__ variable in Python modules.

pypi package build status downloads GitHub last commit GitHub GitHub stars

Overview

auto_all can be used for controlling what is made available for import from a Python module.

Advantages:

  • Easily populate the __all__ variable in modules.
  • Easily exclude imported objects
  • Clearly differentiate between internal and external facing objects.
  • Use simple, intuitive code.
  • Never worry about forgetting to add new objects to __all__.
  • Help Python IDE’s differentiate between internal and external facing objects.

Installation

pip install auto-all

Usage

First, import the auto_all functions into your module.

from auto_all import start_all, end_all

If your module has external dependencies then these can be imported and the imported objects can be hidden. In this example we will import pathlib.Path and show that it doesn’t appear on the __all__ list. We’re not actually going to use this import, it’s just for illustration.

from pathlib import Path

Now we can define some internal functions that we want to keep private. We can also do this using underscore prefixes, but auto_all gives us a little more granular control.

def a_private_function():
    print("This is a private function.")

Now we are ready to start defining public functions, so we use start_all(). We need to pass it the globals dict so that it can see what’s already defined.

start_all(globals())

Now we can define our public functions.

def a_public_function():
    print("This is a public function.")

Finally we use end_all() to finish defining public functions and create the __all__ variable.

end_all(globals())

When we look at the __all__ variable we can see only the public facing objects are listed.

>>> print(__all__)
['a_public_function']

Putting this all together, your module should look something like this:

from auto_all import start_all, end_all

from pathlib import Path

def a_private_function():
    print("This is a private function.")

start_all(globals())

def a_public_function():
    print("This is a public function.")

end_all(globals())

Project details


Download files

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

Files for auto-all, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size auto_all-1.3.0-py2.py3-none-any.whl (4.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size auto-all-1.3.0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page