0.2.6: Fixed an issue where the default yaml file would not be created properly when using aliases in container

Author: spacemanspiff2007

.github/workflows/publish-pypi.yml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         ref: master
     - name: Set up Python 3.10
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
 

.github/workflows/run_tox.yml

@@ -8,12 +8,12 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

readme.md

@@ -157,6 +157,9 @@ sub.cancel()
 ```
 
 # Changelog
+#### 0.2.6 (21.12.2022)
+- Fixed an issue where the default yaml file would not be created properly when using aliases in container
+
 #### 0.2.5 (21.10.2022)
 - Marked package as PEP 561 compatible (py.typed)
 

requirements_setup.txt

@@ -1,3 +1,3 @@
 pydantic            >= 1.9.0,   < 2.0
 ruamel.yaml         >= 0.17,    < 0.18
-typing-extensions   >= 4.1,     < 5
+typing-extensions   >= 4.4,     < 5

src/easyconfig/__version__.py

@@ -1 +1 @@
-__version__ = '0.2.5'
+__version__ = '0.2.6'

src/easyconfig/yaml/align.py

@@ -1,22 +1,34 @@
 from io import StringIO
-from typing import Union
+from typing import Any, Optional, Tuple, Union
+
+from ruamel.yaml import CommentToken
 
 from easyconfig.yaml import yaml_rt
 
 
+def get_column(obj: Tuple[Any, Any, Optional[CommentToken], Any]):
+    if (token := obj[2]) is None:
+        return 0
+    return token.column
+
+
 def align_comments(d, extra_indent=0):
 
     # Only process when it's a data structure -> dict or list
     is_dict = isinstance(d, dict)
-    if not is_dict and not isinstance(d, list):
+    is_list = isinstance(d, list)
+    if not is_dict and not is_list:
         return None
 
     comments = d.ca.items.values()
+
     if comments:
-        max_col = max(map(lambda x: x[2].column, comments), default=0)
+        max_col = max(map(get_column, comments), default=0)
         indent_value = max_col + extra_indent
         for comment in comments:
             token = comment[2]
+            if token is None:
+                continue
             token.column = indent_value
 
             # workaround for multiline eol comments

src/easyconfig/yaml/from_model.py

@@ -1,8 +1,44 @@
+from enum import Enum
+
 from pydantic import BaseModel
 from pydantic.fields import ModelField
 
 from easyconfig.__const__ import ARG_NAME_IN_FILE, MISSING
-from easyconfig.yaml import CommentedMap
+from easyconfig.yaml import CommentedMap, CommentedSeq
+
+NoneType = type(None)
+
+
+def _get_yaml_value(obj, parent_model: BaseModel, skip_none=True):
+    # Sometimes enum is used with int/str
+    if isinstance(obj, Enum):
+        return _get_yaml_value(obj.value, parent_model=parent_model, skip_none=skip_none)
+
+    # yaml native datatypes
+    if isinstance(obj, (int, float, str, bool, bytes, NoneType)):
+        return obj
+
+    if isinstance(obj, BaseModel):
+        return cmap_from_model(obj, skip_none=skip_none)
+
+    if isinstance(obj, (list, tuple, set, frozenset)):
+        seq = CommentedSeq()
+        for value in obj:
+            seq.append(_get_yaml_value(value, parent_model=parent_model, skip_none=skip_none))
+        return seq
+
+    if isinstance(obj, dict):
+        ret = CommentedMap()
+        for key, value in obj.items():
+            yaml_key = _get_yaml_value(key, parent_model=parent_model, skip_none=skip_none)
+            ret[yaml_key] = _get_yaml_value(value, parent_model=parent_model, skip_none=skip_none)
+        return ret
+
+    # YAML can't serialize all data pydantic types natively, so we use the json serializer of the model
+    # This works since a valid json is always a valid YAML. It's not nice but it's something!
+    model_cfg = parent_model.__config__
+    str_val = model_cfg.json_dumps(obj, default=parent_model.__json_encoder__)
+    return model_cfg.json_loads(str_val)
 
 
 def cmap_from_model(model: BaseModel, skip_none=True) -> CommentedMap:
@@ -20,15 +56,8 @@ def cmap_from_model(model: BaseModel, skip_none=True) -> CommentedMap:
         if not field_info.extra.get(ARG_NAME_IN_FILE, True):
             continue
 
-        if isinstance(value, BaseModel):
-            cmap[yaml_key] = cmap_from_model(value)
-        else:
-            # YAML can't serialize all data pydantic types natively, so we use the json serializer of the model
-            # This works since a valid json is always a valid YAML. It's not nice but it's something!
-            mode_cfg = model.__config__
-            _json_value = mode_cfg.json_dumps(
-                {'obj': value}, default=model.__json_encoder__)
-            cmap[yaml_key] = mode_cfg.json_loads(_json_value)['obj']
+        # get yaml representation
+        cmap[yaml_key] = _get_yaml_value(value, parent_model=model)
 
         if not description:
             continue

tests/test_app_creation.py

@@ -1,8 +1,12 @@
+from enum import Enum
+from typing import List
+
 import pytest
 from pydantic import BaseModel, Field, ValidationError
 
 from easyconfig import create_app_config
 from easyconfig.errors import DefaultNotSet, ExtraKwArgsNotAllowed
+from easyconfig.models import BaseModel as EasyBaseModel
 
 
 def test_simple():
@@ -58,3 +62,19 @@ class SimpleModelErr(BaseModel):
         create_app_config(SimpleModelErr(aaa=99))
 
     assert str(e.value) == 'Extra kwargs for field "a" of SimpleModelErr are not allowed: in__file'
+
+
+def test_list_of_models():
+
+    class MyEnum(str, Enum):
+        A = 'aa'
+
+    class SimpleModel(EasyBaseModel):
+        a: int = Field(5, alias='aaa', in_file=False)
+        b: int = Field(6)
+        c: MyEnum = MyEnum.A
+
+    class EncapModel(EasyBaseModel):
+        c: List[SimpleModel] = []
+
+    create_app_config(EncapModel(c=[SimpleModel(), SimpleModel(), ]))

tests/yaml/test_model_to_yaml.py

@@ -1,5 +1,6 @@
 from datetime import datetime
-from typing import Optional
+from enum import Enum
+from typing import List, Optional
 
 from pydantic import BaseModel, Field
 
@@ -115,3 +116,24 @@ class SimpleModel(BaseModel):
         'b: 3 # \n' \
         '# This is\n' \
         '# value b\n'
+
+
+def test_alias_not_in_file():
+
+    class MyEnum(str, Enum):
+        A = 'aa'
+
+    class SimpleModel(BaseModel):
+        a: int = Field(5, alias='aaa', in_file=False)
+        b: int = Field(6, description='Description value b')
+        c: MyEnum = MyEnum.A
+
+    class EncapModel(BaseModel):
+        my_list: List[SimpleModel] = []
+
+    assert dump_yaml(cmap_from_model(EncapModel(my_list=[SimpleModel(), SimpleModel(b=5), ]))) == \
+        'my_list:\n' \
+        '- b: 6  # Description value b\n' \
+        '  c: aa\n' \
+        '- b: 5  # Description value b\n' \
+        '  c: aa\n'