0.4.1

spacemanspiff2007 · web-flow · commit 2601ec057574 · 2025-04-01T10:04:03.000+02:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,7 +13,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.2
+    rev: v0.11.2
     hooks:
       - id: ruff
         name: ruff unused imports
diff --git a/.ruff.toml b/.ruff.toml
@@ -34,8 +34,6 @@ ignore = [
     "UP038",    # Use X | Y in {} call instead of (X, Y)
 
     # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
-    "ANN101",   # Missing type annotation for {name} in method
-    "ANN102",   # Missing type annotation for {name} in classmethod
     "ANN401",   # Dynamically typed expressions (typing.Any) are disallowed in {name}
 
     # https://docs.astral.sh/ruff/rules/#flake8-blind-except-ble
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 # Packages required to build the documentation
 sphinx                      == 8.1.3
-sphinx-autodoc-typehints    == 2.5.0
+sphinx-autodoc-typehints    == 3.0.1
 sphinx_rtd_theme            == 3.0.2
-sphinx-exec-code            == 0.14
+sphinx-exec-code            == 0.16
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -89,9 +89,11 @@ With the ``in_file`` argument it's possible to skip entries from appearing in th
     :language_output: yaml
     :caption_output: Generated yaml file
 
-    from pydantic import Field
     from easyconfig import AppBaseModel, create_app_config
 
+    # import Field from easyconfig to get the correct type hint for the in_file parameter
+    from easyconfig import Field
+
 
     class MySimpleAppConfig(AppBaseModel):
         retries: int = Field(5, description='Amount of retries on error')
diff --git a/readme.md b/readme.md
@@ -40,7 +40,12 @@ That way the users can have some guidance how to change the program behaviour.
 It's possible to use environment variable or files for expansion. Easyconfig will load all values
 
 # Changelog
-#### 0.4.0 (2024-01-10)
+#### 0.4.1 (2025-04-01)
+- added easyconfig.Field to have proper type hint for the ``in_file`` parameter
+
+
+# Changelog
+#### 0.4.0 (2024-12-10)
 - Minimum required python version is now 3.10
 - Added preprocessor to so it's possible to move and deprecate configuration entries
 - Added property to get the loaded configuration file
diff --git a/requirements.txt b/requirements.txt
@@ -2,9 +2,9 @@
 -r requirements_setup.txt
 
 # testing dependencies
-pre-commit  == 4.0.1
-pytest      == 8.3.4
+pre-commit  == 4.2.0
+pytest      == 8.3.5
 
 # linter
-ruff == 0.8.2
-pur  == 7.3.2
+ruff == 0.11.2
+pur  == 7.3.3
diff --git a/src/easyconfig/__const__.py b/src/easyconfig/__const__.py
@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Final, Literal
+from typing import Final, Literal, TypeAlias
 
 
 class _MissingType(Enum):
@@ -10,7 +10,7 @@ def __str__(self) -> str:
 
 
 MISSING: Final = _MissingType.MISSING_OBJ
-MISSING_TYPE: Final = Literal[_MissingType.MISSING_OBJ]
+MISSING_TYPE: TypeAlias = Literal[_MissingType.MISSING_OBJ]
 
 
 ARG_NAME_IN_FILE: Final = 'in_file'
diff --git a/src/easyconfig/__init__.py b/src/easyconfig/__init__.py
@@ -4,7 +4,7 @@
 
 # isort: split
 
-from easyconfig.models import AppBaseModel, AppBaseSettings, AppConfigMixin, BaseModel, BaseSettings, ConfigMixin
+from easyconfig.models import AppBaseModel, AppBaseSettings, AppConfigMixin, BaseModel, BaseSettings, ConfigMixin, Field
 
 
 # isort: split
diff --git a/src/easyconfig/__version__.py b/src/easyconfig/__version__.py
@@ -1 +1 @@
-__version__ = '0.4.0'
+__version__ = '0.4.1'
diff --git a/src/easyconfig/config_objs/app_config.py b/src/easyconfig/config_objs/app_config.py
@@ -56,7 +56,7 @@ def set_file_path(self, path: Path | str) -> None:
         if not self._file_path.suffix:
             self._file_path = self._file_path.with_suffix('.yml')
 
-    def load_config_dict(self, cfg: dict, /, expansion: bool = True) -> Self:
+    def load_config_dict(self, cfg: dict, *, expansion: bool = True) -> Self:
         """Load the configuration from a dictionary
 
         :param cfg: config dict which will be loaded
@@ -112,3 +112,6 @@ def generate_default_yaml(self) -> str:
         c_map = cmap_from_model(self._file_defaults)
         write_aligned_yaml(c_map, buffer, extra_indent=1)
         return buffer.getvalue()
+
+    def __repr__(self) -> str:
+        return f'<{self.__class__.__name__} {self._file_path} at {id(self)}>'
diff --git a/src/easyconfig/config_objs/object_config.py b/src/easyconfig/config_objs/object_config.py
@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from inspect import getmembers, isfunction
-from typing import TYPE_CHECKING, Any, Final
+from typing import TYPE_CHECKING, Any, Final, NoReturn
 
 from pydantic import BaseModel
 from typing_extensions import Self
@@ -181,38 +181,38 @@ def subscribe_for_changes(self, func: Callable[[], Any], *,
                 msg = f'{target} is already subscribed!'
                 raise DuplicateSubscriptionError(msg)
 
-        sub = SubscriptionParent(func, self, propagate=propagate, on_next=on_next_load)
+        sub = SubscriptionParent(func, self._obj_subscriptions.remove, propagate=propagate, on_next=on_next_load)
         self._obj_subscriptions.append(sub)
         return ConfigObjSubscription(sub, target)
 
     # -----------------------------------------------------
     # pydantic 1
     @classmethod
-    def parse_obj(cls, *args: Any, **kwargs: Any):
+    def parse_obj(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def parse_raw(cls, *args: Any, **kwargs: Any):
+    def parse_raw(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def parse_file(cls, *args: Any, **kwargs: Any):
+    def parse_file(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def from_orm(cls, *args: Any, **kwargs: Any):
+    def from_orm(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     # -----------------------------------------------------
     # pydantic 2
     @classmethod
-    def model_validate_strings(cls, *args: Any, **kwargs: Any):
+    def model_validate_strings(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def model_validate(cls, *args: Any, **kwargs: Any):
+    def model_validate(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def model_validate_json(cls, *args: Any, **kwargs: Any):
+    def model_validate_json(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
diff --git a/src/easyconfig/config_objs/subscription.py b/src/easyconfig/config_objs/subscription.py
@@ -1,28 +1,28 @@
-from collections.abc import Callable
-from typing import TYPE_CHECKING, Final
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Final
 
 from easyconfig.errors import SubscriptionAlreadyCanceledError
 
 
 if TYPE_CHECKING:
-    import easyconfig
+    from collections.abc import Callable
 
 
 class SubscriptionParent:
-    def __init__(
-        self,
-        func: Callable,
-        cfg_obj: 'easyconfig.config_objs.HINT_CONFIG_OBJ',
-        propagate: bool = False,
-        on_next: bool = False,
-    ) -> None:
+    def __init__(self, func: Callable, cancel_func: Callable[[SubscriptionParent], Any], *,
+                 propagate: bool = False, on_next: bool = False) -> None:
         self.func: Callable | None = func
-        self.cfg_obj: easyconfig.config_objs.HINT_CONFIG_OBJ | None = cfg_obj
+        self.cancel_func: Callable[[SubscriptionParent], Any] | None = cancel_func
 
         self.propagate: Final = propagate
         self.on_next: bool = on_next
 
-    def notify(self, value_changed: bool) -> bool:
+    def notify(self, value_changed: bool) -> bool:  # noqa: FBT001
+        # Already canceled - should never happen
+        if self.func is None or self.cancel_func is None:
+            return True
+
         if value_changed:
             self.on_next = False
             self.func()
@@ -37,24 +37,29 @@ def notify(self, value_changed: bool) -> bool:
         return False
 
     def cancel(self) -> None:
-        self.cfg_obj._obj_subscriptions.remove(self)
+        cancel_func = self.cancel_func
+        self.cancel_func = None
         self.func = None
-        self.cfg_obj = None
+
+        if cancel_func is not None:
+            cancel_func(self)
+        return None
 
 
 class ConfigObjSubscription:
-    def __init__(self, sub_obj: 'SubscriptionParent', target: str) -> None:
+    def __init__(self, sub_obj: SubscriptionParent, target: str) -> None:
         self._sub_obj: SubscriptionParent | None = sub_obj
         self._sub_target: Final = target
 
-    def cancel(self):
+    def cancel(self) -> None:
         """Cancel the subscription so that the function will no longer be called on changes"""
         parent = self._sub_obj
         self._sub_obj = None
 
         if parent is None:
             msg = f'Subscription for {self._sub_target} was already canceled!'
             raise SubscriptionAlreadyCanceledError(msg)
+
         parent.cancel()
 
     def __str__(self) -> str:
diff --git a/src/easyconfig/create_app_config.py b/src/easyconfig/create_app_config.py
@@ -5,7 +5,7 @@
 from pydantic import BaseModel
 
 from easyconfig.__const__ import ARG_NAME_IN_FILE, MISSING, MISSING_TYPE
-from easyconfig.config_objs.app_config import AppConfig, yaml_rt
+from easyconfig.config_objs.app_config import AppConfig, ConfigObj, yaml_rt
 from easyconfig.errors import ExtraKwArgsNotAllowedError
 
 
@@ -14,7 +14,7 @@
 
 
 # noinspection PyProtectedMember
-def check_field_args(model: AppConfig, allowed: frozenset[str]) -> None:
+def check_field_args(model: ConfigObj, allowed: frozenset[str]) -> None:
     """Check extra args of pydantic fields"""
 
     # Model fields
diff --git a/src/easyconfig/expansion/expand.py b/src/easyconfig/expansion/expand.py
@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import re
+from typing import Any
 
 from .load_file import is_path, read_file_contents
 from .load_var import read_env_var
@@ -56,7 +57,7 @@ def expand_text(text: str, /, loc: ExpansionLocation):
     return text
 
 
-def expand_obj(obj, loc: ExpansionLocation | None = None):
+def expand_obj(obj: Any, loc: ExpansionLocation | None = None):
     if loc is None:
         loc = ExpansionLocation((), ())
 
@@ -65,7 +66,7 @@ def expand_obj(obj, loc: ExpansionLocation | None = None):
             obj[key] = expand_obj(value, loc.process_obj(str(key)))
         return obj
 
-    if isinstance(obj, (list, tuple)):
+    if isinstance(obj, list):
         for i, value in enumerate(obj):
             obj[i] = expand_obj(value, loc.process_obj(f'[{i:d}]'))
         return obj
diff --git a/src/easyconfig/models/__init__.py b/src/easyconfig/models/__init__.py
@@ -1,3 +1,8 @@
+from .field import Field
+
+
+# isort: split
+
 from .app import AppConfigMixin
 from .config import ConfigMixin
 
diff --git a/src/easyconfig/models/app.py b/src/easyconfig/models/app.py
@@ -29,7 +29,7 @@ def set_file_path(self, path: Path | str) -> None:
         :param path: Path obj or str
         """
 
-    def load_config_dict(self, cfg: dict, /, expansion: bool = True) -> Self:
+    def load_config_dict(self, cfg: dict, *, expansion: bool = True) -> Self:
         """Load the configuration from a dictionary
 
         :param cfg: config dict which will be loaded
diff --git a/src/easyconfig/models/config.py b/src/easyconfig/models/config.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, NoReturn
 
 from easyconfig.errors import FunctionCallNotAllowedError
 
@@ -30,31 +30,31 @@ def subscribe_for_changes(self, func: Callable[[], Any], *,
     # -----------------------------------------------------
     # pydantic 1
     @classmethod
-    def parse_obj(cls, *args: Any, **kwargs: Any):
+    def parse_obj(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def parse_raw(cls, *args: Any, **kwargs: Any):
+    def parse_raw(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def parse_file(cls, *args: Any, **kwargs: Any):
+    def parse_file(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def from_orm(cls, *args: Any, **kwargs: Any):
+    def from_orm(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     # -----------------------------------------------------
     # pydantic 2
     @classmethod
-    def model_validate_strings(cls, *args: Any, **kwargs: Any):
+    def model_validate_strings(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def model_validate(cls, *args: Any, **kwargs: Any):
+    def model_validate(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
 
     @classmethod
-    def model_validate_json(cls, *args: Any, **kwargs: Any):
+    def model_validate_json(cls, *args: Any, **kwargs: Any) -> NoReturn:
         raise FunctionCallNotAllowedError()
diff --git a/src/easyconfig/models/convenience.py b/src/easyconfig/models/convenience.py
@@ -5,17 +5,17 @@
 from easyconfig.models import AppConfigMixin, ConfigMixin
 
 
-class BaseModel(pydantic.BaseModel, ConfigMixin):
+class BaseModel(pydantic.BaseModel, ConfigMixin):   # type: ignore[misc]
     model_config = ConfigDict(extra='forbid', validate_default=True)
 
 
-class AppBaseModel(pydantic.BaseModel, AppConfigMixin):
+class AppBaseModel(pydantic.BaseModel, AppConfigMixin):     # type: ignore[misc]
     model_config = ConfigDict(extra='forbid', validate_default=True)
 
 
-class BaseSettings(pydantic_settings.BaseSettings, ConfigMixin):
+class BaseSettings(pydantic_settings.BaseSettings, ConfigMixin):    # type: ignore[misc]
     model_config = ConfigDict(extra='forbid', validate_default=True)
 
 
-class AppBaseSettings(pydantic_settings.BaseSettings, AppConfigMixin):
+class AppBaseSettings(pydantic_settings.BaseSettings, AppConfigMixin):  # type: ignore[misc]
     model_config = ConfigDict(extra='forbid', validate_default=True)
diff --git a/src/easyconfig/models/field.py b/src/easyconfig/models/field.py
diff --git a/src/easyconfig/pre_process/base.py b/src/easyconfig/pre_process/base.py
diff --git a/src/easyconfig/pre_process/delete_entry.py b/src/easyconfig/pre_process/delete_entry.py
diff --git a/src/easyconfig/pre_process/rename_entry.py b/src/easyconfig/pre_process/rename_entry.py
diff --git a/src/easyconfig/yaml/align.py b/src/easyconfig/yaml/align.py
diff --git a/src/easyconfig/yaml/from_model.py b/src/easyconfig/yaml/from_model.py
diff --git a/src/easyconfig/yaml/yaml.py b/src/easyconfig/yaml/yaml.py
diff --git a/tests/test_pydantic/test_field_type_hint.py b/tests/test_pydantic/test_field_type_hint.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.4.0'`
	`1`	`+__version__ = '0.4.1'`