Skip to main content

Immutable implementation for Python using dataclasses

Project description

Immutable

Overview

This library provides decorators and base classes to create immutable data classes in Python. By enforcing immutability and keyword-only arguments, it enhances the robustness and clarity of your data structures.

📋 Requirements

  • Python 3.9 or later.
  • No external dependencies are required.

📦 Installation

Pip

pip install python-immutable

Poetry

poetry add python-immutable

🛠 Usage

Using immutable Decorator

Apply immutable to a class to make it immutable and enforce keyword-only arguments.

from immutable import immutable

@immutable
class MyClass:
    # Fields here

Extending Immutable Base Class

Inherit from Immutable for similar functionality.

from immutable import Immutable

class MyClass(Immutable):
    # Fields here

🤝 Contributing

Contributions are welcome. Please submit pull requests or issues on the GitHub repository.

⚠️ Important Note

Ensure compatibility with Python 3.9 or newer when contributing.

🔒 License

This project is released under the Apache-2.0 License. See the LICENSE file for more details.

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

Built Distribution

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

File details

Details for the file python_immutable-1.1.2.dev325051810310110157.tar.gz.

File metadata

File hashes

Hashes for python_immutable-1.1.2.dev325051810310110157.tar.gz
Algorithm Hash digest
SHA256 66047ccbb3aab93cfc4256d5e14c0bd927fc34bfb34c1a3a229c1a0642b7ecdf
MD5 9059a9d0ce952655d0d0d5b2d59456fa
BLAKE2b-256 6152c8af0b7873cb6f567fbc36a9aa9f0e3098c986ff9d79fce80e1ee1b0c9b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_immutable-1.1.2.dev325051810310110157.tar.gz:

Publisher: integration_delivery.yml on sassanh/python-immutable

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_immutable-1.1.2.dev325051810310110157-py3-none-any.whl.

File metadata

File hashes

Hashes for python_immutable-1.1.2.dev325051810310110157-py3-none-any.whl
Algorithm Hash digest
SHA256 73a08f646ee4987dff293bf22ef7cdf00ee4efd0c8ab6bcd831eadbb90abef91
MD5 61dccd9a05a1f309db3e5f2d405efa5a
BLAKE2b-256 2bac1ed96a7b0248742c30aa0d0295e34037987fe7bb7cf2f00b171732f3335f

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_immutable-1.1.2.dev325051810310110157-py3-none-any.whl:

Publisher: integration_delivery.yml on sassanh/python-immutable

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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