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 3.0.0

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 3.0.0
File	Size	Uploaded
simple-classproperty-3.0.0.tar.gz	15.2 kB	Oct 12, 2022	Details

Built distribution (wheel)

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

Total release size: 31.3 kB

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

Download URL	simple-classproperty-3.0.0.tar.gz
Size	15.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`16f875106dea9629b60361c93166d544d7fea5600702236ad11942b47c7087c4`
BLAKE2b-256 checksum How to use checksums	`fbb1dc5efd09562885a76aeebe04b2e5edaa405a6ca8bc3217e37104cefb0627`
Upload date	Oct 12, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.0 CPython/3.7.14 Linux/5.15.0-1020-azure`

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

Download URL	simple_classproperty-3.0.0-py3-none-any.whl
Size	16.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1d3a1db29f88c46710ffcf8928b9dedc2dacb3851f1feb8437dc12a357b20e9e`
BLAKE2b-256 checksum How to use checksums	`453e577048869a761ffe0da9a6eee9b91c688fc401ef0dbc59f72edcba4d77f2`
Upload date	Oct 12, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.2.0 CPython/3.7.14 Linux/5.15.0-1020-azure`