0.2.2

Author: spacemanspiff2007

.github/workflows/publish-pypi.yml

@@ -12,10 +12,10 @@ jobs:
     - uses: actions/checkout@v2
       with:
         ref: master
-    - name: Set up Python 3.8
+    - name: Set up Python 3.10
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
 
     - name: Install setuptools
       run: |

readme.md

@@ -32,6 +32,9 @@ It will create a mutable object from the model that holds the same values.
 Easyconfig also provides some mixin classes, so you can have type hints for the file load functions.
 These mixins are not required, they are just there to provide type hints in the IDE.
 
+For convenience reasons you can also import ``AppBaseModel`` and ``BaseModel`` from ``easyconfig`` so you don't have to
+inherit from the mixins yourself.
+
 ### Simple example
 
 ```python
@@ -65,18 +68,20 @@ port: 443
 
 ### Nested example
 
+Nested example with the convenience base classes from easyconfig.
+
 ```python
-from pydantic import BaseModel, Field
-from easyconfig import AppConfigMixin, ConfigMixin, create_app_config
+from pydantic import Field
+from easyconfig import AppBaseModel, BaseModel, create_app_config
 
 
-class HttpConfig(BaseModel, ConfigMixin):
+class HttpConfig(BaseModel):
     retries: int = 5
     url: str = 'localhost'
     port: int = 443
 
 
-class MyAppSimpleConfig(BaseModel, AppConfigMixin):
+class MyAppSimpleConfig(AppBaseModel):
     run_at: int = Field(12, alias='run at')  # use alias to load from/create a different key
     http: HttpConfig = HttpConfig()
 
@@ -94,16 +99,17 @@ http:
   port: 443
 ```
 
+
 ### Comments
 It's possible to specify a description through the pydantic ``Field``.
 The description will be created as a comment in the .yml file
 
 ```python
-from pydantic import BaseModel, Field
-from easyconfig import AppConfigMixin, create_app_config
+from pydantic import Field
+from easyconfig import AppBaseModel, create_app_config
 
 
-class MySimpleAppConfig(BaseModel, AppConfigMixin):
+class MySimpleAppConfig(AppBaseModel):
     retries: int = Field(5, description='Amount of retries on error')
     url: str = 'localhost'
     port: int = 443
@@ -125,11 +131,10 @@ when the configuration gets loaded for the first time. A useful feature if the a
 of the configuration file (e.g. through a file watcher).
 
 ```python
-from pydantic import BaseModel
-from easyconfig import AppConfigMixin, create_app_config
+from easyconfig import AppBaseModel, create_app_config
 
 
-class MySimpleAppConfig(BaseModel, AppConfigMixin):
+class MySimpleAppConfig(AppBaseModel):
     retries: int = 5
     url: str = 'localhost'
     port: int = 443
@@ -152,6 +157,12 @@ sub.cancel()
 ```
 
 # Changelog
+#### 0.2.2 (25.03.2022)
+- Added convenience base classes ``AppBaseModel`` and ``BaseModel``
+- Works with private attributes and class functions
+- Fixed an issue where multiline comments would not be created properly
+- Added an option to exclude entries from config file
+
 #### 0.2.1 (25.03.2022)
 - Allow callbacks for file defaults
 

requirements.txt

@@ -1,7 +1,5 @@
 # runtime dependencies
-pydantic            >= 1.9.0,   < 2.0
-ruamel.yaml         >= 0.17,    < 0.18
-typing-extensions   >= 4.1,     < 5
+-r requirements_setup.txt
 
 # testing dependencies
 pytest     >= 7.1,  < 8

src/easyconfig/__init__.py

@@ -3,7 +3,7 @@
 
 # isort: split
 
-from easyconfig.models import AppConfigMixin, ConfigMixin
+from easyconfig.models import AppBaseModel, AppBaseSettings, AppConfigMixin, BaseModel, BaseSettings, ConfigMixin
 
 # isort: split
 

