@export decorator that adds a function or class to __all__
Project description
Explicit module exports
Installation
Requires python>=3.8
pip install exports
Usage
>>> from exports import export
Now you can use it to add to __all__
as
-
function decorator
>>> @export ... def spam(): ... ...
-
class decorator:
>>> @export ... class Ham: ... ...
-
by name:
>>> from functools import reduce as fold >>> export('fold')
Behaviour
If the module has no all, it is created.
Otherwise, __all__
is converted to a list, and the export is appended.
Caveats
Exporting a function or class directly relies on the name attribute, so consider the following example:
>>> def eggs():
... ...
>>> fake_eggs = eggs
If we want to export fake_eggs, then this will not work:
>>> export(fake_eggs) # BAD: this will add 'eggs' to __all__
In such cases, use the name instead:
>>> export('fake_eggs') # GOOD
You'll be safe if you either
- decorate a function or a class directly with
@export
, - pass the name string when using plain
export('...')
calls.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-exports-1.0.0.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for python_exports-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fbf951eb3f06454d1b5349fd017064a70f222b1b0ec1f65f6cc516c96f91a45 |
|
MD5 | 6f1546f1e4aa366f03a6051f496363b9 |
|
BLAKE2b-256 | 7558be141994059db75b52cc20b44e2a7388aeff90830c20e02910696f411e24 |