Skip to main content

Typed decorators for classproperty and cached_classproperty.

Project description

typed_classproperties

Pydowndoc PyPI Version Python Version Tests Status mypy Status pre-commit Status Ruff uv

Typed decorators for classproperty and cached_classproperty.

Python 3 compatible only*. No dependencies*footnote:[The library [typing_extensions](https://github.com/python/typing_extensions) is required when running with Python < 3.12].

Installation

This package is hosted on PyPI and can be installed using uv or pip.

Add to your uv project/script’s dependencies

uv add typed_classproperties

Install using pip after creating a virtual environment

path/to/venv/python -m pip install typed_classproperties

Example Usage

from typing import override

from typed_classproperties import classproperty, cached_classproperty


class Foo:
    @override
    def __init__(self, bar: str) -> None:
        self.bar: str = bar

    @classproperty
    def BAR(cls) -> int:
        return 1


assert Foo.BAR == 1
assert Foo(bar="one").BAR == 1


class CachedFoo:
    @override
    def __init__(self, bar: str) -> None:
        self.bar: str = bar

    @cached_classproperty
    def BAR(cls) -> int:
        print("This will be executed only once")
        return 1


assert CachedFoo.BAR == 1
assert CachedFoo(bar="bar").FOO == 1

Tests

See tests.py for further usage examples and expected behaviour.

To run tests

uv run --group test -- pytest

Credits

Credits to Denis Ryzhkov, on Stack Overflow, for the original implementation of the @classproperty decorator: https://stackoverflow.com/a/13624858/1280629

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typed_classproperties-1.3.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

typed_classproperties-1.3.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file typed_classproperties-1.3.1.tar.gz.

File metadata

File hashes

Hashes for typed_classproperties-1.3.1.tar.gz
Algorithm Hash digest
SHA256 f54b40cae0711dc353cab901b4081a46ac2ad4b61ad4ccb9291c68458d693715
MD5 c356644caeb2c952a2f1bd5d08dc14d2
BLAKE2b-256 02cd250159525de3ee7adf6e9f1b99f5dd16a24c412f9e6be693234aef9990e3

See more details on using hashes here.

File details

Details for the file typed_classproperties-1.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for typed_classproperties-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 57df85d22e3243d210ca4152786cdcccfa1cf906943ea0b5af2c020cba9e9c9e
MD5 c8951f56a21323a3f758f16512dde7a1
BLAKE2b-256 b498cbd25250ab18484dddbbd3eb813ee7e5eec4e135448500e77d560b2f7740

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page