directed-inputs-class 202511.2

Directed inputs class consumes and processes inputs from sources beyond args and kwargs

Directed Inputs Class

🛠️ Manage your Python inputs efficiently! 🎯

Directed Inputs Class is a Python library that provides a flexible and robust interface for managing inputs from various sources such as environment variables, stdin, and predefined dictionaries. It offers features like input freezing, thawing, and advanced decoding utilities.

Key Features

• 🧩 Environment Variable Integration - Seamlessly integrates environment variables into your inputs.
• 🧭 Scoped Environment Loading - Filter environment variables by prefix and optionally strip it for clean keys.
• 📥 Stdin Input Handling - Read and merge inputs from stdin with optional overrides.
• ❄️ Input Freezing and Thawing - Freeze inputs to prevent modifications, and thaw them when needed.
• 🔄 Advanced Decoding Utilities - Decode inputs from Base64, JSON, and YAML formats with error handling.
• 🔧 Type Conversion - Convert inputs to boolean or integer types with robust error handling.
• 🧬 Deep Input Merging - Merge additional inputs into existing state without losing nested structure.

Example Usage

from directed_inputs_class import DirectedInputsClass

# Initialize with environment variables and stdin
dic = DirectedInputsClass(from_environment=True, from_stdin=True)

# Retrieve and decode an input
decoded_value = dic.decode_input("example_key", decode_from_base64=True)
print(decoded_value)

Freezing and Thawing Inputs

from directed_inputs_class import DirectedInputsClass

# Initialize with some inputs
dic = DirectedInputsClass(inputs={"key1": "value1"})

# Freeze the inputs
frozen_inputs = dic.freeze_inputs()
print(frozen_inputs)  # Outputs: {'key1': 'value1'}

# Thaw the inputs
thawed_inputs = dic.thaw_inputs()
print(thawed_inputs)  # Outputs: {'key1': 'value1'}

# Merge additional data safely
dic.merge_inputs({"feature_flags": {"new": True}})

For more usage examples, see the Usage documentation.

Contributing

Contributions are welcome! Please see the Contributing Guidelines for more information.

Project Links

• Get Help (use the directed-inputs-class tag on Stack Overflow)
• PyPI
• GitHub
• Documentation
• Changelog