public 2019.4.13

replace '__all__' with '@public.add' decorator

Installation

$ [sudo] pip install public

Features

• replace __all__ with @public.add decorator

before

__all__ = ["func"]

def func():

after

import public

@public.add
def func():

Functions

function	__doc__
public.add(*objects)	add objects to __all__
public.public(*objects)	add objects to __all__. deprecated
public.test(module)	test module __all__

Examples

>>> import public
>>> @public.add
    def func(): pass

>>> @public.add
    class Cls: pass

>>> __all__
['Cls','func']

>>> public.add("name")
>>> public.add(*["name1","name2"])

>>> __all__
['Cls','func','name','name1','name2']

Links

• Importing * From a Package. Python documentation
• Can someone explain all in Python? Stackoverflow

python-readme-generator