.. vim: set fileencoding=utf-8: .. -- coding: utf-8 -- .. +--------------------------------------------------------------------------+ | | | Licensed under the Apache License, Version 2.0 (the "License"); | | you may not use this file except in compliance with the License. | | You may obtain a copy of the License at | | | | http://www.apache.org/licenses/LICENSE-2.0 | | | | Unless required by applicable law or agreed to in writing, software | | distributed under the License is distributed on an "AS IS" BASIS, | | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | | See the License for the specific language governing permissions and | | limitations under the License. | | | +--------------------------------------------------------------------------+
classcore
.. image:: https://img.shields.io/pypi/v/classcore :alt: Package Version :target: https://pypi.org/project/classcore/
.. image:: https://img.shields.io/pypi/status/classcore :alt: PyPI - Status :target: https://pypi.org/project/classcore/
.. image:: https://github.com/emcd/python-classcore/actions/workflows/tester.yaml/badge.svg?branch=master&event=push :alt: Tests Status :target: https://github.com/emcd/python-classcore/actions/workflows/tester.yaml
.. image:: https://emcd.github.io/python-classcore/coverage.svg :alt: Code Coverage Percentage :target: https://github.com/emcd/python-classcore/actions/workflows/tester.yaml
.. image:: https://img.shields.io/github/license/emcd/python-classcore :alt: Project License :target: https://github.com/emcd/python-classcore/blob/master/LICENSE.txt
.. image:: https://img.shields.io/pypi/pyversions/classcore :alt: Python Versions :target: https://pypi.org/project/classcore/
🏭 A Python library package which provides foundational class factories and decorators for providing classes with attributes immutability and concealment and other custom behaviors.
🔧 Class Customization: Composable decorators and metaclasses providing classes with customized behaviors.
🔒 Attribute Immutability: Standard collection of metaclasses and decorators to provide immutability for class and instance attributes, with support for selective mutability via names, regexes, or predicates.
👁️ Attribute Concealment: Standard collection of metaclasses and decorators to provide concealment for class and instance attributes, with support for selective visibility via names, regexes, or predicates.
📚 Dataclass Integration: Decorators like
dataclass_with_standard_behaviors make standard Python dataclasses with
immutability and concealment. (Unlike dataclass( frozen = True ),
attributes can still be manipulated via __post_init__ when one of these
decorators is applied.)
🧩 Protocol Support: Immutable protocol classes for nominal and structural
subtyping, compatible with typing.Protocol. Immutability and concealment
are inherited by subclassed implementations of these protocols.
🗂️ Module Reclassification: Apply immutability and concealment to entire modules.
Via uv <https://github.com/astral-sh/uv/blob/main/README.md>_ pip
command:
::
uv pip install classcore
Or, via pip:
::
pip install classcore
Enforcement of immutability is quite difficult in Python. While this library encourages immutability by default, it can be circumvented by anyone who has intermediate knowledge of Python machinery and who is determined to circumvent the immutability. Use the library in the spirit of making programs safer, but understand that it cannot truly prevent unwanted state tampering.
Please see the examples directory <https://github.com/emcd/python-classcore/tree/master/documentation/examples>_
for greater detail.
Produce classes which have immutable and concealed attributes and whose instances have immutable and concealed attributes. Can be normal classes, dataclasses, protocol classes, etc....
.. code-block:: python
from dataclasses import field
from math import sqrt
from classcore.standard import DataclassObject
class Point2d( DataclassObject ):
x: float
y: float
hypotenuse: float = field( init = False )
def __post_init__( self ) -> None:
x, y = self.x, self.y
self.hypotenuse = sqrt( x*x + y*y )
Point2d.x = 3 # ❌ Error, immutable class attribute.
point = Point2d( x = 3, y = 4 )
point.x = 42 # ❌ Error, immutable instance attribute.
point.hypotenuse # Result: 5
dir( point ) # Result: ['hypotenuse', 'x', 'y']
Decorate classes so that their instances will have immutable and concealed attributes.
.. code-block:: python
from dataclasses import field
from math import sqrt
from classcore.standard import dataclass_with_standard_behaviors
@dataclass_with_standard_behaviors( )
class Point2d:
x: float
y: float
hypotenuse: float = field( init = False )
def __post_init__( self ) -> None:
x, y = self.x, self.y
self.hypotenuse = sqrt( x*x + y*y )
point = Point2d( x = 5, y = 12 )
point.x = 42 # ❌ Error, immutable instance attribute.
point.hypotenuse # Result: 13
dir( point ) # Result: ['hypotenuse', 'x', 'y']
Make modules (or entire packages) immutable to prevent direct modification of
their attributes and to present only their public attributes via dir.
.. code-block:: python
from classcore.standard import reclassify_modules
reclassify_modules( __name__, recursive = True )
More Flair <https://www.imdb.com/title/tt0151804/characters/nm0431918>_.. image:: https://img.shields.io/github/last-commit/emcd/python-classcore :alt: GitHub last commit :target: https://github.com/emcd/python-classcore
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json :alt: Copier :target: https://github.com/copier-org/copier
.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg :alt: Hatch :target: https://github.com/pypa/hatch
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit :alt: pre-commit :target: https://github.com/pre-commit/pre-commit
.. image:: https://microsoft.github.io/pyright/img/pyright_badge.svg :alt: Pyright :target: https://microsoft.github.io/pyright
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :alt: Ruff :target: https://github.com/astral-sh/ruff
.. image:: https://img.shields.io/pypi/implementation/classcore :alt: PyPI - Implementation :target: https://pypi.org/project/classcore/
.. image:: https://img.shields.io/pypi/wheel/classcore :alt: PyPI - Wheel :target: https://pypi.org/project/classcore/
python-absence <https://github.com/emcd/python-absence>_
absence <https://pypi.org/project/absence/>_🕳️ A Python library package which provides a sentinel for absent values - a falsey, immutable singleton that represents the absence of a value in contexts where None or False may be valid values.
python-accretive <https://github.com/emcd/python-accretive>_
accretive <https://pypi.org/project/accretive/>_🌌 A Python library package which provides accretive data structures - collections which can grow but never shrink.
python-falsifier <https://github.com/emcd/python-falsifier>_
falsifier <https://pypi.org/project/falsifier/>_🎭 A very simple Python library package which provides a base class for falsey objects - objects that evaluate to False in boolean contexts.
python-frigid <https://github.com/emcd/python-frigid>_
frigid <https://pypi.org/project/frigid/>_🔒 A Python library package which provides immutable data structures - collections which cannot be modified after creation.
python-icecream-truck <https://github.com/emcd/python-icecream-truck>_
icecream-truck <https://pypi.org/project/icecream-truck/>_🍦 Flavorful Debugging - A Python library which enhances the powerful and well-known icecream package with flavored traces, configuration hierarchies, customized outputs, ready-made recipes, and more.
python-mimeogram <https://github.com/emcd/python-mimeogram>_
mimeogram <https://pypi.org/project/mimeogram/>_📨 A command-line tool for exchanging collections of files with Large Language Models - bundle multiple files into a single clipboard-ready document while preserving directory structure and metadata... good for code reviews, project sharing, and LLM interactions.
FAQs
Foundational class factories and decorators.
We found that classcore demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA is discontinuing official RSS support for KEV and cybersecurity alerts, shifting updates to email and social media, disrupting automation workflows.
Security News
The MCP community is launching an official registry to standardize AI tool discovery and let agents dynamically find and install MCP servers.
Research
Security News
Socket uncovers an npm Trojan stealing crypto wallets and BullX credentials via obfuscated code and Telegram exfiltration.