iker-python-common 1.0.67__tar.gz → 1.0.69__tar.gz

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iker-python-common
-Version: 1.0.67
+Version: 1.0.69
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker/common/utils/config.py

@@ -1,5 +1,6 @@
 import configparser
-import os.path
+import os
+import pathlib
 from typing import Self
 
 from iker.common.utils import logger
@@ -7,8 +8,11 @@ from iker.common.utils.strutils import is_blank, trim_to_empty
 
 
 class Config(object):
-    def __init__(self, config_path: str = None):
-        self.config_path = trim_to_empty(config_path)
+    def __init__(self, config_path: str | os.PathLike[str] | None = None):
+        if not is_blank(config_path := trim_to_empty(None if config_path is None else str(config_path))):
+            self.config_path = pathlib.Path(config_path)
+        else:
+            self.config_path = None
         self.config_parser: configparser.RawConfigParser = configparser.RawConfigParser(strict=False)
 
     def __len__(self):
@@ -23,26 +27,26 @@ class Config(object):
 
     def restore(self) -> bool:
         self.config_parser = configparser.RawConfigParser(strict=False)
-        if is_blank(self.config_path):
+        if self.config_path is None:
             return False
         try:
-            if not os.path.exists(self.config_path):
+            if not self.config_path.exists():
                 raise IOError("file not found")
             self.config_parser.read(self.config_path, encoding="utf-8")
             return True
         except IOError as e:
-            logger.exception("Failed to restore config from file '%s'", self.config_path)
+            logger.exception("Failed to restore config from file <'%s'>", self.config_path)
         return False
 
     def persist(self) -> bool:
-        if is_blank(self.config_path):
+        if self.config_path is None:
             return False
         try:
             with open(self.config_path, "w") as fh:
                 self.config_parser.write(fh)
             return True
         except IOError as e:
-            logger.exception("Failed to persist config to file '%s'", self.config_path)
+            logger.exception("Failed to persist config to file <'%s'>", self.config_path)
         return False
 
     def has_section(self, section: str) -> bool:

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker/common/utils/csvutils.py

