Skip to main content

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

Project description

Directed Inputs Class

Directed Inputs Class Logo

🛠️ Manage your Python inputs efficiently! 🎯

CI Status Documentation Status PyPI Package latest release Supported versions

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

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

directed_inputs_class-202511.6.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

directed_inputs_class-202511.6.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file directed_inputs_class-202511.6.0.tar.gz.

File metadata

File hashes

Hashes for directed_inputs_class-202511.6.0.tar.gz
Algorithm Hash digest
SHA256 8d3eef5d6d56a42edc4eb92a6d9557988d88385633cce2e62a5addc0b31d283f
MD5 adc3231bb72525a27426bb5661301f22
BLAKE2b-256 82530ec29e0c4c80cda3fb35cb897b0ca830ee10a890c8f545f6e152c24c7863

See more details on using hashes here.

File details

Details for the file directed_inputs_class-202511.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for directed_inputs_class-202511.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9482e8f15dcbbce1477d7714d243d4184a05f247cb18a2998b47efcd0e6a8d12
MD5 c0a404c0df2ca3f87cc79e3ae523253c
BLAKE2b-256 eb06f8a1b483f0255c4cf9708b24ad7ba8d1d5a251836544524705760652054b

See more details on using hashes here.

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