src/easyconfig/__version__.py

@@ -1 +1 @@
-__version__ = '0.2.1'
+__version__ = '0.2.2'

src/easyconfig/config_objs/object_config.py

@@ -1,9 +1,11 @@
+from inspect import getmembers, isfunction
 from typing import Any, Callable, Dict, List, Tuple, Type, TYPE_CHECKING, TypeVar, Union
 
 from pydantic import BaseModel
 from pydantic.fields import ModelField
 from typing_extensions import Final
 
+from easyconfig import AppConfigMixin
 from easyconfig.__const__ import MISSING, MISSING_TYPE
 from easyconfig.config_objs import ConfigObjSubscription, SubscriptionParent
 from easyconfig.errors import DuplicateSubscriptionError, FunctionCallNotAllowedError
@@ -16,6 +18,9 @@
 HINT_CONFIG_OBJ_TYPE = Type[HINT_CONFIG_OBJ]
 
 
+NO_COPY = [n for n, o in getmembers(AppConfigMixin) if isfunction(o)]
+
+
 class ConfigObj:
     def __init__(self, model: BaseModel,
                  path: Tuple[str, ...] = ('__root__', ),
@@ -24,8 +29,9 @@ def __init__(self, model: BaseModel,
         self._obj_parent: Final = parent
         self._obj_path: Final = path
 
-        self._obj_model_fields: Dict[str, ModelField] = model.__fields__
         self._obj_model_class: Final = model.__class__
+        self._obj_model_fields: Dict[str, ModelField] = model.__fields__
+        self._obj_model_private_attrs: List[str] = list(model.__private_attributes__.keys())
 
         self._obj_keys: Tuple[str, ...] = tuple()
         self._obj_values: Dict[str, Any] = {}
@@ -40,8 +46,21 @@ def from_model(cls, model: BaseModel,
                    path: Tuple[str, ...] = ('__root__', ),
                    parent: Union[MISSING_TYPE, HINT_CONFIG_OBJ] = MISSING):
 
-        ret = cls(model, path, parent)
-
+        # Copy functions from the class definition to the child class
+        functions = {}
+        for name, member in getmembers(model.__class__):
+            if not name.startswith('_') and name not in NO_COPY and isfunction(member):
+                functions[name] = member
+
+        # Create a new class that pulls down the user defined functions if there are any
+        # It's not possible to attach the functions to the existing class instance
+        if functions:
+            new_cls = type(f'{model.__class__.__name__}{cls.__name__}', (cls, ), functions)
+            ret = new_cls(model, path, parent)
+        else:
+            ret = cls(model, path, parent)
+
+        # Set the values or create corresponding subclasses
         keys = []
         for key in ret._obj_model_fields.keys():
             value = getattr(model, key, MISSING)
@@ -62,13 +81,27 @@ def from_model(cls, model: BaseModel,
             # set child and values
             setattr(ret, key, attrib)
 
+        # copy private attributes - these are the same as values
+        for key in ret._obj_model_private_attrs:
+            value = getattr(model, key, MISSING)
+            if value is MISSING:
+                continue
+
+            keys.append(key)
+
+            ret._obj_values[key] = value
+            setattr(ret, key, value)
+
         ret._obj_keys = tuple(keys)
         return ret
 
     def _set_values(self, obj: BaseModel) -> bool:
         if not isinstance(obj, BaseModel):
             raise ValueError(f'Instance of {BaseModel.__class__.__name__} expected, got {obj} ({type(obj)})!')
 
+        # Update last model so we can delegate function calls
+        self._last_model = obj
+
         value_changed = False
 
         # Values of child objects
@@ -88,7 +121,7 @@ def _set_values(self, obj: BaseModel) -> bool:
             value = getattr(obj, key, MISSING)
             if value is MISSING:
                 continue
-            old_value = self._obj_values[key]
+            old_value = self._obj_values.get(key, MISSING)
             self._obj_values[key] = value
 
             # Update only values, child objects change in place
@@ -107,9 +140,9 @@ def _set_values(self, obj: BaseModel) -> bool:
     def __repr__(self):
         return f'<{self.__class__.__name__} {".".join(self._obj_path)}>'
 
-    def __getattr__(self, item):
-        # delegate call to model
-        return getattr(self._last_model, item)
+    # def __getattr__(self, item):
+    #     # delegate call to model
+    #     return getattr(self._last_model, item)
 
     # ------------------------------------------------------------------------------------------------------------------
     # Match class signature with the Mixin Classes

src/easyconfig/models/__init__.py

@@ -1,2 +1,7 @@
 from .app import AppConfigMixin
 from .config import ConfigMixin
+
+# isort: split
+
+# Convenience Classes with sensible defaults
+from .convenience import AppBaseModel, AppBaseSettings, BaseModel, BaseSettings

src/easyconfig/models/convenience.py

@@ -0,0 +1,27 @@
+import pydantic
+
+from easyconfig.models import AppConfigMixin, ConfigMixin
+
+
+class BaseModel(pydantic.BaseModel, ConfigMixin):
+
+    class Config:
+        extra = pydantic.Extra.forbid
+
+
+class AppBaseModel(pydantic.BaseModel, AppConfigMixin):
+
+    class Config:
+        extra = pydantic.Extra.forbid
+
+
+class BaseSettings(pydantic.BaseSettings, ConfigMixin):
+
+    class Config:
+        extra = pydantic.Extra.forbid
+
+
+class AppBaseSettings(pydantic.BaseSettings, AppConfigMixin):
+
+    class Config:
+        extra = pydantic.Extra.forbid

src/easyconfig/yaml/align.py

@@ -6,16 +6,31 @@
 
 def align_comments(d, extra_indent=0):
 
-    # Only process when its a data structure -> dict or list
+    # 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):
         return None
 
     comments = d.ca.items.values()
     if comments:
         max_col = max(map(lambda x: x[2].column, comments), default=0)
+        indent_value = max_col + extra_indent
         for comment in comments:
-            comment[2].column = max_col + extra_indent
+            token = comment[2]
+            token.column = indent_value
+
+            # workaround for multiline eol comments
+            if '\n' in token.value:
+                c_lines = token.value.splitlines()  # type: list[str]
+                for i, line in enumerate(c_lines):
+                    # first line is automatically indendet correctly
+                    if not i:
+                        continue
+
+                    _line = line.lstrip()
+                    if _line:
+                        c_lines[i] = indent_value * ' ' + _line
+                token.value = '\n'.join(c_lines)
 
     for element in (d.values() if is_dict else d):
         align_comments(element, extra_indent=extra_indent)

src/easyconfig/yaml/from_model.py

@@ -12,8 +12,13 @@ def cmap_from_model(model: BaseModel, skip_none=True) -> CommentedMap:
         if value is MISSING or (skip_none and value is None):
             continue
 
+        field_info = field.field_info
+
         yaml_key = field.alias
-        description = field.field_info.description
+        description = field_info.description
+
+        if not field_info.extra.get('in_file', True):
+            continue
 
         if isinstance(value, BaseModel):
             cmap[yaml_key] = cmap_from_model(value)
@@ -27,7 +32,15 @@ def cmap_from_model(model: BaseModel, skip_none=True) -> CommentedMap:
 
         if not description:
             continue
+
+        # Don't overwrite comment
         if yaml_key not in cmap.ca.items:
-            cmap.yaml_add_eol_comment(description, yaml_key)
+            # Ensure that every line in the comment that has chars has a comment sign
+            comment_lines = []
+            for line in description.splitlines():
+                _line = line.lstrip()
+                comment_lines.append(('# ' + line) if _line and not _line.startswith('#') else line)
+
+            cmap.yaml_add_eol_comment('\n'.join(comment_lines), yaml_key)
 
     return cmap