Simple Python `classproperty` decorator

PyPI package

This module provides a simple way for defining class properties.

Install

You can install this Python module via pip:

pip install simple-classproperty

Otherwise the module can be downloaded from PyPI: https://pypi.org/project/simple-classproperty/

Usage

Import the module:

from simple_classproperty import ClasspropertyMeta, classproperty

Create a class with a class property:

class NewClass(metaclass=ClasspropertyMeta):
    _attr = "val"

    @classproperty
    def attr(cls):
        return cls._attr

Don't forget to set the metaclass!

(Optional) Define also a setter and deleter for the newly created class property (this works like the standard python property):

@attr.setter
def attr(cls, value):
    cls._attr = value

@attr.deleter
def attr(cls):
    del cls._attr

Tips

The classproperty is also accessible from an instance:

instance = NewClass()
print(instance.attr)  # "val"

When the value of the property is changed from an instance object, the class property will be changed. All other instances will have this new value:

instance1 = NewClass()
instance2 = NewClass()

instance1.attr = "new"

print(instance1.attr)  # "new"
print(instance2.attr)  # "new"
print(NewClass.attr)   # "new"

This behavior is the same when a property gets deleted from an instance.

Metadata

Release files for simple-classproperty 1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simple-classproperty 1.4
File	Size	Uploaded
simple-classproperty-1.4.tar.gz	15.3 kB	Nov 3, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for simple-classproperty 1.4
File	Interpreter	ABI	Platform	Reset
simple_classproperty-1.4-py3-none-any.whl 16.1 kB Nov 3, 2021	Python 3	none	any	Details

Total release size: 31.4 kB

Release files / simple-classproperty-1.4.tar.gz

Download URL	simple-classproperty-1.4.tar.gz
Size	15.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`7e7f1a052d7e398d2fe0a81e78385337ff34fab0af88d98efe2d908535a07a2a`
BLAKE2b-256 checksum How to use checksums	`cb9dfed0972524a361d559fc8f7e5ebe0414e3492a5e63144faf448c3fbc22d5`
Upload date	Nov 3, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12`

Release files / simple_classproperty-1.4-py3-none-any.whl

Download URL	simple_classproperty-1.4-py3-none-any.whl
Size	16.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`860dfc449f720d3d1ae2f8aa3b5fec44cc626bd7cb566c197dc9d031d0b4b5c3`
BLAKE2b-256 checksum How to use checksums	`3510fb268638b3807556edffba923589755fdb741e3466939b5d20104028df97`
Upload date	Nov 3, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12`