lazysloth 0.0.1

A Python library for lazy and immutable variables.

lazysloth: Lazy and Immutable Variable Library for Python

lazysloth is a Python library designed to facilitate the use of lazy initialization patterns and immutable variables in Python applications. It provides two main functionalities through its LazyVariable and ImmutableVariable classes, allowing developers to defer expensive computations until absolutely necessary and to create variables that cannot be modified after initialization.

Installation

pip install lazysloth

Replace lazysloth with the correct package name if published on PyPI or provide specific instructions if the library is to be installed directly from a source repository.

Features

• LazyVariable: Enables lazy initialization of variables, where the value is only computed upon the first access.
• ImmutableVariable: Wraps values in an immutable container, preventing changes after initialization.

Quick Start

Here's a quick example to get started with lazysloth:

from src.lazysloth import LazyVariable, ImmutableVariable


def expensive_computation():
    # Simulate an expensive computation
    return {"data": 42}


# Initialize a LazyVariable
lazy_var = LazyVariable(expensive_computation)

# Access the variable to trigger computation
print(lazy_var.data)

# Wrap a value in an ImmutableVariable
immutable_var = ImmutableVariable({"key": "value"})

# Attempting to modify the value will raise an error
# immutable_var.key = "new value"  # Raises AttributeError

Python

Creating a comprehensive README.md for your lazysloth Python library involves outlining the purpose of the library, installation instructions, usage examples for LazyVariable and ImmutableVariable, and any additional information necessary for users to effectively utilize the library. Here's a structured template to get you started:

---

lazysloth: Lazy and Immutable Variable Library for Python

lazysloth is a Python library designed to facilitate the use of lazy initialization patterns and immutable variables in Python applications. It provides two main functionalities through its LazyVariable and ImmutableVariable classes, allowing developers to defer expensive computations until absolutely necessary and to create variables that cannot be modified after initialization.

Installation

pip install lazysloth

Replace lazysloth with the correct package name if published on PyPI or provide specific instructions if the library is to be installed directly from a source repository.

Features

• LazyVariable: Enables lazy initialization of variables, where the value is only computed upon the first access.
• ImmutableVariable: Wraps values in an immutable container, preventing changes after initialization.

Quick Start

Here's a quick example to get started with lazysloth:

from src.lazysloth import LazyVariable, ImmutableVariable


def expensive_computation():
    # Simulate an expensive computation
    return {"data": 42}


# Initialize a LazyVariable
lazy_var = LazyVariable(expensive_computation)

# Access the variable to trigger computation
print(lazy_var.data)

# Wrap a value in an ImmutableVariable
immutable_var = ImmutableVariable({"key": "value"})

# Attempting to modify the value will raise an error
# immutable_var.key = "new value"  # Raises AttributeError

Usage

LazyVariable

LazyVariable is intended for situations where a variable's initialization is computationally expensive and not always necessary. The variable's value is computed only on the first access.

Initialization

lazy_var = LazyVariable(initializer_function, *args, **kwargs)

• initializer_function: A callable that returns the value to be lazily initialized.
• *args and **kwargs: Arguments passed to the initializer_function.

Access

Access attributes or items of the lazily initialized value as if LazyVariable were the value itself:

result = lazy_var.attribute
result = lazy_var['item']

Callable Support

If the lazily initialized value is callable, LazyVariable can be called directly:

result = lazy_var(*args, **kwargs)

ImmutableVariable

ImmutableVariable ensures that the wrapped value cannot be modified after initialization. It's useful for creating read-only data structures.

Initialization

immutable_var = ImmutableVariable(value)

• value: The value to be made immutable.

Access

Access the immutable value's attributes or items directly:

result = immutable_var.attribute
result = immutable_var['item']

Attempting to modify the wrapped value results in an AttributeError.

Advanced Usage

• Resetting a LazyVariable: If your use case requires re-initializing a LazyVariable, you can extend its functionality to support resetting.

Contributing

Contributions to lazysloth are welcome! Please refer to the contributing guidelines for more information on how to submit pull requests, report issues, or request features.