dataconf 2.2.0__tar.gz → 2.2.2__tar.gz

{dataconf-2.2.0 → dataconf-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dataconf
-Version: 2.2.0
+Version: 2.2.2
 Summary: Simple dataclasses configuration management for Python with hocon/json/yaml/properties/env-vars/dict support.
 Home-page: https://github.com/zifeo/dataconf
 License: MPL-2.0
@@ -15,8 +15,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: PyYAML (>=6.0,<7.0)
-Requires-Dist: pyhocon (==0.3.60)
+Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
+Requires-Dist: pyhocon (==0.3.59)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Project-URL: Repository, https://github.com/zifeo/dataconf
 Description-Content-Type: text/markdown

{dataconf-2.2.0 → dataconf-2.2.2}/dataconf/utils.py

@@ -6,6 +6,7 @@ from datetime import datetime
 from enum import Enum
 from enum import IntEnum
 from inspect import isclass
+
 from typing import Any
 from typing import Dict
 from typing import get_args
@@ -28,6 +29,12 @@ from pyhocon.config_tree import ConfigList
 from pyhocon.config_tree import ConfigTree
 import pyparsing
 
+from dataconf.version import PY310up
+
+
+if PY310up:
+    from types import UnionType
+
 
 NoneType = type(None)
 
@@ -42,9 +49,13 @@ def __parse_type(value: Any, clazz: Type, path: str, check: bool):
     raise TypeConfigException(f"expected type {clazz} at {path}, got {type(value)}")
 
 
+def is_union(origin):
+    return origin is Union or (PY310up and origin is UnionType)
+
+
 def is_optional(type: Type):
     # Optional = Union[T, NoneType]
-    return get_origin(type) is Union and NoneType in get_args(type)
+    return is_union(get_origin(type)) and NoneType in get_args(type)
 
 
 def __parse(value: any, clazz: Type, path: str, strict: bool, ignore_unexpected: bool):
@@ -68,6 +79,9 @@ def __parse(value: any, clazz: Type, path: str, strict: bool, ignore_unexpected:
                     val = f.default_factory()
                 else:
                     val = f.default
+                if is_dataclass(val):
+                    # if val is a dataclass, convert to ConfigTree
+                    val = ConfigTree(asdict(val))
 
             if not isinstance(val, _MISSING_TYPE):
                 fs[f.name] = __parse(
@@ -120,33 +134,29 @@ def __parse(value: any, clazz: Type, path: str, strict: bool, ignore_unexpected:
             }
         return None
 
-    if is_optional(clazz):
-        left, right = args
-        try:
-            return __parse(
-                value,
-                left if right is NoneType else right,
-                path,
-                strict,
-                ignore_unexpected,
-            )
-        except TypeConfigException:
-            # cannot parse Optional
-            return None
-
-    if origin is Union:
+    if is_union(origin):
+        # Optional = Union[T, NoneType]
+        has_none = False
         for parse_candidate in args:
-            try:
-                return __parse(value, parse_candidate, path, strict, ignore_unexpected)
-            except TypeConfigException:
-                continue
+            if parse_candidate is NoneType:
+                has_none = True
+            else:
+                try:
+                    return __parse(
+                        value, parse_candidate, path, strict, ignore_unexpected
+                    )
+                except TypeConfigException:
+                    continue
+
+        if has_none:
+            return None
 
         raise TypeConfigException(
             f"expected one of {', '.join(map(str, args))} at {path}, got {type(value)}"
         )
 
     if clazz is bool:
-        if not strict:
+        if not strict and value is not None:
             try:
                 value = bool(value)
             except ValueError:
@@ -154,7 +164,7 @@ def __parse(value: any, clazz: Type, path: str, strict: bool, ignore_unexpected:
         return __parse_type(value, clazz, path, isinstance(value, bool))
 
     if clazz is int:
-        if not strict:
+        if not strict and value is not None:
             try:
                 value = int(value)
             except ValueError:
@@ -162,7 +172,7 @@ def __parse(value: any, clazz: Type, path: str, strict: bool, ignore_unexpected:
         return __parse_type(value, clazz, path, isinstance(value, int))
 
     if clazz is float:
-        if not strict:
+        if not strict and value is not None:
             try:
                 value = float(value)
             except ValueError:

dataconf-2.2.2/dataconf/version.py

@@ -0,0 +1,6 @@
+import sys
+
+__version__ = "2.2.2"
+
+PY310up = sys.version_info >= (3, 10)
+PY311up = sys.version_info >= (3, 11)

{dataconf-2.2.0 → dataconf-2.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dataconf"
-version = "2.2.0"
+version = "2.2.2"
 description = "Simple dataclasses configuration management for Python with hocon/json/yaml/properties/env-vars/dict support."
 authors = []
 license = "MPL-2.0"
@@ -30,20 +30,20 @@ dataconf = 'dataconf.cli:run'
 
 [tool.poetry.dependencies]
 python = "^3.8"
-pyhocon = "0.3.60"
+pyhocon = "0.3.59"
 python-dateutil = "^2.8.2"
-PyYAML = "^6.0"
+PyYAML = "^6.0.1"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.3.1"
+pytest = "^7.4.2"
 pre-commit = ">=2.21,<4.0"
 commitizen = ">=2.42.1,<4.0.0"
-pytest-httpserver = "^1.0.6"
-ruff = ">=0.0.247,<0.0.264"
+pytest-httpserver = "^1.0.8"
+ruff = ">=0.0.247,<0.0.287"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "2.2.0"
+version = "2.2.2"
 tag_format = "v$major.$minor.$patch$prerelease"
 version_files = [
     "pyproject.toml:version",

{dataconf-2.2.0 → dataconf-2.2.2}/setup.py

@@ -8,14 +8,14 @@ package_data = \
 {'': ['*']}
 
 install_requires = \
-['PyYAML>=6.0,<7.0', 'pyhocon==0.3.60', 'python-dateutil>=2.8.2,<3.0.0']
+['PyYAML>=6.0.1,<7.0.0', 'pyhocon==0.3.59', 'python-dateutil>=2.8.2,<3.0.0']
 
 entry_points = \
 {'console_scripts': ['dataconf = dataconf.cli:run']}
 
 setup_kwargs = {
     'name': 'dataconf',
-    'version': '2.2.0',
+    'version': '2.2.2',
     'description': 'Simple dataclasses configuration management for Python with hocon/json/yaml/properties/env-vars/dict support.',
     'long_description': '# Dataconf\n\n[![Actions Status](https://github.com/zifeo/dataconf/workflows/CI/badge.svg)](https://github.com/zifeo/dataconf/actions)\n[![PyPI version](https://badge.fury.io/py/dataconf.svg)](https://badge.fury.io/py/dataconf)\n\nSimple dataclasses configuration management for Python with\nhocon/json/yaml/properties/env-vars/dict/cli support.\n\n## Getting started\n\nRequires at least Python 3.8.\n\n```bash\n# pypi\npip install dataconf\npoetry add dataconf\n\n# remote master\npip install --upgrade git+https://github.com/zifeo/dataconf.git\npoetry add git+https://github.com/zifeo/dataconf.git\n\n# local repo/dev\npoetry install\npre-commit install\n```\n\n## Usage\n\n```python\nimport os\nfrom dataclasses import dataclass, field\nfrom typing import List, Dict, Text, Union\nfrom dateutil.relativedelta import relativedelta\nfrom datetime import datetime\nimport dataconf\n\nconf = """\nstr_name = test\nstr_name = ${?HOME}\ndash-to-underscore = true\nfloat_num = 2.2\niso_datetime = "2000-01-01T20:00:00"\n# this is a comment\nlist_data = [\n    a\n    b\n]\nnested {\n    a = test\n    b : 1\n}\nnested_list = [\n    {\n        a = test1\n        b : 2.5\n    }\n]\nduration = 2s\nunion = 1\npeople {\n    name = Thailand\n}\nzone {\n    area_code = 42\n}\n"""\n\nclass AbstractBaseClass:\n    pass\n    \n@dataclass\nclass Person(AbstractBaseClass):\n    name: Text\n        \n@dataclass\nclass Zone(AbstractBaseClass):\n    area_code: int\n\n@dataclass\nclass Nested:\n    a: Text\n    b: float\n\n@dataclass\nclass Config:\n    str_name: Text\n    dash_to_underscore: bool\n    float_num: float\n    iso_datetime: datetime\n    list_data: List[Text]\n    nested: Nested\n    nested_list: List[Nested]\n    duration: relativedelta\n    union: Union[Text, int]\n    people: AbstractBaseClass\n    zone: AbstractBaseClass\n    default: Text = \'hello\'\n    default_factory: Dict[Text, Text] = field(default_factory=dict)\n\nprint(dataconf.string(conf, Config))\n# Config(\n#   str_name=\'/users/root\',\n#   dash_to_underscore=True,\n#   float_num=2.2,\n#   list_data=[\'a\', \'b\'],\n#   nested=Nested(a=\'test\'),\n#   nested_list=[Nested(a=\'test1\', b=2.5)],\n#   duration=relativedelta(seconds=+2), \n#   union=1, \n#   people=Person(name=\'Thailand\'), \n#   zone=Zone(area_code=42),\n#   default=\'hello\', \n#   default_factory={}\n# )\n\n@dataclass\nclass Example:\n    hello: str\n    world: str\n    foo: List[str]\n\nos.environ[\'DC_WORLD\'] = \'monde\'\n\nprint(\n    dataconf\n    .multi\n    .url(\'https://raw.githubusercontent.com/zifeo/dataconf/main/confs/simple.hocon\')\n    .env(\'DC\')\n    .on(Example)\n)\n# Example(hello=\'bonjour\',world=\'monde\')\n```\n\n## API\n\n```python\nimport dataconf\n\nconf = dataconf.string(\'{ name: Test }\', Config)\nconf = dataconf.string(\'name:\\n\\tvalue: Test\', Config, loader=dataconf.YAML)  # dataconf.HOCON by default\nconf = dataconf.env(\'PREFIX_\', Config)\nconf = dataconf.dict({\'name\': \'Test\'}, Config)\nconf = dataconf.url(\'https://raw.githubusercontent.com/zifeo/dataconf/master/confs/test.hocon\', Config)  # hocon, json, yaml, properties\nconf = dataconf.file(\'confs/test.hocon\', Config)  # hocon, json, yaml, properties\nconf = dataconf.cli(sys.argv, Config)\n\n# Aggregation\nconf = dataconf.multi.string(...).env(...).url(...).file(...).dict(...).cli(...).on(Config)\n\n# Same api as Python json/yaml packages (e.g. `load`, `loads`, `dump`, `dumps`)\nconf = dataconf.load(\'confs/test.hocon\', Config)  # hocon, json, yaml, properties\nconf = dataconf.load(\'confs/test.yaml\', Config, loader=dataconf.YAML)  # dataconf.HOCON by default\ndataconf.dump(\'confs/test.hocon\', conf, out=\'hocon\')\ndataconf.dump(\'confs/test.json\', conf, out=\'json\')\ndataconf.dump(\'confs/test.yaml\', conf, out=\'yaml\')\ndataconf.dump(\'confs/test.properties\', conf, out=\'properties\')\n```\n\nFor full HOCON capabilities see\n[here](https://github.com/chimpler/pyhocon/#example-of-hocon-file).\n\n## Parse env vars\n\n```bash\nPREFIX_VAR=a\nPREFIX_VAR_NAME=b\nPREFIX_TEST__NAME=c\nPREFIX_LS_0=d\nPREFIX_LS_1=e\nPREFIX_LSLS_0_0=f\nPREFIX_LSOB_0__NAME=g\nPREFIX_NESTED_="{ name: Test }"\nPREFIX_SUB_="{ value: ${PREFIX_VAR} }"\n```\n\nis equivalent to\n\n```\n{\n    var = a\n    var_name = b\n    test {\n        name = c\n    }\n    ls = [\n        d\n        e\n    ]\n    lsls = [\n        [\n            f\n        ]\n    ]\n    lsob = [\n        {\n            name = g\n        }\n    ]\n    nested {\n        # parse nested config by suffixing env var with `_`\n        name: Test\n    }\n    sub {\n        # will have value "a" at parsing, useful for aliases\n        value = ${PREFIX_VAR}\n    }\n}\n```\n\nNote that when using `.env` source, the strict mode is disabled and value might\nbe casted.\n\n## Parse CLI arguments\n\nSame as env vars parse (dashes are converted to underscore, e.g. `TEST_A` →\n`--test-a`).\n\n## CLI usage\n\nCan be used for validation or converting between supported file formats (`-o`).\n\n```shell\ndataconf -c confs/test.hocon -m tests.configs -d TestConf -o hocon\n# dataconf.exceptions.TypeConfigException: expected type <class \'datetime.timedelta\'> at .duration, got <class \'int\'>\n```\n',
     'author': 'None',

dataconf-2.2.0/dataconf/version.py

@@ -1 +0,0 @@
-__version__ = "2.2.0"