0.2.8 fix for StrictBool (#30)

spacemanspiff2007 · web-flow · commit 697a8255840b · 2023-02-08T13:49:40.000+01:00
diff --git a/.flake8 b/.flake8
@@ -13,6 +13,14 @@ ignore =
     # E303 too many blank lines
     E303,
 
+    #--------------------------------------------------------------------------
+    # PLUGINS
+    #--------------------------------------------------------------------------
+
+    # PT007 wrong values type in @pytest.mark.parametrize, expected list
+    PT007
+
+
 max-line-length = 120
 
 exclude =
diff --git a/.github/workflows/run_tox.yml b/.github/workflows/run_tox.yml
@@ -3,7 +3,19 @@ name: Tests
 on: [push, pull_request]
 
 jobs:
+  pre-commit:
+    name:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - uses: pre-commit/action@v3.0.0
+
+
   test:
+    needs: pre-commit
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,18 +1,33 @@
 repos:
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
+
   - repo: https://github.com/pycqa/isort
-    rev: v5.11.3
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort (python)
 
+
   - repo: https://github.com/PyCQA/flake8
     rev: '6.0.0'
     hooks:
     -   id: flake8
+        additional_dependencies:
+          - flake8-bugbear==23.1.20
+          - flake8-comprehensions==3.10.1
+          - flake8-pytest-style==1.6
+          - flake8-noqa==1.3
+          - pep8-naming==0.13.3
+
+
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
diff --git a/readme.md b/readme.md
@@ -157,51 +157,54 @@ sub.cancel()
 ```
 
 # Changelog
-#### 0.2.7 (09.01.2023)
+#### 0.2.8 (2023-02-08)
+- Fix for StrictBool
+
+#### 0.2.7 (2023-01-09)
 - Fixed default generation for data types that inherit from python base types
 
-#### 0.2.6 (21.12.2022)
+#### 0.2.6 (2022-12-21)
 - Fixed an issue where the default yaml file would not be created properly when using aliases in container
 
-#### 0.2.5 (21.10.2022)
+#### 0.2.5 (2022-10-21)
 - Marked package as PEP 561 compatible (py.typed)
 
-#### 0.2.4 (19.04.2022)
+#### 0.2.4 (2022-04-19)
 - Default values get validated, too
 
-#### 0.2.3 (08.04.2022)
+#### 0.2.3 (2022-04-08)
 - Added extra kwargs check for pydantic fields
 - Added option to get generated yaml as a string
 
-#### 0.2.2 (31.03.2022)
+#### 0.2.2 (2022-03-31)
 - 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)
+#### 0.2.1 (2022-03-25)
 - Allow callbacks for file defaults
 
-#### 0.2.0 (25.03.2022)
+#### 0.2.0 (2022-03-25)
 - Switched to new and more flexible API
 - File default and config default are now separated
 
-#### 0.1.2 (08.03.2022)
+#### 0.1.2 (2022-03-08)
 - Comments get nicely intended
 - Fixed an issue with nested data structures
 - Allow to specify a different value for file creation
 
-#### 0.1.1 (26.02.2022)
+#### 0.1.1 (2022-02-26)
 - Fixed an issue with dynamic defaults
 - Optional values with default None will not be created in the yaml file
 
-#### 0.1.0 (10.01.2022)
+#### 0.1.0 (2022-01-10)
 - Updated requirements
 
-#### 0.0.2 (16.09.2021)
+#### 0.0.2 (2021-09-16)
 - Validate user defaults
 - Use json representation of values to get native yaml data types
 - Use enum values instead of enum types
 
-#### 0.0.1 (14.09.2021)
+#### 0.0.1 (2021-09-14)
 - Initial release
diff --git a/requirements.txt b/requirements.txt
@@ -2,5 +2,5 @@
 -r requirements_setup.txt
 
 # testing dependencies
-pytest     >= 7.2,  < 8
-pre-commit >= 2.21, < 3
+pytest     >= 7.2, < 8
+pre-commit >= 3.0, < 3.1
diff --git a/src/easyconfig/__version__.py b/src/easyconfig/__version__.py
@@ -1 +1 @@
-__version__ = '0.2.7'
+__version__ = '0.2.8'
diff --git a/src/easyconfig/config_objs/app_config.py b/src/easyconfig/config_objs/app_config.py
@@ -8,7 +8,7 @@
 from easyconfig.__const__ import MISSING, MISSING_TYPE
 from easyconfig.yaml import cmap_from_model, CommentedMap, write_aligned_yaml, yaml_rt
 
-from ..errors import DefaultNotSet
+from ..errors import FileDefaultsNotSetError
 from .object_config import ConfigObj
 
 
@@ -60,7 +60,7 @@ def load_config_file(self, path: Union[Path, str] = None):
     def generate_default_yaml(self) -> str:
 
         if self._file_defaults is None:
-            raise DefaultNotSet()
+            raise FileDefaultsNotSetError()
 
         buffer = StringIO()
         c_map = cmap_from_model(self._file_defaults)
diff --git a/src/easyconfig/config_objs/object_config.py b/src/easyconfig/config_objs/object_config.py
@@ -33,7 +33,7 @@ def __init__(self, model: BaseModel,
         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_keys: Tuple[str, ...] = ()
         self._obj_values: Dict[str, Any] = {}
         self._obj_children: Dict[str, Union[HINT_CONFIG_OBJ, Tuple[HINT_CONFIG_OBJ, ...]]] = {}
 
@@ -75,7 +75,7 @@ def from_model(cls, model: BaseModel,
 
             if isinstance(value, BaseModel):
                 ret._obj_children[key] = attrib = cls.from_model(value, path=path + (key,), parent=ret)
-            elif isinstance(value, tuple) and all(map(lambda x: isinstance(x, BaseModel), value)):
+            elif isinstance(value, tuple) and all(isinstance(x, BaseModel) for x in value):
                 ret._obj_children[key] = attrib = tuple(
                     cls.from_model(o, path=path + (key, str(i)), parent=ret) for i, o in enumerate(value)
                 )
diff --git a/src/easyconfig/create_app_config.py b/src/easyconfig/create_app_config.py
@@ -5,7 +5,7 @@
 
 from easyconfig.__const__ import ARG_NAME_IN_FILE, MISSING, MISSING_TYPE
 from easyconfig.config_objs.app_config import AppConfig, yaml_rt
-from easyconfig.errors import ExtraKwArgsNotAllowed
+from easyconfig.errors import ExtraKwArgsNotAllowedError
 
 TYPE_WRAPPED = TypeVar('TYPE_WRAPPED', bound=BaseModel)
 TYPE_DEFAULTS = Union[BaseModel, Dict[str, Any]]
@@ -18,11 +18,13 @@ def check_field_args(model: AppConfig, allowed: FrozenSet[str]):
     for name, field in model._obj_model_fields.items():
         if not set(field.field_info.extra).issubset(allowed):
             forbidden = sorted(set(field.field_info.extra) - allowed)
-            raise ExtraKwArgsNotAllowed(f'Extra kwargs for field "{name}" of {model._last_model.__class__.__name__} '
-                                        f'are not allowed: {", ".join(forbidden)}')
+            raise ExtraKwArgsNotAllowedError(
+                f'Extra kwargs for field "{name}" of {model._last_model.__class__.__name__} are not allowed: '
+                f'{", ".join(forbidden)}'
+            )
 
     # Submodels
-    for name, sub_model in model._obj_children.items():
+    for sub_model in model._obj_children.values():
         if isinstance(sub_model, tuple):
             for _sub_model in sub_model:
                 check_field_args(model, allowed)
diff --git a/src/easyconfig/errors/__init__.py b/src/easyconfig/errors/__init__.py
@@ -1,3 +1,3 @@
-from .errors import DefaultNotSet, DuplicateSubscriptionError, ExtraKwArgsNotAllowed, \
-    FunctionCallNotAllowedError, SubscriptionAlreadyCanceledError
+from .errors import DuplicateSubscriptionError, ExtraKwArgsNotAllowedError, \
+    FileDefaultsNotSetError, FunctionCallNotAllowedError, SubscriptionAlreadyCanceledError
 from .handler import set_exception_handler
diff --git a/src/easyconfig/errors/errors.py b/src/easyconfig/errors/errors.py
@@ -10,11 +10,11 @@ class DuplicateSubscriptionError(EasyConfigError):
     pass
 
 
-class ExtraKwArgsNotAllowed(EasyConfigError):
+class ExtraKwArgsNotAllowedError(EasyConfigError):
     pass
 
 
-class DefaultNotSet(EasyConfigError):
+class FileDefaultsNotSetError(EasyConfigError):
     pass
 
 
diff --git a/src/easyconfig/yaml/from_model.py b/src/easyconfig/yaml/from_model.py
@@ -19,7 +19,7 @@ def _get_yaml_value(obj, parent_model: BaseModel, skip_none=True):
     # yaml native datatypes
     # Pydantic defines several validators that inherit from the python base type
     # Yaml can't represent those, so we cast them back to the native data type.
-    for data_type in (int, float, str, bool, bytes):
+    for data_type in (bool, int, float, str, bytes):
         if isinstance(obj, data_type):
             return data_type(obj)
 
diff --git a/tests/test_app_creation.py b/tests/test_app_creation.py
@@ -5,7 +5,7 @@
 from pydantic import BaseModel, Field, ValidationError
 
 from easyconfig import create_app_config
-from easyconfig.errors import DefaultNotSet, ExtraKwArgsNotAllowed
+from easyconfig.errors import ExtraKwArgsNotAllowedError, FileDefaultsNotSetError
 from easyconfig.models import BaseModel as EasyBaseModel
 
 
@@ -31,7 +31,7 @@ class SimpleModel(BaseModel):
     assert a.generate_default_yaml() == 'aaa: 12\n'
 
     a = create_app_config(SimpleModel(), file_values=None)
-    with pytest.raises(DefaultNotSet):
+    with pytest.raises(FileDefaultsNotSetError):
         a.generate_default_yaml()
 
 
@@ -58,7 +58,7 @@ class SimpleModelOk(BaseModel):
     class SimpleModelErr(BaseModel):
         a: int = Field(5, alias='aaa', in__file=False)
 
-    with pytest.raises(ExtraKwArgsNotAllowed) as e:
+    with pytest.raises(ExtraKwArgsNotAllowedError) as e:
         create_app_config(SimpleModelErr(aaa=99))
 
     assert str(e.value) == 'Extra kwargs for field "a" of SimpleModelErr are not allowed: in__file'
diff --git a/tests/test_implementation/test_class_signatures.py b/tests/test_implementation/test_class_signatures.py
@@ -7,8 +7,9 @@
 
 
 @pytest.mark.parametrize(
-    'mixin_cls, impl_cls', ((AppConfigMixin, AppConfig), (AppConfig, AppConfigMixin),
-                            (ConfigMixin, ConfigObj), (ConfigObj, ConfigMixin), ))
+    ('mixin_cls', 'impl_cls'),
+    ((AppConfigMixin, AppConfig), (AppConfig, AppConfigMixin), (ConfigMixin, ConfigObj), (ConfigObj, ConfigMixin), )
+)
 def test_signatures_match(mixin_cls, impl_cls):
     """Ensure that the mixin and the implementation have the same signatures"""
 
diff --git a/tests/test_implementation/test_load_file.py b/tests/test_implementation/test_load_file.py
@@ -40,19 +40,19 @@ class SimpleModel(PydanticBaseModel):
     b = cfg.b
 
     assert cfg.c == 3
-    assert cfg.a is a and a.aa == 5
-    assert cfg.b is b and b.aa == 7
+    assert cfg.a is a and a.aa == 5     # noqa: PT018
+    assert cfg.b is b and b.aa == 7     # noqa: PT018
 
     file = Path('test_file.yml', initial_value='a:\n  aa: 7\nb:\n  aa: 9\nc: 5')
     cfg.load_config_file(file)
 
     assert cfg.c == 5
-    assert cfg.a is a and a.aa == 7
-    assert cfg.b is b and b.aa == 9
+    assert cfg.a is a and a.aa == 7     # noqa: PT018
+    assert cfg.b is b and b.aa == 9     # noqa: PT018
 
     file = Path('test_file.yml', initial_value='a:\n  aa: 77\nb:\n  aa: 99\nc: 9')
     cfg.load_config_file(file)
 
     assert cfg.c == 9
-    assert cfg.a is a and a.aa == 77
-    assert cfg.b is b and b.aa == 99
+    assert cfg.a is a and a.aa == 77    # noqa: PT018
+    assert cfg.b is b and b.aa == 99    # noqa: PT018
diff --git a/tests/test_pydantic/test_field_access.py b/tests/test_pydantic/test_field_access.py
@@ -46,7 +46,7 @@ def test_mutate(capsys):
     assert m.val_int == 'asdf'
 
     # set attr
-    setattr(m, 'val_int', 88)
+    setattr(m, 'val_int', 88)   # noqa: B010
     assert m.val_int == 88
 
     for name in m.__fields__:
diff --git a/tests/yaml/test_align.py b/tests/yaml/test_align.py
@@ -5,7 +5,7 @@
 from easyconfig.yaml import CommentedMap, write_aligned_yaml, yaml_rt
 
 
-@pytest.fixture
+@pytest.fixture()
 def my_map():
     top = CommentedMap()
     top['sub_key1'] = data = CommentedMap()
@@ -41,7 +41,7 @@ def my_map():
     data['b'] = 'another long text'
     data.yaml_add_eol_comment('#\n# Another\n\n# comment', 'b')
 
-    yield top
+    return top
 
 
 def test_align(my_map: CommentedMap):
diff --git a/tests/yaml/test_yaml_value.py b/tests/yaml/test_yaml_value.py
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.2.7'`
	`1`	`+__version__ = '0.2.8'`