encommon 0.4.1__tar.gz → 0.5.0__tar.gz

{encommon-0.4.1 → encommon-0.5.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Enasis Network
+Copyright (c) 2024 Enasis Network
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{encommon-0.4.1/encommon.egg-info → encommon-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.4.1
+Version: 0.5.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -18,14 +18,15 @@ Requires-Dist: snaptime
 
 # Enasis Network Common Library
 
-[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)
-[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)
-[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)
-[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
-
 Common classes and functions used in various public and private projects for
 [Enasis Network](https://github.com/enasisnetwork).
 
+[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)<br>
+[![codecov](https://codecov.io/gh/enasisnetwork/encommon/graph/badge.svg?token=7PGOXKJU0E)](https://codecov.io/gh/enasisnetwork/encommon)<br>
+[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)<br>
+[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)<br>
+[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
+
 ## Installing the package
 Installing stable from the PyPi repository
 ```

{encommon-0.4.1 → encommon-0.5.0}/README.md

@@ -1,13 +1,14 @@
 # Enasis Network Common Library
 
-[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)
-[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)
-[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)
-[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
-
 Common classes and functions used in various public and private projects for
 [Enasis Network](https://github.com/enasisnetwork).
 
+[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)<br>
+[![codecov](https://codecov.io/gh/enasisnetwork/encommon/graph/badge.svg?token=7PGOXKJU0E)](https://codecov.io/gh/enasisnetwork/encommon)<br>
+[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)<br>
+[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)<br>
+[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
+
 ## Installing the package
 Installing stable from the PyPi repository
 ```

{encommon-0.4.1 → encommon-0.5.0}/encommon/config/params.py

@@ -20,7 +20,9 @@ class ConfigParams(BaseModel, extra='forbid'):
     """
     Process and validate the common configuration parameters.
 
+    :param paths: Complete or relative path to config paths.
     :param data: Keyword arguments passed to Pydantic model.
+        This parameter is picked up by autodoc, please ignore.
     """
 
     paths: Optional[list[str]] = None
@@ -31,7 +33,11 @@ class LoggerParams(BaseModel, extra='forbid'):
     """
     Process and validate the common configuration parameters.
 
+    :param stdo_level: Minimum log message severity level.
+    :param file_level: Minimum log message severity level.
+    :param file_path: Enables writing to the filesystem path.
     :param data: Keyword arguments passed to Pydantic model.
+        This parameter is picked up by autodoc, please ignore.
     """
 
     stdo_level: Optional[LOGLEVELS] = None
@@ -44,7 +50,11 @@ class Params(BaseModel, extra='forbid'):
     """
     Process and validate the common configuration parameters.
 
+    :param enconfig: Configuration for the `.Config` object.
+    :param enlogger: Configuration for the `.Logger` object.
+    :param encrypts: Configuration for the `.Crypts` object.
     :param data: Keyword arguments passed to Pydantic model.
+        This parameter is picked up by autodoc, please ignore.
     """
 
     enconfig: Optional[ConfigParams] = None

{encommon-0.4.1 → encommon-0.5.0}/encommon/config/test/test_config.py

@@ -25,7 +25,7 @@ SAMPLES = (
 
 
 
-def test_Config(
+def test_Config(  # noqa: CFQ001
     config_path: Path,
 ) -> None:
     """
@@ -108,6 +108,26 @@ def test_Config(
     assert sample == expect
 
 
+    _params1 = config.params
+    _params2 = config.params
+
+    assert _params1 is _params2
+
+    sample = load_sample(
+        path=SAMPLES.joinpath('params.json'),
+        update=ENPYRWS,
+        content=_params1.model_dump(),
+        replace={
+            'config_path': str(config_path)})
+
+    expect = prep_sample(
+        content=_params2.model_dump(),
+        replace={
+            'config_path': str(config_path)})
+
+    assert sample == expect
+
+
     logger = config.logger
 
     assert isinstance(logger, Logger)

{encommon-0.4.1 → encommon-0.5.0}/encommon/times/common.py

@@ -20,7 +20,7 @@ if TYPE_CHECKING:
 
 
 NUMERISH = compile(r'^\-?\d+(\.\d+)?$')
-SNAPABLE = compile(r'^\-|\+[\d\@a-z]+$')
+SNAPABLE = compile(r'^(\-|\+)[\d\@a-z\-\+]+$')
 STRINGNOW = {'None', 'null', 'now'}
 
 NUMERIC = Union[int, float]

{encommon-0.4.1 → encommon-0.5.0}/encommon/types/__init__.py

@@ -8,10 +8,14 @@ is permitted, for more information consult the project license file.
 
 
 from .dicts import merge_dicts
+from .dicts import sort_dict
 from .empty import Empty
+from .strings import striplower
 
 
 
 __all__ = [
     'Empty',
-    'merge_dicts']
+    'merge_dicts',
+    'sort_dict',
+    'striplower']

{encommon-0.4.1 → encommon-0.5.0}/encommon/types/dicts.py

@@ -58,3 +58,29 @@ def merge_dicts(
 
         elif force is True:
             dict1[key] = value
+
+
+
+def sort_dict(
+    value: dict[Any, Any],
+    reverse: bool = False,
+) -> dict[Any, Any]:
+    """
+    Sort the keys within the dictionary and return new one.
+
+    Example
+    -------
+    >>> foo = {'b': 'be', 'a': 'ey'}
+    >>> sort_dict(foo)
+    {'a': 'ey', 'b': 'be'}
+    >>> sort_dict(foo, True)
+    {'b': 'be', 'a': 'ey'}
+
+    :param value: Dictionary whose keys are sorted into new.
+    :param reverse: Optionally reverse the sort direction.
+    :returns: New dictionary with keys sorted alphabetical.
+    """
+
+    return dict(sorted(
+        value.items(),
+        reverse=reverse))

encommon-0.5.0/encommon/types/strings.py

@@ -0,0 +1,25 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+"""
+
+
+
+def striplower(
+    value: str,
+) -> str:
+    """
+    Return the provided string but stripped and lower cased.
+
+    Example
+    -------
+    >>> striplower('  Foo ')
+    'foo'
+
+    :param value: String which will be stripped and lowered.
+    :returns: Provided string but stripped and lower cased.
+    """
+
+    return value.strip().lower()

{encommon-0.4.1 → encommon-0.5.0}/encommon/types/test/test_dicts.py

@@ -10,6 +10,23 @@ is permitted, for more information consult the project license file.
 from copy import deepcopy
 
 from ..dicts import merge_dicts
+from ..dicts import sort_dict
+
+
+
+DICT1 = {
+    'dict1': 'dict1',
+    'str': 'd1string',
+    'list': ['d1list'],
+    'dict': {'key': 'd1value'},
+    'bool': False}
+
+DICT2 = {
+    'dict2': 'dict2',
+    'str': 'd2string',
+    'list': ['d2list'],
+    'dict': {'key': 'd2value'},
+    'bool': True}
 
 
 
@@ -18,19 +35,8 @@ def test_merge_dicts() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    dict1 = {
-        'dict1': 'dict1',
-        'str': 'd1string',
-        'list': ['d1list'],
-        'dict': {'key': 'd1value'},
-        'bool': False}
-
-    dict2 = {
-        'dict2': 'dict2',
-        'str': 'd2string',
-        'list': ['d2list'],
-        'dict': {'key': 'd2value'},
-        'bool': True}
+    dict1 = deepcopy(DICT1)
+    dict2 = deepcopy(DICT2)
 
     dict1['recurse'] = deepcopy(dict1)
     dict2['recurse'] = deepcopy(dict2)
@@ -100,3 +106,17 @@ def test_merge_dicts() -> None:
             'list': ['d1list'],
             'dict': {'key': 'd1value'},
             'bool': False}}
+
+
+
+def test_sort_dict() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert sort_dict(DICT1) == {
+        'bool': False,
+        'dict': {'key': 'd1value'},
+        'dict1': 'dict1',
+        'list': ['d1list'],
+        'str': 'd1string'}

encommon-0.5.0/encommon/types/test/test_strings.py

@@ -0,0 +1,19 @@
+"""
+Functions and routines associated with Enasis Network Common Library.
+
+This file is part of Enasis Network software eco-system. Distribution
+is permitted, for more information consult the project license file.
+"""
+
+
+
+from ..strings import striplower
+
+
+
+def test_striplower() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert striplower('  Foo ') == 'foo'

{encommon-0.4.1 → encommon-0.5.0}/encommon/utils/sample.py

@@ -98,7 +98,7 @@ def load_sample(
     :param update: Determine whether the sample is updated.
     :param content: Content which will be processed for JSON.
     :param default: Callable used when stringifying values.
-    :param replace: Optional string values to replace in path.
+    :param replace: Optional string values to replace in file.
     :returns: Content after processing using JSON functions.
     """
 

encommon-0.5.0/encommon/version.txt

@@ -0,0 +1 @@
+0.5.0

{encommon-0.4.1 → encommon-0.5.0/encommon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: encommon
-Version: 0.4.1
+Version: 0.5.0
 Summary: Enasis Network Common Library
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -18,14 +18,15 @@ Requires-Dist: snaptime
 
 # Enasis Network Common Library
 
-[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)
-[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)
-[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)
-[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
-
 Common classes and functions used in various public and private projects for
 [Enasis Network](https://github.com/enasisnetwork).
 
+[![](https://img.shields.io/github/actions/workflow/status/enasisnetwork/encommon/build.yml?style=flat-square&label=GitHub%20actions)](https://github.com/enasisnetwork/encommon/actions)<br>
+[![codecov](https://codecov.io/gh/enasisnetwork/encommon/graph/badge.svg?token=7PGOXKJU0E)](https://codecov.io/gh/enasisnetwork/encommon)<br>
+[![](https://img.shields.io/readthedocs/encommon?style=flat-square&label=Read%20the%20Docs)](https://encommon.readthedocs.io/en/stable)<br>
+[![](https://img.shields.io/pypi/v/encommon.svg?style=flat-square&label=PyPi%20version)](https://pypi.org/project/encommon)<br>
+[![](https://img.shields.io/pypi/dm/encommon?style=flat-square&label=PyPi%20downloads)](https://pypi.org/project/encommon)
+
 ## Installing the package
 Installing stable from the PyPi repository
 ```

{encommon-0.4.1 → encommon-0.5.0}/encommon.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ pyproject.toml
 reqs-install.txt
 setup.cfg
 encommon/__init__.py
+encommon/conftest.py
 encommon/py.typed
 encommon/version.txt
 encommon.egg-info/PKG-INFO
@@ -20,7 +21,6 @@ encommon/config/logger.py
 encommon/config/params.py
 encommon/config/paths.py
 encommon/config/test/__init__.py
-encommon/config/test/conftest.py
 encommon/config/test/test_common.py
 encommon/config/test/test_config.py
 encommon/config/test/test_files.py
@@ -50,9 +50,11 @@ encommon/times/test/test_window.py
 encommon/types/__init__.py
 encommon/types/dicts.py
 encommon/types/empty.py
+encommon/types/strings.py
 encommon/types/test/__init__.py
 encommon/types/test/test_dicts.py
 encommon/types/test/test_empty.py
+encommon/types/test/test_strings.py
 encommon/utils/__init__.py
 encommon/utils/common.py
 encommon/utils/match.py

encommon-0.4.1/encommon/version.txt

@@ -1 +0,0 @@
-0.4.1

{encommon-0.4.1 → encommon-0.5.0}/encommon/times/timers.py

@@ -130,8 +130,8 @@ class Timers:
         Update the existing timer from mapping within the cache.
 
         :param unique: Unique identifier for the timer in mapping.
-        :param started: Determines when the time starts for timer.
         :param minimum: Determines minimum seconds that must pass.
+        :param started: Determines when the time starts for timer.
         """
 
         timer = self.__timing