Skip to main content

Common utility functions for the kiarina namespace packages

Project description

kiarina-utils-common

PyPI version Python License: MIT

Common utility functions for the kiarina namespace packages.

Installation

pip install kiarina-utils-common

Features

Configuration String Parser

Parse configuration strings into nested dictionaries with automatic type conversion.

from kiarina.utils.common import parse_config_string

# Basic usage
config = parse_config_string("cache.enabled:true,db.port:5432")
# Result: {"cache": {"enabled": True}, "db": {"port": 5432}}

# Flag support (no value)
config = parse_config_string("debug,verbose,cache.enabled:true")
# Result: {"debug": None, "verbose": None, "cache": {"enabled": True}}

# Array indices support
config = parse_config_string("items.0:first,items.1:second")
# Result: {"items": ["first", "second"]}

# Custom separators
config = parse_config_string(
    "key1=val1;key2.sub=42", 
    separator=";", 
    key_value_separator="="
)
# Result: {"key1": "val1", "key2": {"sub": 42}}

Type Conversion

Values are automatically converted to appropriate types:

  • "true", "True"bool(True)
  • "false", "False"bool(False)
  • Numeric strings ("1", "0", "-5", "3.14") → int or float
  • Other strings → str

Nested Keys

Use dot notation for nested structures:

config = parse_config_string("database.host:localhost,database.port:5432")
# Result: {"database": {"host": "localhost", "port": 5432}}

Array Indices

Use numeric keys for array structures:

config = parse_config_string("users.0.name:Alice,users.0.age:30,users.1.name:Bob")
# Result: {"users": [{"name": "Alice", "age": 30}, {"name": "Bob"}]}

API Reference

parse_config_string(config_str, *, separator=",", key_value_separator=":", nested_separator=".")

Parse configuration string into nested dictionary.

Parameters:

  • config_str (str): Configuration string to parse
  • separator (str, optional): Item separator. Default: ","
  • key_value_separator (str, optional): Key-value separator. Default: ":"
  • nested_separator (str, optional): Nested key separator. Default: "."

Returns:

  • dict[str, Any]: Parsed configuration dictionary

Examples:

# Basic usage
parse_config_string("key1:value1,key2:value2")
# {"key1": "value1", "key2": "value2"}

# Nested keys
parse_config_string("cache.enabled:true,db.port:5432")
# {"cache": {"enabled": True}, "db": {"port": 5432}}

# Flags (no value)
parse_config_string("debug,verbose")
# {"debug": None, "verbose": None}

# Custom separators
parse_config_string("a=1;b=2", separator=";", key_value_separator="=")
# {"a": 1, "b": 2}

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

This is a personal project by kiarina. While issues and pull requests are welcome, please note that this is primarily developed for personal use.

Related Packages

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

kiarina_utils_common-1.7.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

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

kiarina_utils_common-1.7.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file kiarina_utils_common-1.7.0.tar.gz.

File metadata

  • Download URL: kiarina_utils_common-1.7.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kiarina_utils_common-1.7.0.tar.gz
Algorithm Hash digest
SHA256 5d0314844598aa246b62e52b3f922c32f7325226574f5e616ef7fd3dca0f0594
MD5 ece025a9c38ff1c48b120cafd1bb008d
BLAKE2b-256 c4c70e27a62591311aec1bf50959ad4b47223ea457ae493422bfa5c41c05f1ab

See more details on using hashes here.

File details

Details for the file kiarina_utils_common-1.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kiarina_utils_common-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f01a21bba9480d398dcc67468d3e23748ccc91030588fe209c63a0d06d41967
MD5 62297376911a9d21e526b295bae5e352
BLAKE2b-256 a071b2e0d7b48253ffb1915d37dd9276be9a6e55c161affbaab10e01ff051ff6

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