Upgrade type annotations

Author: RobertoPrevato

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Upgrade Python versions in workflow.
 - Remove support for Python <= 3.10.
 - Remove Codecov from README and workflow.
+- Upgrade type annotations.
 
 ## [2.0.4] - 2023-12-28 :snowman_with_snow:
 

config/common/__init__.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 from collections import abc
-from typing import Any, Dict, List, Mapping, Optional, Type, TypeVar
+from typing import Any, Mapping, Type, TypeVar
 
 from deepmerge import Merger
 
@@ -97,7 +97,7 @@ def merge_values(destination: Mapping[str, Any], source: Mapping[str, Any]) -> N
 
 class ConfigurationSource(ABC):
     @abstractmethod
-    def get_values(self) -> Dict[str, Any]:
+    def get_values(self) -> dict[str, Any]:
         """Returns the values read from this source."""
 
     def __repr__(self) -> str:
@@ -112,7 +112,7 @@ def __init__(self, values: Mapping[str, Any]) -> None:
         super().__init__()
         self._values = dict(values.items())
 
-    def get_values(self) -> Dict[str, Any]:
+    def get_values(self) -> dict[str, Any]:
         return self._values
 
 
@@ -136,11 +136,11 @@ def __new__(cls, arg=None):
             return [cls(item) for item in arg]
         return arg
 
-    def __init__(self, mapping: Optional[Mapping[str, Any]] = None):
+    def __init__(self, mapping: Mapping[str, Any] | None = None):
         """
         Creates a new instance of Configuration object with the given values.
         """
-        self._data: Dict[str, Any] = dict(mapping.items()) if mapping else {}
+        self._data: dict[str, Any] = dict(mapping.items()) if mapping else {}
 
     def __contains__(self, item: str) -> bool:
         return item in self._data
@@ -166,7 +166,7 @@ def __repr__(self) -> str:
         return f"<Configuration {repr(hidden_values)}>"
 
     @property
-    def values(self) -> Dict[str, Any]:
+    def values(self) -> dict[str, Any]:
         """
         Returns a copy of the dictionary of current settings.
         """
@@ -190,13 +190,13 @@ def __init__(self, *sources: ConfigurationSource) -> None:
         object from different sources. Sources are applied in the given order and can
         override each other's settings.
         """
-        self._sources: List[ConfigurationSource] = list(sources) if sources else []
+        self._sources: list[ConfigurationSource] = list(sources) if sources else []
 
     def __repr__(self) -> str:
         return f"<ConfigurationBuilder {self._sources}>"
 
     @property
-    def sources(self) -> List[ConfigurationSource]:
+    def sources(self) -> list[ConfigurationSource]:
         return self._sources
 
     def add_source(self, source: ConfigurationSource):

config/common/files.py

@@ -1,11 +1,11 @@
 from abc import abstractmethod
 from pathlib import Path
-from typing import Any, Dict, Union
+from typing import Any
 
 from config.common import ConfigurationSource
 from config.errors import MissingConfigurationFileError
 
-PathType = Union[Path, str]
+PathType = Path | str
 
 
 class FileConfigurationSource(ConfigurationSource):
@@ -15,13 +15,13 @@ def __init__(self, file_path: PathType, optional: bool = False) -> None:
         self.optional = optional
 
     @abstractmethod
-    def read_source(self) -> Dict[str, Any]:
+    def read_source(self) -> dict[str, Any]:
         """
         Reads values from the source file path. This method is not
         used if the file does not exist.
         """
 
-    def get_values(self) -> Dict[str, Any]:
+    def get_values(self) -> dict[str, Any]:
         if not self.file_path.exists():
             if self.optional:
                 return {}

config/env/__init__.py

@@ -1,5 +1,5 @@
 import os
-from typing import Any, Dict, Optional
+from typing import Any
 
 from dotenv import load_dotenv
 
@@ -10,16 +10,16 @@
 class EnvironmentVariables(ConfigurationSource):
     def __init__(
         self,
-        prefix: Optional[str] = None,
+        prefix: str | None = None,
         strip_prefix: bool = True,
-        file: Optional[PathType] = None,
+        file: PathType | None = None,
     ) -> None:
         super().__init__()
         self.prefix = prefix
         self.strip_prefix = strip_prefix
         self._file = file
 
-    def get_values(self) -> Dict[str, Any]:
+    def get_values(self) -> dict[str, Any]:
         if self._file:
             load_dotenv(self._file)
 

config/ini/__init__.py

@@ -1,6 +1,6 @@
 import configparser
 from collections import abc
-from typing import Any, Dict
+from typing import Any
 
 from config.common.files import FileConfigurationSource
 
@@ -20,7 +20,7 @@ def _develop_configparser_values(parser):
 
 
 class INIFile(FileConfigurationSource):
-    def read_source(self) -> Dict[str, Any]:
+    def read_source(self) -> dict[str, Any]:
         parser = configparser.ConfigParser()
         parser.read(self.file_path, encoding="utf8")
         return _develop_configparser_values(parser)

config/json/__init__.py

@@ -1,10 +1,10 @@
 import json
-from typing import Any, Dict
+from typing import Any
 
 from config.common.files import FileConfigurationSource
 
 
 class JSONFile(FileConfigurationSource):
-    def read_source(self) -> Dict[str, Any]:
+    def read_source(self) -> dict[str, Any]:
         with open(self.file_path, "rt", encoding="utf-8") as source:
             return json.load(source)

config/toml/__init__.py

@@ -1,4 +1,4 @@
-from typing import Any, Callable, Dict
+from typing import Any, Callable
 
 from config.common.files import FileConfigurationSource, PathType
 
@@ -20,6 +20,6 @@ def __init__(
         super().__init__(file_path, optional)
         self.parse_float = parse_float
 
-    def read_source(self) -> Dict[str, Any]:
+    def read_source(self) -> dict[str, Any]:
         with open(self.file_path, "rb") as source:
             return tomllib.load(source, parse_float=self.parse_float)

config/user/__init__.py

@@ -2,8 +2,9 @@
 This module provides support for user settings stored locally, for development, or for
 CLIs.
 """
