Merge pull request #373 from dbatten5/rename-types-module

Rename `types.py` module

Author: dbatten5

src/maison/config.py

@@ -10,7 +10,7 @@
 from maison import parsers
 from maison import protocols
 from maison import service
-from maison import types
+from maison import typedefs
 
 
 def _bootstrap_service(package_name: str) -> service.ConfigService:
@@ -83,7 +83,7 @@ def __str__(self) -> str:
         return f"<class '{self.__class__.__name__}'>"
 
     @property
-    def values(self) -> types.ConfigValues:
+    def values(self) -> typedefs.ConfigValues:
         """Return the user's configuration values.
 
         Returns:
@@ -92,7 +92,7 @@ def values(self) -> types.ConfigValues:
         return self._values
 
     @values.setter
-    def values(self, values: types.ConfigValues) -> None:
+    def values(self, values: typedefs.ConfigValues) -> None:
         """Set the user's configuration values."""
         self._values = values
 
@@ -145,7 +145,7 @@ def validate(
         self,
         schema: typing.Optional[type[protocols.IsSchema]] = None,
         use_schema_values: bool = True,
-    ) -> types.ConfigValues:
+    ) -> typedefs.ConfigValues:
         """Validate the configuration.
 
         Warning:

src/maison/config_parser.py

@@ -4,7 +4,7 @@
 import typing
 
 from maison import errors
-from maison import types
+from maison import typedefs
 
 
 ParserDictKey = tuple[str, typing.Union[str, None]]
@@ -13,7 +13,7 @@
 class Parser(typing.Protocol):
     """Defines the interface for a `Parser` class that's used to parse a config."""
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """Parse a config file.
 
         Args:
@@ -42,7 +42,7 @@ def register_parser(
         key = (suffix, stem)
         self._parsers[key] = parser
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """See `Parser.parse_config`."""
         key: ParserDictKey
 

src/maison/config_validator.py

@@ -1,7 +1,7 @@
 """Holds the tools for validating a user's config."""
 
 from maison import protocols
-from maison import types
+from maison import typedefs
 
 
 class Validator:
@@ -11,8 +11,8 @@ class Validator:
     """
 
     def validate(
-        self, values: types.ConfigValues, schema: type[protocols.IsSchema]
-    ) -> types.ConfigValues:
+        self, values: typedefs.ConfigValues, schema: type[protocols.IsSchema]
+    ) -> typedefs.ConfigValues:
         """See `Validator.validate`."""
         validated_schema = schema(**values)
         return validated_schema.model_dump()

src/maison/parsers/ini.py

@@ -3,7 +3,7 @@
 import configparser
 import pathlib
 
-from maison import types
+from maison import typedefs
 
 
 class IniParser:
@@ -12,7 +12,7 @@ class IniParser:
     Implements the `Parser` protocol
     """
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """See the Parser.parse_config method."""
         config = configparser.ConfigParser()
         _ = config.read(file_path)

src/maison/parsers/pyproject.py

@@ -4,7 +4,7 @@
 
 import toml
 
-from maison import types
+from maison import typedefs
 
 
 class PyprojectParser:
@@ -22,7 +22,7 @@ def __init__(self, package_name: str) -> None:
         """
         self._package_name = package_name
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """See the Parser.parse_config method."""
         try:
             pyproject_dict = dict(toml.load(file_path))

src/maison/parsers/toml.py

@@ -4,7 +4,7 @@
 
 import toml
 
-from maison import types
+from maison import typedefs
 
 
 class TomlParser:
@@ -13,7 +13,7 @@ class TomlParser:
     Implements the `Parser` protocol
     """
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """See the Parser.parse_config method."""
         try:
             return dict(toml.load(file_path))

src/maison/protocols.py

@@ -3,13 +3,13 @@
 import pathlib
 import typing
 
-from maison import types
+from maison import typedefs
 
 
 class Parser(typing.Protocol):
     """Defines the interface for a parser used to parse a config file."""
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """Parses a config file.
 
         Args:
@@ -24,7 +24,7 @@ def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
 class IsSchema(typing.Protocol):
     """Protocol for config schemas."""
 
-    def model_dump(self) -> types.ConfigValues:
+    def model_dump(self) -> typedefs.ConfigValues:
         """Convert the validated config to a dict."""
         ...
 
@@ -49,7 +49,7 @@ def get_file_path(
 class ConfigParser(typing.Protocol):
     """Defines the interface for a class that parses a config."""
 
-    def parse_config(self, file_path: pathlib.Path) -> types.ConfigValues:
+    def parse_config(self, file_path: pathlib.Path) -> typedefs.ConfigValues:
         """Parse a config.
 
         Args:
@@ -65,8 +65,8 @@ class Validator(typing.Protocol):
     """Defines the interface for a class that validates some config values."""
 
     def validate(
-        self, values: types.ConfigValues, schema: type[IsSchema]
-    ) -> types.ConfigValues:
+        self, values: typedefs.ConfigValues, schema: type[IsSchema]
+    ) -> typedefs.ConfigValues:
         """Validate a config.
 
         Args:

src/maison/service.py

@@ -5,7 +5,7 @@
 from collections.abc import Iterable
 
 from maison import protocols
-from maison import types
+from maison import typedefs
 from maison import utils
 
 
@@ -53,7 +53,7 @@ def get_config_values(
         self,
         config_file_paths: Iterable[pathlib.Path],
         merge_configs: bool,
-    ) -> types.ConfigValues:
+    ) -> typedefs.ConfigValues:
         """Get the values from config files.
 
         Args:
@@ -64,7 +64,7 @@ def get_config_values(
         Returns:
             The values from the config file(s)
         """
-        config_values: types.ConfigValues = {}
+        config_values: typedefs.ConfigValues = {}
 
         for path in config_file_paths:
             parsed_config = self.config_parser.parse_config(path)
@@ -76,8 +76,8 @@ def get_config_values(
         return config_values
 
     def validate_config(
-        self, values: types.ConfigValues, schema: type[protocols.IsSchema]
-    ) -> types.ConfigValues:
+        self, values: typedefs.ConfigValues, schema: type[protocols.IsSchema]
+    ) -> typedefs.ConfigValues:
         """Validate config values against a schema.
 
         Args:

src/maison/types.py src/maison/typedefs.pysrc/maison/types.py renamed to src/maison/typedefs.py

@@ -1,11 +1,11 @@
 """Module to hold various utils."""
 
-from maison import types
+from maison import typedefs
 
 
 def deep_merge(
-    destination: types.ConfigValues, source: types.ConfigValues
-) -> types.ConfigValues:
+    destination: typedefs.ConfigValues, source: typedefs.ConfigValues
+) -> typedefs.ConfigValues:
     """Recursively updates the destination dictionary.
 
     Usage example: