package-utils 0.4.2__tar.gz → 0.5.0__tar.gz

{package-utils-0.4.2/src/package_utils.egg-info → package-utils-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: package-utils
-Version: 0.4.2
+Version: 0.5.0
 Summary: Common utilities for Python packages
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -9,10 +9,19 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer<1,>=0.9
+Provides-Extra: context
+Requires-Dist: dacite<2,>=1.8.1; extra == "context"
+Requires-Dist: PyYaml<7,>=6.0.1; extra == "context"
+Requires-Dist: superpathlib<2,>=1.3.8; extra == "context"
+Provides-Extra: dataclasses
+Requires-Dist: dacite<2,>=1.8.1; extra == "dataclasses"
 Provides-Extra: dev
-Requires-Dist: superpathlib<2,>=1.3.7; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.3.1; extra == "dev"
-Requires-Dist: package-dev-utils<1,>=0.1.3; extra == "dev"
+Requires-Dist: dacite<2,>=1.8.1; extra == "dev"
+Requires-Dist: PyYaml<7,>=6.0.1; extra == "dev"
+Requires-Dist: superpathlib<2,>=1.3.8; extra == "dev"
+Requires-Dist: hypothesis<7,>=6.91.0; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.3.6; extra == "dev"
+Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 
 # Package Utils
 [![PyPI version](https://badge.fury.io/py/package-utils.svg)](https://badge.fury.io/py/package-utils)

{package-utils-0.4.2 → package-utils-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "package-utils"
-version = "0.4.2"
+version = "0.5.0"
 description = "Common utilities for Python packages"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
 license = {text = "MIT"}
@@ -11,10 +11,23 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+context = [
+    "dacite >=1.8.1, <2",
+    "PyYaml >=6.0.1, <7",
+    "superpathlib >=1.3.8, <2",
+]
+dataclasses = [
+    "dacite >=1.8.1, <2",
+]
 dev = [
-    "superpathlib >=1.3.7, <2",
-    "package-dev-tools >=0.3.1, <1",
-    "package-dev-utils >= 0.1.3, <1",
+    # context
+    "dacite >=1.8.1, <2",
+    "PyYaml >=6.0.1, <7",
+    "superpathlib >=1.3.8, <2",
+
+    "hypothesis >=6.91.0, <7",
+    "package-dev-tools >=0.3.6, <1",
+    "package-dev-utils >=0.1.6, <1",
 ]
 
 [project.urls]
@@ -34,11 +47,10 @@ fail_under = 100
 [tool.mypy]
 strict = true
 no_implicit_reexport = false
-explicit_package_bases = true
 
 [tool.pytest.ini_options]
 pythonpath = [
-  "src", ".",
+    "src", ".",
 ]
 
 [tool.ruff]

{package-utils-0.4.2 → package-utils-0.5.0}/src/package_utils/cli/__init__.py

@@ -7,6 +7,8 @@ T = TypeVar("T")
 __all__ = ["create_entry_point", "instantiate_from_cli_args"]
 
 
-def instantiate_from_cli_args(_class: type[T]) -> T:
+def instantiate_from_cli_args(_class: type[T], documented_object: object = None) -> T:
+    if documented_object is not None:
+        _class.__doc__ = documented_object.__doc__
     instantiate_entry_point = create_entry_point(_class)
     return instantiate_entry_point()

{package-utils-0.4.2 → package-utils-0.5.0}/src/package_utils/cli/convertors/parameter.py

@@ -35,13 +35,14 @@ class CliParameter:
         if path_class is not None:
             self.monkey_patch_path_convertor(path_class)
         self.convert_optional_syntax()
-        Option = typer.Argument if self.is_argument else typer.Option
-        return Annotated[self.annotation, Option(path_type=path_class)]
+        OptionInfo = typer.Argument if self.is_argument else typer.Option
+        option_info = OptionInfo(path_type=path_class)  # type: ignore
+        return Annotated[self.annotation, option_info]
 
     @classmethod
     def monkey_patch_path_convertor(cls, path_class: type[Path]) -> None:
-        def convert(path: Path | None) -> Path | None:
-            return None if path is None else path_class(path)
+        def convert(value: str | None = None) -> Path | None:
+            return None if value is None else path_class(value)
 
         typer.main.param_path_convertor = convert
 

package-utils-0.5.0/src/package_utils/context/__init__.py

@@ -0,0 +1 @@
+from .context import Context, Models

package-utils-0.5.0/src/package_utils/context/context.py

@@ -0,0 +1,34 @@
+from typing import Generic
+
+from .loaders import Loaders
+from .models import Config as Config_
+from .models import Models
+from .models import Options as Options_
+from .models import Secrets as Secrets_
+
+
+class Context(Generic[Options_, Config_, Secrets_]):
+    def __init__(
+        self,
+        Options: type[Options_] | None = None,
+        Config: type[Config_] | None = None,
+        Secrets: type[Secrets_] | None = None,
+    ) -> None:
+        models = Models[Options_, Config_, Secrets_](Options, Config, Secrets)
+        self.loaders = Loaders(models)
+
+    @property
+    def options(self) -> Options_:
+        return self.loaders.options.value
+
+    @options.setter
+    def options(self, options: Options_) -> None:
+        self.loaders.options.value = options
+
+    @property
+    def config(self) -> Config_:
+        return self.loaders.config.value
+
+    @property
+    def secrets(self) -> Secrets_:
+        return self.loaders.secrets.value

package-utils-0.5.0/src/package_utils/context/entry_point.py

@@ -0,0 +1,21 @@
+from collections.abc import Callable
+from typing import TypeVar
+
+from ..cli import instantiate_from_cli_args
+from .context import Context
+from .models import Config, Options, Secrets
+
+T = TypeVar("T")
+
+
+def create_entry_point(
+    method: Callable[[], T], context: Context[Options, Config, Secrets]
+) -> Callable[[], T]:
+    def entry_point() -> T:
+        if context.loaders.options.model is not None:
+            context.options = instantiate_from_cli_args(
+                context.loaders.options.model, documented_object=method
+            )
+        return method()
+
+    return entry_point

package-utils-0.5.0/src/package_utils/context/loaders/__init__.py

@@ -0,0 +1 @@
+from .loaders import Loaders

package-utils-0.5.0/src/package_utils/context/loaders/config.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import typing
+from dataclasses import dataclass
+from typing import Any, Generic, TypeVar
+
+import dacite
+from plib import Path
+
+from ..models import Config, Options
+from .options import Loader as OptionsLoader
+
+if typing.TYPE_CHECKING:
+    from _typeshed import DataclassInstance  # pragma: nocover
+
+T = TypeVar("T")
+
+
+@dataclass
+class Loader(OptionsLoader[Config], Generic[Options, Config]):
+    options_loader: OptionsLoader[Options] | None = None
+
+    def load(self) -> DataclassInstance:
+        options = None if self.options_loader is None else self.options_loader.value
+        optional_path = options and getattr(options, "config_path", None)
+        path = typing.cast(Path | None, optional_path)
+        return (
+            self.typed_model()
+            if path is None
+            else self.load_from_file(self.typed_model, path)
+        )
+
+    @classmethod
+    def load_from_file(cls, class_type: type[T], path: Path) -> T:
+        config = dacite.Config(type_hooks={Path: Path}, strict=True)
+        info = typing.cast(dict[str, Any], path.yaml)
+        return dacite.from_dict(class_type, info, config=config)

package-utils-0.5.0/src/package_utils/context/loaders/loaders.py

@@ -0,0 +1,11 @@
+from typing import Generic
+
+from ..models import Config, Models, Options, Secrets
+from . import config, options, secrets_
+
+
+class Loaders(Generic[Options, Config, Secrets]):
+    def __init__(self, models: Models[Options, Config, Secrets]) -> None:
+        self.options = options.Loader(models.Options)
+        self.config = config.Loader(models.Config, options_loader=self.options)
+        self.secrets = secrets_.Loader(models.Secrets, config_loader=self.config)

package-utils-0.5.0/src/package_utils/context/loaders/options.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import typing
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Generic, TypeVar
+
+if TYPE_CHECKING:
+    from _typeshed import DataclassInstance  # pragma: nocover
+
+Model = TypeVar("Model", bound="DataclassInstance | None")
+
+
+@dataclass
+class Loader(Generic[Model]):
+    model: type[Model] | None
+    _value: Model | None = None
+
+    @property
+    def typed_model(self) -> type[DataclassInstance]:
+        return typing.cast(type["DataclassInstance"], self.model)
+
+    @property
+    def value(self) -> Model:
+        if self._value is None and self.model is not None:
+            value = self.load()
+            self.value = typing.cast(Model, value)
+        return typing.cast(Model, self._value)
+
+    @value.setter
+    def value(self, value: Model | None) -> None:
+        self._value = value
+
+    def load(self) -> DataclassInstance:
+        return self.typed_model()

package-utils-0.5.0/src/package_utils/context/loaders/secrets_.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+import dataclasses
+import os
+import typing
+from dataclasses import dataclass, fields, is_dataclass
+from typing import Generic
+
+import cli
+import dacite
+from plib import Path
+
+from ..models import Config, Options, Secrets
+from . import options
+from .config import Loader as ConfigLoader
+
+if typing.TYPE_CHECKING:
+    from _typeshed import DataclassInstance  # pragma: nocover
+
+
+from typing import TypeVar
+
+T = TypeVar("T", bound="DataclassInstance")
+
+
+@dataclass
+class SecretLoader:
+    name: str
+
+    def load(self) -> str:
+        result = os.environ.get(self.name) or cli.get("pw", self.name)
+        return typing.cast(str, result)
+
+
+@dataclass
+class DataclassLoader(Generic[T]):
+    class_: type[T]
+
+    def load(self) -> T:
+        return dacite.from_dict(self.class_, {})
+
+
+@dataclass
+class Loader(options.Loader[Secrets], Generic[Options, Config, Secrets]):
+    config_loader: ConfigLoader[Options, Config] | None = None
+    delimiter: str = "_"
+
+    def load(self) -> DataclassInstance:
+        self.add_defaults(self.typed_model)
+        file_secrets = self.load_file_secrets()
+        return dacite.from_dict(self.typed_model, file_secrets)
+
+    def load_file_secrets(self) -> dict[str, str]:
+        config = None if self.config_loader is None else self.config_loader.value
+        path = config and getattr(config, "secrets_path", None)
+        path = typing.cast(Path, path)
+        result = {} if path is None else path.yaml
+        return typing.cast(dict[str, str], result)
+
+    def add_defaults(
+        self,
+        class_type: DataclassInstance | type[DataclassInstance],
+        parent_name: str = "",
+    ) -> None:
+        for field in fields(class_type):
+            full_name = (
+                f"{parent_name}{self.delimiter}{field.name}"
+                if parent_name
+                else field.name
+            )
+            if field.default_factory == dataclasses.MISSING:
+                if is_dataclass(field.type):
+                    self.add_defaults(field.type, full_name)
+                    field.default_factory = DataclassLoader(field.type).load
+                else:
+                    field.default_factory = SecretLoader(full_name).load

package-utils-0.5.0/src/package_utils/context/models/__init__.py

@@ -0,0 +1 @@
+from .models import Config, Models, Options, Secrets

package-utils-0.5.0/src/package_utils/context/models/models.py

@@ -0,0 +1,17 @@
+import typing
+from dataclasses import dataclass
+from typing import Any, Generic, TypeVar
+
+if typing.TYPE_CHECKING:
+    from _typeshed import DataclassInstance  # pragma: nocover
+
+Options = TypeVar("Options", bound=Any | None)
+Config = TypeVar("Config", bound="DataclassInstance | None")
+Secrets = TypeVar("Secrets", bound="DataclassInstance | None")
+
+
+@dataclass
+class Models(Generic[Options, Config, Secrets]):
+    Options: type[Options] | None = None
+    Config: type[Config] | None = None
+    Secrets: type[Secrets] | None = None

package-utils-0.5.0/src/package_utils/dataclasses/__init__.py

@@ -0,0 +1 @@
+from .mixins import SerializationMixin

package-utils-0.5.0/src/package_utils/dataclasses/mixins.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+import typing
+from dataclasses import asdict
+from typing import Any, TypeVar
+
+import dacite
+
+if typing.TYPE_CHECKING:
+    from _typeshed import DataclassInstance  # pragma: nocover
+
+T = TypeVar("T")
+
+
+class SerializationMixin:
+    @classmethod
+    def from_dict(
+        cls: type[T], items: dict[str, Any], config: dacite.Config | None = None
+    ) -> T:
+        if config is None:
+            config = dacite.Config(strict=True)
+        return dacite.from_dict(cls, items, config=config)
+
+    def dict(self: DataclassInstance) -> dict[str, Any]:
+        return asdict(self)

{package-utils-0.4.2 → package-utils-0.5.0/src/package_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: package-utils
-Version: 0.4.2
+Version: 0.5.0
 Summary: Common utilities for Python packages
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -9,10 +9,19 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer<1,>=0.9
+Provides-Extra: context
+Requires-Dist: dacite<2,>=1.8.1; extra == "context"
+Requires-Dist: PyYaml<7,>=6.0.1; extra == "context"
+Requires-Dist: superpathlib<2,>=1.3.8; extra == "context"
+Provides-Extra: dataclasses
+Requires-Dist: dacite<2,>=1.8.1; extra == "dataclasses"
 Provides-Extra: dev
-Requires-Dist: superpathlib<2,>=1.3.7; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.3.1; extra == "dev"
-Requires-Dist: package-dev-utils<1,>=0.1.3; extra == "dev"
+Requires-Dist: dacite<2,>=1.8.1; extra == "dev"
+Requires-Dist: PyYaml<7,>=6.0.1; extra == "dev"
+Requires-Dist: superpathlib<2,>=1.3.8; extra == "dev"
+Requires-Dist: hypothesis<7,>=6.91.0; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.3.6; extra == "dev"
+Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 
 # Package Utils
 [![PyPI version](https://badge.fury.io/py/package-utils.svg)](https://badge.fury.io/py/package-utils)

{package-utils-0.4.2 → package-utils-0.5.0}/src/package_utils.egg-info/SOURCES.txt

@@ -15,4 +15,16 @@ src/package_utils/cli/convertors/__init__.py
 src/package_utils/cli/convertors/class_.py
 src/package_utils/cli/convertors/dataclass.py
 src/package_utils/cli/convertors/method.py
-src/package_utils/cli/convertors/parameter.py
+src/package_utils/cli/convertors/parameter.py
+src/package_utils/context/__init__.py
+src/package_utils/context/context.py
+src/package_utils/context/entry_point.py
+src/package_utils/context/loaders/__init__.py
+src/package_utils/context/loaders/config.py
+src/package_utils/context/loaders/loaders.py
+src/package_utils/context/loaders/options.py
+src/package_utils/context/loaders/secrets_.py
+src/package_utils/context/models/__init__.py
+src/package_utils/context/models/models.py
+src/package_utils/dataclasses/__init__.py
+src/package_utils/dataclasses/mixins.py

package-utils-0.5.0/src/package_utils.egg-info/requires.txt

@@ -0,0 +1,17 @@
+typer<1,>=0.9
+
+[context]
+dacite<2,>=1.8.1
+PyYaml<7,>=6.0.1
+superpathlib<2,>=1.3.8
+
+[dataclasses]
+dacite<2,>=1.8.1
+
+[dev]
+dacite<2,>=1.8.1
+PyYaml<7,>=6.0.1
+superpathlib<2,>=1.3.8
+hypothesis<7,>=6.91.0
+package-dev-tools<1,>=0.3.6
+package-dev-utils<1,>=0.1.6

package-utils-0.4.2/src/package_utils.egg-info/requires.txt

@@ -1,6 +0,0 @@
-typer<1,>=0.9
-
-[dev]
-superpathlib<2,>=1.3.7
-package-dev-tools<1,>=0.3.1
-package-dev-utils<1,>=0.1.3