+
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any
 from uuid import uuid4
 
 from config.common import ConfigurationSource
@@ -37,7 +38,7 @@ class UserSettings(ConfigurationSource):
     """
 
     def __init__(
-        self, project_name: Optional[str] = None, optional: bool = True
+        self, project_name: str | None = None, optional: bool = True
     ) -> None:
         """
         Configures an instance of UserSettings that obtains values from a project file
@@ -60,6 +61,6 @@ def get_base_folder(self) -> Path:
     def settings_file_path(self) -> Path:
         return self._settings_file_path
 
-    def get_values(self) -> Dict[str, Any]:
+    def get_values(self) -> dict[str, Any]:
         """Returns the values read from this source."""
         return self._source.get_values()

config/user/cli.py

@@ -22,7 +22,7 @@ def debug(self, message):
 class UserSettingsManager(UserSettings):
     def __init__(
         self,
-        project_name: Optional[str] = None,
+        project_name: str | None = None,
     ) -> None:
         super().__init__(project_name, True)
         self.logger = ClickLogger()
@@ -120,7 +120,7 @@ def settings():
 
 @click.command(name="init")
 @click.option("--project", "-p", required=False)
-def init_settings(project: Optional[str]):
+def init_settings(project: str | None):
     """
     Initialize user settings for the current folder.
     If a project name is specified, it is used, otherwise a value is obtained
@@ -133,7 +133,7 @@ def init_settings(project: Optional[str]):
 @click.argument("key")
 @click.argument("value")
 @click.option("--project", "-p", required=False)
-def set_value(key: str, value: str, project: Optional[str]):
+def set_value(key: str, value: str, project: str | None):
     """
     Set a setting in a user file by key and value.
     If a project name is specified, it is used, otherwise a value is obtained
@@ -151,7 +151,7 @@ def set_value(key: str, value: str, project: Optional[str]):
 @click.command(name="get")
 @click.argument("key")
 @click.option("--project", "-p", required=False)
-def get_value(key: str, project: Optional[str]):
+def get_value(key: str, project: str | None):
     """
     Get a setting in a user file by key.
     If a project name is specified, it is used, otherwise a value is obtained
@@ -167,7 +167,7 @@ def get_value(key: str, project: Optional[str]):
 @click.command(name="set-many")
 @click.option("--file", help="Input file", type=click.File("r"), default=sys.stdin)
 @click.option("--project", "-p", required=False)
-def set_many_values(file, project: Optional[str]):
+def set_many_values(file, project: str | None):
     """
     Set many settings, read from a JSON file passed through stdin.
     If a project name is specified, it is used, otherwise a value is obtained
@@ -188,7 +188,7 @@ def set_many_values(file, project: Optional[str]):
 @click.command(name="del")
 @click.argument("key")
 @click.option("--project", "-p", required=False)
-def del_value(key: str, project: Optional[str]):
+def del_value(key: str, project: str | None):
     """
     Delete a setting for a project, by key.
     """
@@ -197,7 +197,7 @@ def del_value(key: str, project: Optional[str]):
 
 @click.command(name="show")
 @click.option("--project", "-p", required=False)
-def show_settings(project: Optional[str]):
+def show_settings(project: str | None):
     """
     Show the local settings for a project.
     """
@@ -214,7 +214,7 @@ def list_groups():
 
 @click.command(name="info")
 @click.option("--project", "-p", required=False)
-def show_info(project: Optional[str]):
+def show_info(project: str | None):
     """
     Show information about settings for a project.
     """

config/yaml/__init__.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any
 
 import yaml
 
@@ -12,7 +12,7 @@ def __init__(
         super().__init__(file_path, optional)
         self.safe_load = safe_load
 
-    def read_source(self) -> Dict[str, Any]:
+    def read_source(self) -> dict[str, Any]:
         with open(self.file_path, "rt", encoding="utf-8") as source:
             if self.safe_load:
                 return yaml.safe_load(source)