https://github.com/romnn/classprop

@classproperty decorator for python that works just like @property.
https://github.com/romnn/classprop

class classproperty decorator metaclass python3 pythonic

Last synced: 8 months ago
JSON representation

@classproperty decorator for python that works just like @property.

• Host: GitHub
• URL: https://github.com/romnn/classprop
• Owner: romnn
• License: mit
• Created: 2020-03-13T15:29:51.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T07:46:04.000Z (about 3 years ago)
• Last Synced: 2025-04-22T10:47:00.157Z (8 months ago)
• Topics: class, classproperty, decorator, metaclass, python3, pythonic
• Language: Python
• Homepage:
• Size: 161 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============================

@classprop

===============================

.. image:: https://github.com/romnn/classprop/workflows/test/badge.svg

        :target: https://github.com/romnn/classprop/actions

        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/classprop.svg

        :target: https://pypi.python.org/pypi/classprop

        :alt: PyPI version

.. image:: https://img.shields.io/github/license/romnn/classprop

        :target: https://github.com/romnn/classprop

        :alt: License

.. image:: https://codecov.io/gh/romnn/classprop/branch/master/graph/badge.svg

        :target: https://codecov.io/gh/romnn/classprop

        :alt: Test Coverage

""""""""

.. role:: python(code)

   :language: python

Small python package that provides a :python:`@classproperty` decorator for python classes

that works just like :python:`@property` except for class variables!

.. code-block:: console

    $ pip install classprop

Use it just like builtin :python:`@property`'s:

.. code-block:: python

    from classprop import classprop

    class TestClass:

        _internal = "Hello, World"

        @classprop

        def my_class_prop(self) -> str:

            return self._internal

        @my_class_prop.setter

        def my_class_prop(self, value: str) -> None:

            self._internal = value

    foo = TestClass()

    assert foo.my_class_prop == "Hello, World"

    baz = TestClass()

    assert baz.my_class_prop == "Hello, World"

    baz.my_class_prop = "Changed"

    assert foo.my_class_prop == "Changed"

Development

-----------

For detailed instructions see `CONTRIBUTING `_.

Tests

~~~~~~~

You can run tests with

.. code-block:: console

    $ invoke test

    $ invoke test --min-coverage=90     # Fail when code coverage is below 90%

    $ invoke type-check                 # Run mypy type checks

Linting and formatting

~~~~~~~~~~~~~~~~~~~~~~~~

Lint and format the code with

.. code-block:: console

    $ invoke format

    $ invoke lint

All of this happens when you run ``invoke pre-commit``.

Note

-----

This project is still in the alpha stage and should not be considered production ready.