@@ -153,7 +153,7 @@ class CSVView(object):
     @overload
     def load_file(
         self,
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         has_header: bool,
         ret_dict: False = False,
         **kwargs,
@@ -163,7 +163,7 @@ class CSVView(object):
     @overload
     def load_file(
         self,
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         ret_dict: False = False,
         **kwargs,
     ) -> Generator[list[Any], None, None]:
@@ -172,7 +172,7 @@ class CSVView(object):
     @overload
     def load_file(
         self,
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         has_header: bool,
         ret_dict: True = True,
         **kwargs,
@@ -182,7 +182,7 @@ class CSVView(object):
     @overload
     def load_file(
         self,
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         ret_dict: True = True,
         **kwargs,
     ) -> Generator[dict[str, Any], None, None]:
@@ -190,7 +190,7 @@ class CSVView(object):
 
     def load_file(
         self,
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         has_header: bool = True,
         ret_dict: bool = False,
         **kwargs,
@@ -215,7 +215,7 @@ class CSVView(object):
     def dump_file(
         self,
         data: Iterable[Sequence[Any] | Mapping[str, Any]],
-        file_path: os.PathLike | str,
+        file_path: str | os.PathLike[str],
         has_header: bool = True,
         **kwargs,
     ) -> None:

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker/common/utils/retry.py

@@ -165,11 +165,11 @@ class RetryWrapper(object):
                 else:
                     return self.target(*args, **kwargs)
             except Exception as e:
-                logger.exception("Function target '%s' failed on attempt '%d'", self.target, attempt_number)
+                logger.exception("Function target <'%s'> failed on attempt <%d>", self.target, attempt_number)
                 last_exception = e
                 time.sleep(self.next_wait(attempt_number))
 
-        raise RuntimeError(f"failed to execute function target '{self.target}' after '{attempt_number}' attempts")
+        raise RuntimeError(f"failed to execute function target '{self.target}' after {attempt_number} attempts")
 
 
 def retry(wait: int = None, retrials: int = None, timeout: int = None):

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker/common/utils/shutils.py

@@ -11,6 +11,7 @@ __all__ = [
     "extensions",
     "stem",
     "expanded_path",
+    "norm_path",
     "path_depth",
     "glob_match",
     "listfile",
@@ -20,7 +21,7 @@ __all__ = [
 ]
 
 
-def extension(filename: str) -> str:
+def extension(filename: str | os.PathLike[str]) -> str:
     """
     Extracts the filename extension from the given filename or path.
 
@@ -31,7 +32,7 @@ def extension(filename: str) -> str:
     return result
 
 
-def stem(filename: str, minimal: bool = False) -> str:
+def stem(filename: str | os.PathLike[str], minimal: bool = False) -> str:
     """
     Extracts the filename stem from the given filename or path.
 
@@ -51,7 +52,7 @@ def stem(filename: str, minimal: bool = False) -> str:
             return base[:-len(maximal_extension)]
 
 
-def extensions(filename: str) -> list[str]:
+def extensions(filename: str | os.PathLike[str]) -> list[str]:
     """
     Extracts all filename extensions and compound extensions from the given filename or path.
 
@@ -69,7 +70,7 @@ def extensions(filename: str) -> list[str]:
     return list(tail_iter(results))
 
 
-def expanded_path(path: str) -> str:
+def expanded_path(path: str | os.PathLike[str]) -> str:
     """
     Returns the absolute expanded path, expanding environment variables and the home tilde.
 
@@ -79,7 +80,18 @@ def expanded_path(path: str) -> str:
     return os.path.abspath(os.path.expanduser(os.path.expandvars(path)))
 
 
-def path_depth(root: str, child: str) -> int:
+def norm_path(path: str | os.PathLike[str]) -> str:
+    """
+    Returns the normalized path, collapsing redundant separators and up-level references.
+
+    :param path: The given path.
+    :return: The normalized path.
+    """
+    _, path = os.path.splitdrive(os.path.normpath(path))
+    return path
+
+
+def path_depth(root: str | os.PathLike[str], child: str | os.PathLike[str]) -> int:
     """
     Returns the relative path depth from the given ``child`` to the ``root``.
 
@@ -118,11 +130,11 @@ def glob_match(
 
 
 class CopyFuncProtocol(Protocol):
-    def __call__(self, src: str, dst: str, **kwargs) -> None: ...
+    def __call__(self, src: str | os.PathLike[str], dst: str | os.PathLike[str], **kwargs) -> None: ...
 
 
 def listfile(
-    path: str,
+    path: str | os.PathLike[str],
     *,
     include_patterns: list[str] | None = None,
     exclude_patterns: list[str] | None = None,
@@ -153,8 +165,8 @@ def listfile(
 
 
 def copy(
-    src: str,
-    dst: str,
+    src: str | os.PathLike[str],
+    dst: str | os.PathLike[str],
     *,
     include_patterns: list[str] | None = None,
     exclude_patterns: list[str] | None = None,

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker/common/utils/testutils.py

@@ -1,5 +1,4 @@
 import abc
-import os
 from decimal import Decimal
 from typing import Any, Protocol
 
@@ -9,7 +8,6 @@ from _pytest.python_api import ApproxBase, ApproxDecimal, ApproxMapping, ApproxS
 from iker.common.utils.numutils import to_decimal
 
 __all__ = [
-    "norm_path",
     "nested_approx",
     "MockedCallable",
     "CalleeMock",
@@ -18,11 +16,6 @@ __all__ = [
 ]
 
 
-def norm_path(s: str) -> str:
-    _, path = os.path.splitdrive(os.path.normpath(s))
-    return path
-
-
 class ApproxNestedMixin(ApproxBase):
     def __repr__(self) -> str:
 

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/src/iker_python_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iker-python-common
-Version: 1.0.67
+Version: 1.0.69
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/test/iker_tests/common/utils/config_test.py

@@ -1,4 +1,3 @@
-import os.path
 import unittest
 
 import ddt
@@ -299,7 +298,7 @@ class ConfigTest(unittest.TestCase):
         self.assertEqual(len(config), 0)
 
     def test_restore__from_file(self):
-        config = Config(os.path.join(resources_directory, "unittest/config/config.cfg"))
+        config = Config(resources_directory / "unittest" / "config" / "config.cfg")
 
         tuples = [
             ("dummy_section_1", "dummy_option_1", "True"),
@@ -322,7 +321,7 @@ class ConfigTest(unittest.TestCase):
             self.assertEqual(config.get(section, option), value)
 
     def test_restore__file_not_found(self):
-        config = Config(os.path.join(resources_directory, "unittest/config/missing_config.cfg"))
+        config = Config(resources_directory / "unittest" / "config" / "missing_config.cfg")
 
         self.assertFalse(config.restore())
         self.assertEqual(len(config), 0)

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/test/iker_tests/common/utils/csvutils_test.py

@@ -1,6 +1,5 @@
 import itertools
 import math
-import os.path
 import unittest
 
 import ddt
@@ -227,10 +226,10 @@ class CSVTest(unittest.TestCase):
             [None, None, None, None, None, None],
         ]
 
-        for c, t, d in zip(view_csv.load_file(os.path.join(resources_directory, "unittest/csvutils/data.csv"),
+        for c, t, d in zip(view_csv.load_file(resources_directory / "unittest" / "csvutils" / "data.csv",
                                               has_header=True,
                                               encoding="utf-8"),
-                           view_tsv.load_file(os.path.join(resources_directory, "unittest/csvutils/data.tsv"),
+                           view_tsv.load_file(resources_directory / "unittest" / "csvutils" / "data.tsv",
                                               has_header=True,
                                               encoding="utf-8"),
                            data):

{iker_python_common-1.0.67 → iker_python_common-1.0.69}/test/iker_tests/common/utils/shutils_test.py

@@ -6,10 +6,9 @@ import unittest
 import ddt
 
 from iker.common.utils.shutils import copy, listfile
-from iker.common.utils.shutils import expanded_path, path_depth
+from iker.common.utils.shutils import expanded_path, norm_path, path_depth
 from iker.common.utils.shutils import extension, extensions, stem
 from iker.common.utils.shutils import glob_match
-from iker.common.utils.testutils import norm_path
 from testenv import resources_directory
 
 work_dir = pathlib.Path.cwd
@@ -415,11 +414,11 @@ class ShUtilsTest(unittest.TestCase):
     @ddt.idata(data_listfile)
     @ddt.unpack
     def test_listfile(self, path, include_patterns, exclude_patterns, depth, expect):
-        self.assertSetEqual(set(map(norm_path, listfile(os.path.join(resources_directory, path),
+        self.assertSetEqual(set(map(norm_path, listfile(resources_directory / path,
                                                         include_patterns=include_patterns,
                                                         exclude_patterns=exclude_patterns,
                                                         depth=depth))),
-                            set(map(norm_path, map(lambda x: os.path.join(resources_directory, x), expect))))
+                            set(map(norm_path, map(lambda x: resources_directory / x, expect))))
 
     data_copy = [
         (
@@ -573,11 +572,12 @@ class ShUtilsTest(unittest.TestCase):
     @ddt.unpack
     def test_copy(self, src, dst, include_patterns, exclude_patterns, depth, expect):
         with tempfile.TemporaryDirectory() as temp_directory:
-            copy(os.path.join(resources_directory, src),
-                 os.path.join(temp_directory, dst),
+            temp_directory = pathlib.Path(temp_directory)
+            copy(resources_directory / src,
+                 temp_directory / dst,
                  include_patterns=include_patterns,
                  exclude_patterns=exclude_patterns,
                  depth=depth)
 
-            self.assertSetEqual(set(map(norm_path, listfile(os.path.join(temp_directory, dst)))),
-                                set(map(norm_path, map(lambda x: os.path.join(temp_directory, x), expect))))
+            self.assertSetEqual(set(map(norm_path, listfile(temp_directory / dst))),
+                                set(map(norm_path, map(lambda x: temp_directory / x, expect))))

iker_python_common-1.0.69/test/testenv.py

@@ -0,0 +1,15 @@
+import pathlib
+
+__all__ = [
+    "module_directory",
+    "source_directory",
+    "test_directory",
+    "resources_directory",
+    "temporary_directory",
+]
+
+module_directory: pathlib.Path = pathlib.Path(__file__).absolute().parent.parent
+source_directory: pathlib.Path = module_directory / "src"
+test_directory: pathlib.Path = module_directory / "test"
+resources_directory: pathlib.Path = module_directory / "resources"
+temporary_directory: pathlib.Path = module_directory / "tmp"

iker_python_common-1.0.67/test/testenv.py

@@ -1,15 +0,0 @@
-import os
-
-__all__ = [
-    "module_directory",
-    "source_directory",
-    "test_directory",
-    "resources_directory",
-    "temporary_directory",
-]
-
-module_directory: str = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
-source_directory: str = os.path.abspath(os.path.join(module_directory, "src"))
-test_directory: str = os.path.abspath(os.path.join(module_directory, "test"))
-resources_directory: str = os.path.abspath(os.path.join(module_directory, "resources"))
-temporary_directory: str = os.path.abspath(os.path.join(module_directory, "tmp"))