Skip to main content

Typed decorators for classproperty and cached_classproperty.

Project description

typed_classproperties

Pydowndoc PyPI Version Python Version Tests Status mypy Status Ruff uv

Typed decorators for classproperty and cached_classproperty.

Python 3 compatible only*. No dependencies*.

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 usage examples and expected behaviour.

To run tests

uv run --group test -- pytest

Credits

Credits to Denis Ryzhkov on Stackoverflow for the implementation of classproperty: 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.1.4.tar.gz (6.5 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.1.4-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for typed_classproperties-1.1.4.tar.gz
Algorithm Hash digest
SHA256 a28f9060a62e64652a19d7e58fe1ae0dc4a40f684863ed5cc99b7b64640ab0c6
MD5 d52103b390ed71576d05642a3eabfd58
BLAKE2b-256 d9ca7a5c292448933aead8c96a4eac531c9b561bd007e2d784bc8cde4fb04b32

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for typed_classproperties-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 38959c7adc8ff4112b65a84c55608a763984785331b5100823aea1c5344efe72
MD5 3468a53320ca59d9d16b39c4d7594479
BLAKE2b-256 ebe6ea78944d787cecaeb12d775c9b57949529f3709442cc47e430d9b7d985ec

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