public

library2020.12.3pypypi✓ verified 87d ago

The `public` library for Python, version 2020.12.3, provides a `@public` decorator to explicitly mark functions, classes, and variables as part of a module's public API. It automatically manages and replaces the module's `__all__` list, aiming to simplify explicit module visibility control. The library appears to be in maintenance mode, with its last release in late 2020.

testing serialization

pip install public

github ↗package ↗

INSTALL

IMPORT

SIG · PUBLIC

public

testingpythonv2020.12.3

Install

2.5s avg

Import

25ms

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2020.12.3 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.025s · 19.2MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 2.5s · import 0.025s · 20MB

17MB installed

● package 17MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

public

✓ from public import public

✗ from public import add

The `public` object itself is the primary decorator factory, which internally aliases `public.add`.

This example demonstrates how to use the `@public` decorator for functions and how to alias them. It also illustrates that non-decorated functions remain private and cannot be imported.

# my_module.py from public import public @public def hello_world(): """A publicly exposed function.""" return "Hello from the public module!" def _private_function(): """A private function, not exposed.""" return "You shouldn't see this!" @public(alias='my_custom_name') def original_function_name(): """A public function exposed under an alias.""" return "This function has a custom public name." # To use this module: # from my_module import hello_world, my_custom_name # print(hello_world()) # print(my_custom_name()) # try: # from my_module import _private_function # This will raise an AttributeError # except AttributeError as e: # print(f"Error trying to import private function: {e}")

Debug

Known issues

gotchaThe `public` decorator actively modifies or overwrites your module's `__all__` list. If you manually define `__all__`, the decorated symbols will typically take precedence, potentially leading to unexpected exposure or hiding of symbols.

fix

Avoid manually defining `__all__` in modules where `public` is used, or be mindful that `public` will manage it. Ensure all desired public symbols are decorated.

affects: All versions

gotchaDirectly decorating non-callable objects (like variables or constants) with `@public` as `@public my_var = 'value'` is not supported. You must use specific syntax to expose variables.

fix

To expose a variable `my_var`, either use `@public('my_var')` on a dummy function (e.g., `def _pass(): pass`) or explicitly call `public.add(my_var=my_var)` in your module's top-level scope.

affects: All versions

maintenanceThe `public` library appears to be in maintenance mode, with its last commit and release in 2020. While stable, users should be aware that active development, new features, or timely bug fixes are unlikely.

fix

Factor project status into your dependency choices; consider alternatives for new projects requiring active development or modern Python features.

affects: All current and future users

Errors

Common errors & fixes

AttributeError: module 'your_module' has no attribute 'your_private_func'

You attempted to import a function, class, or variable from a module that was not explicitly marked with `@public`. The `public` library automatically manages `__all__`, only exposing decorated symbols.

fix

Decorate `your_private_func` with `@public` in `your_module.py` if it should be public, or refrain from importing it.

TypeError: 'NoneType' object is not callable

This often occurs when trying to apply `@public` directly to a variable declaration, or when calling `public` incorrectly (e.g., `public()`). The decorator needs to be applied to a callable or via specific variable exposure syntax.

fix

For variables, use `@public('variable_name')` on a dummy `def _pass(): pass` or explicitly call `public.add(variable_name=your_variable)`. Ensure `@public` is used correctly as a decorator for functions/classes.

NameError: name 'my_variable' is not defined

When using `@public('my_variable')` on a dummy function or `public.add(my_variable=my_variable)`, the variable `my_variable` must exist in the module's top-level scope and be correctly referenced by name or object.

fix

Ensure the variable `my_variable` is defined at the module level and that the `public.add` mechanism (either via decorator or direct call) is correctly implemented and executes during module import.

Upgrade

Version history

2020.12.3latest on PyPI · released Dec 3, 2020

Audit

Dependencies

No dependency data recorded yet.

Agent activity

12 hits · last 30 days

node

Resources

githubhttps://github.com/andrewp-as-is/public.py ↗

packagehttps://pypi.org/project/public/ ↗