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.dev225051810399574810.tar.gz.

File metadata

File hashes

Hashes for python_immutable-1.1.2.dev225051810399574810.tar.gz
Algorithm Hash digest
SHA256 eae6e5e4cb2b677574cadb6c61bdc3093f86ba016667b76b6db4e61fee19023b
MD5 70705e269b80efec4c4640eac33b3f3f
BLAKE2b-256 fb2eb3954a6efe88f274ee3c813dd07fa8115e5801f148cb661327359f5618de

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_immutable-1.1.2.dev225051810399574810.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.dev225051810399574810-py3-none-any.whl.

File metadata

File hashes

Hashes for python_immutable-1.1.2.dev225051810399574810-py3-none-any.whl
Algorithm Hash digest
SHA256 51816bd5c49582cbcd2894da5474696e8f01f8fe18a86380d46fd58a19827b60
MD5 31b716b1817b3c864f237dea41bc8abb
BLAKE2b-256 4429b2d7f925c270bc762026e30d9decdc7b77cf9716d61964130676d4a058b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_immutable-1.1.2.dev225051810399574810-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