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.4.0.tar.gz (10.4 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.4.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for directed_inputs_class-202511.4.0.tar.gz
Algorithm Hash digest
SHA256 be54ae8ffdfa71e036b502ce873bd1b05e067ea8585e4426de57de503703f608
MD5 e478b636cf527471bb27ef8e0023875e
BLAKE2b-256 98875a75c7d1ef1a61c04ac571797f2ef5d78575cb2277e2cd4786ab0efed50d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for directed_inputs_class-202511.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9762eed3fd590bacd6bf864d561811fc1803a246d1a5dfa9f756db3cc7482c84
MD5 547a542d349c3d0377bb194d0442e73e
BLAKE2b-256 470e79809dc779cef5b04e00ff8dc76251f07cb786e7fd4ecda7edbf8a1ee18d

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