@public decorator, public(*objects) function - add objects names to __all__
Project description
.. image:: https://img.shields.io/badge/language-python-blue.svg
.. image:: https://img.shields.io/pypi/pyversions/public.svg
:target: https://pypi.python.org/pypi/public
|codacy| |landscape| |codeclimate| |scrutinizer|
.. |scrutinizer| image:: https://scrutinizer-ci.com/g/russianidiot/public.py/badges/quality-score.png?b=master
:target: https://scrutinizer-ci.com/g/russianidiot/public.py/master
:alt: scrutinizer-ci.com
.. |codacy| image:: https://img.shields.io/codacy/6692c8b8d1194b3db696b456b683ad94
.svg
:target: https://www.codacy.com/app/russianidiot-github/public-py/dashboard
:alt: codacy.com
.. |codeclimate| image:: https://img.shields.io/codeclimate/github/russianidiot/public.py.svg
:target: https://codeclimate.com/github/russianidiot/public.py
:alt: codeclimate.com
.. |landscape| image:: https://landscape.io/github/russianidiot/public.py/master/landscape.svg?style=flat
:target: https://landscape.io/github/russianidiot/public.py/master
:alt: landscape.io
Install
```````
:code:`[sudo] pip install public`
Usage
`````
.. code:: python
# @public decorator
>>> from public import public
>>> @public
def func(): pass
>>> print(__all__)
['func']
>>> @public
>>> class CLS: pass
>>> print(__all__)
['CLS',func']
# public(*objects) function
>>> from public import public
>>> public("name")
>>> print(__all__)
['name']
>>> public("name1","name2")
>>> print(__all__)
['name','name1','name2']
`Examples/`_
.. _Examples/: https://github.com/russianidiot/public.py/tree/master/Examples
Sources:
* `py_modules/public.py`_
.. _`py_modules/public.py`: https://github.com/russianidiot/public.py/blob/master/py_modules/public.py
Feedback |github_issues| |gitter| |github_follow|
.. |github_issues| image:: https://img.shields.io/github/issues/russianidiot/public.py.svg
:target: https://github.com/russianidiot/public.py/issues
.. |github_follow| image:: https://img.shields.io/github/followers/russianidiot.svg?style=social&label=Follow
:target: https://github.com/russianidiot
.. |gitter| image:: https://badges.gitter.im/russianidiot/public.py.svg
:target: https://gitter.im/russianidiot/public.py
----
`russianidiot.github.io/python/`_ - Python packages
.. _russianidiot.github.io/python/: http://russianidiot.github.io/python/
`russianidiot.github.io/cli/`_ - command line scripts
.. _russianidiot.github.io/cli/: http://russianidiot.github.io/cli/
`README.rst`_ - generated with `readmemako.py`_ (python+ `mako`_ templates) and `.README`_ dotfiles
.. _README.rst: https://github.com/russianidiot/public.py/blob/master/.README/pypi.python.org/README.rst
.. _readmemako.py: http://github.com/russianidiot/readmemako.py/
.. _mako: http://www.makotemplates.org/
.. _.README: https://github.com/russianidiot-dotfiles/.README
.. image:: https://img.shields.io/pypi/pyversions/public.svg
:target: https://pypi.python.org/pypi/public
|codacy| |landscape| |codeclimate| |scrutinizer|
.. |scrutinizer| image:: https://scrutinizer-ci.com/g/russianidiot/public.py/badges/quality-score.png?b=master
:target: https://scrutinizer-ci.com/g/russianidiot/public.py/master
:alt: scrutinizer-ci.com
.. |codacy| image:: https://img.shields.io/codacy/6692c8b8d1194b3db696b456b683ad94
.svg
:target: https://www.codacy.com/app/russianidiot-github/public-py/dashboard
:alt: codacy.com
.. |codeclimate| image:: https://img.shields.io/codeclimate/github/russianidiot/public.py.svg
:target: https://codeclimate.com/github/russianidiot/public.py
:alt: codeclimate.com
.. |landscape| image:: https://landscape.io/github/russianidiot/public.py/master/landscape.svg?style=flat
:target: https://landscape.io/github/russianidiot/public.py/master
:alt: landscape.io
Install
```````
:code:`[sudo] pip install public`
Usage
`````
.. code:: python
# @public decorator
>>> from public import public
>>> @public
def func(): pass
>>> print(__all__)
['func']
>>> @public
>>> class CLS: pass
>>> print(__all__)
['CLS',func']
# public(*objects) function
>>> from public import public
>>> public("name")
>>> print(__all__)
['name']
>>> public("name1","name2")
>>> print(__all__)
['name','name1','name2']
`Examples/`_
.. _Examples/: https://github.com/russianidiot/public.py/tree/master/Examples
Sources:
* `py_modules/public.py`_
.. _`py_modules/public.py`: https://github.com/russianidiot/public.py/blob/master/py_modules/public.py
Feedback |github_issues| |gitter| |github_follow|
.. |github_issues| image:: https://img.shields.io/github/issues/russianidiot/public.py.svg
:target: https://github.com/russianidiot/public.py/issues
.. |github_follow| image:: https://img.shields.io/github/followers/russianidiot.svg?style=social&label=Follow
:target: https://github.com/russianidiot
.. |gitter| image:: https://badges.gitter.im/russianidiot/public.py.svg
:target: https://gitter.im/russianidiot/public.py
----
`russianidiot.github.io/python/`_ - Python packages
.. _russianidiot.github.io/python/: http://russianidiot.github.io/python/
`russianidiot.github.io/cli/`_ - command line scripts
.. _russianidiot.github.io/cli/: http://russianidiot.github.io/cli/
`README.rst`_ - generated with `readmemako.py`_ (python+ `mako`_ templates) and `.README`_ dotfiles
.. _README.rst: https://github.com/russianidiot/public.py/blob/master/.README/pypi.python.org/README.rst
.. _readmemako.py: http://github.com/russianidiot/readmemako.py/
.. _mako: http://www.makotemplates.org/
.. _.README: https://github.com/russianidiot-dotfiles/.README
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
public-0.0.26.tar.gz
(8.1 kB
view details)
File details
Details for the file public-0.0.26.tar.gz
.
File metadata
- Download URL: public-0.0.26.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4749f718e48195967ff3fd49e943b2d1482b537c2d174a29224733d0bf2673f8 |
|
MD5 | 8ff791927a361dc34284aa87b6003289 |
|
BLAKE2b-256 | 222fb09cd450d5d2ea56451cf804cccb3429b107e648ca70b80cddb1bd70b95b |