encommon 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

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/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/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/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

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/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/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/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/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/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/version.txt

@@ -1 +1 @@
-0.4.1
+0.5.0

{encommon-0.4.1.dist-info → encommon-0.5.0.dist-info}/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.dist-info → encommon-0.5.0.dist-info}/METADATA

@@ -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.dist-info → encommon-0.5.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 encommon/__init__.py,sha256=VoXUcphq-gcXCraaU47EtXBftF6UVuQPMGr0fuCTt9A,525
+encommon/conftest.py,sha256=TNLox448WJSUkG5Lx2PM7LWvLHiaaOvxm6tx6o02pBc,810
 encommon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-encommon/version.txt,sha256=9iGEzuh4fy9pQcggQaVyXU7cmqKT6-Xb9mRAboLsH-E,6
+encommon/version.txt,sha256=oK1QZAE5pST4ZZEVcUW_HUZ06pwGW_6iFVjw97BEMMg,6
 encommon/config/__init__.py,sha256=2ic7tK2lOQvqWmmQnMozqxCJcbyQ_sSEHmOUDUFan2U,710
 encommon/config/common.py,sha256=gaKBgkF7b7UIAhd0ESio0KpG8JfdRpz5BxNgKRptd6A,2041
 encommon/config/config.py,sha256=pvvz5lzqaXJV-9-8v8XPXVP8vpHiZ9lzGLx05pjW5gk,4855
 encommon/config/files.py,sha256=2DHz7GKOjF8FC26tY0V-E9svNMrlkSUshb2gfxqGgSo,2313
 encommon/config/logger.py,sha256=2y-VFzgM2pZzEYq48XfvrDPrtUcxyP9QjbH5OG7fv5o,13449
-encommon/config/params.py,sha256=8urH47NIIspO5MGkXdOuLRzWpmNqMnKXSagNeiIwkHw,1212
+encommon/config/params.py,sha256=IWQ-UzR8x6VxkcUddC3qhI612IFMfLW44jEjRePXK0c,1825
 encommon/config/paths.py,sha256=0EpXWn6G9IO6tuZTrWuDq53RI5xMTgDQrAlOjRLILHs,2433
 encommon/config/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
-encommon/config/test/conftest.py,sha256=TNLox448WJSUkG5Lx2PM7LWvLHiaaOvxm6tx6o02pBc,810
 encommon/config/test/test_common.py,sha256=U6XWfCLxtLmArn8P6h4cmCALzdXxV7IMUxKNU-UhwPw,731
-encommon/config/test/test_config.py,sha256=k67kmzoRhakkrB_5xmN-VrLXuELCH4k5ZUHQySxtu_s,2824
+encommon/config/test/test_config.py,sha256=SMe8ZrHRVS7jcyoFB-jBmlYTdUkBT1RrjZ9QlAW1EtE,3292
 encommon/config/test/test_files.py,sha256=OlGziUPV35yrdn2Ac8tuqmFfjHciWJADdQRvacoJNUc,2298
 encommon/config/test/test_logger.py,sha256=oLMosbxHq313oSNkdsrJe_kp0YrlcLCErIccg66zXcI,4635
 encommon/config/test/test_paths.py,sha256=vNWYqiN_wNuFCu1HHEekoJdGGJyRlucDBZTAspwxWhc,2107
@@ -23,10 +23,10 @@ encommon/crypts/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLE
 encommon/crypts/test/test_crypts.py,sha256=QDhIUVzn-n5z9tk1ZPXbZ4pBx0CRtcfqIyESYVB0kbU,2433
 encommon/crypts/test/test_hashes.py,sha256=Spixpx2qBi6iSJ8aNgmnNtz04JofUpwU-a_UjpRoiHA,1206
 encommon/times/__init__.py,sha256=w6LeTybgdsi0oM1EL9ARbAqevX7Tn46JYhbXNAaWzB0,597
-encommon/times/common.py,sha256=zDI5ztMkfLmV090jlLLK3hFzGGveasy8I_wNfOQDScg,2500
+encommon/times/common.py,sha256=xLB_GLahYKT-YrVq90RUzmiodJQ4__1YihgZZTnadgg,2506
 encommon/times/duration.py,sha256=8p-L9OItO80nnd35FYrAXbiUS8RJzavI21lXBrtLaH0,9872
 encommon/times/parse.py,sha256=ZzranxftlB6bZJ1ivkoUxD53TUfXDDUdpq9jsSJN-88,6411
-encommon/times/timers.py,sha256=N9RrnHbNMzz7nlDEgJTmLq7u_93x61MT5Ku8EHmcMEU,3212
+encommon/times/timers.py,sha256=4p2zJIieZZ8pMaKAv5CQdxUOPjVDd2f9QCpARB8gGnQ,3212
 encommon/times/times.py,sha256=Dfu6ztUsV4X4vHzOC7ds8jtYy0AVj4_R5xB6H-yzemE,9432
 encommon/times/window.py,sha256=Fx_OJfU9B0IctCyaJ5XH_HxzhGlzeRATwuhI-HlsTPA,8023
 encommon/times/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
@@ -36,25 +36,27 @@ encommon/times/test/test_parse.py,sha256=TuZG_UbIEez4Ww35vdKIie_yaKp-PiUhsNmr1ZU
 encommon/times/test/test_timers.py,sha256=F8asiUbMcIXkSstrOhQ9wrmdM2oTFAAM4sL50eQB4IA,1456
 encommon/times/test/test_times.py,sha256=DJBmRHCPkMLL9-bmc2DMhhf8zcr2rsTVAAQPavD_UmE,1986
 encommon/times/test/test_window.py,sha256=EWjXR8XREYwKrH-221CBAUwLF9GpvHtuF_CSMdQtUXI,4735
-encommon/types/__init__.py,sha256=zdSH4xILpR4FrkACwZ7Cu0Lu5F_YqltRJRhayQAcDGk,324
-encommon/types/dicts.py,sha256=76uxhJG7QEO1NViP8Kd_VAPBkcw2Wga1vgPh4ITKt7g,1616
+encommon/types/__init__.py,sha256=l2WKtDs6uC9I3dIGnrzJvz-4JLEETUJOfT509XyMQWs,420
+encommon/types/dicts.py,sha256=zJbfAsL1uiqfouBQrQgcYGoLowtkUd-Vm9536_DVK_E,2208
 encommon/types/empty.py,sha256=KrH6I0PPljaFBQ1qB1tbxFxZd8DR5rEFYhZqgLzjIsA,2675
+encommon/types/strings.py,sha256=lgrzZuiCnH1UW17EFkLYiou3kQBgs_ZK2R92_dz7gRQ,560
 encommon/types/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
-encommon/types/test/test_dicts.py,sha256=BDuoh75UHeCRdV7lthLfhd8kku_E2Bjir_VeJoxldQM,2348
+encommon/types/test/test_dicts.py,sha256=UHMvrWKnz-bPscq0Vp2uoLLFv4slvQQL2sobe5WUZ7U,2673
 encommon/types/test/test_empty.py,sha256=YUn0ROFhrWLQ30uROVqroHW4BsnFbzUZjACs3aEvrrI,981
+encommon/types/test/test_strings.py,sha256=WHXf1dnK6Qs2_0UyGYztJxpS29bnR8WKjKsvVO2WCi4,407
 encommon/utils/__init__.py,sha256=qdr2RDKlmoGrgMhwJCaTrhQXmuD_lmDxlIxOUprnRVs,784
 encommon/utils/common.py,sha256=UrowELh3PtDzpSS48nGhsAxTS_QUk96-KEJa4MlxiMA,466
 encommon/utils/match.py,sha256=4L2d2Cvr7vp3odkRCdNQ10OIW8DkEP55_NbQ6bdsReo,2462
 encommon/utils/paths.py,sha256=4EeaPsVwpv3pzoHeWmiSSGYZEud6hkD27kvbvgSpOPs,3236
-encommon/utils/sample.py,sha256=Bm5PXKRc8JmgeQsvthoBHwU1yPkbnB8zS2piI7KWP4M,3169
+encommon/utils/sample.py,sha256=hOhS6A2aB9a5kXfrst7gUSQkxuqEo2J1AFyBsJZQhHE,3169
 encommon/utils/stdout.py,sha256=0C5NTg8fAB25s5oKmsmV2VSERn22QFCZjqJ1S75SXOM,2779
 encommon/utils/test/__init__.py,sha256=PjrnBYT0efyvbaGeNx94dm3tP3EVHUHSVs-VGeLEv5g,218
 encommon/utils/test/test_match.py,sha256=QagKpTFdRo23-Y55fSaJrSMpt5jIebScKbz0h8tivrI,1124
 encommon/utils/test/test_paths.py,sha256=0ls9gWJ2B487Dr1fHDDFCZPA7gxtv56nFEYHrTkNX-U,1892
 encommon/utils/test/test_sample.py,sha256=iNV9IxXmA5KJat3jKRiZH3iutHrT6bsibwti60AhICk,1464
 encommon/utils/test/test_stdout.py,sha256=a060uA8oEHFGoVqdwB5iYxdl4R2TRSgr6Z7pMEbxibs,1675
-encommon-0.4.1.dist-info/LICENSE,sha256=04XJC5i4LRUf1A_U1EGCMJLpGodnmOFlh30yu7FAVfs,1071
-encommon-0.4.1.dist-info/METADATA,sha256=ymnId20TKS4QbdR_pEnplNsaj0_Tpql_tS4d3evYo9E,2517
-encommon-0.4.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-encommon-0.4.1.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
-encommon-0.4.1.dist-info/RECORD,,
+encommon-0.5.0.dist-info/LICENSE,sha256=otnXKCtMjPlbHs0wgZ_BWULrp3g_2dWQJ6icRk9nkgg,1071
+encommon-0.5.0.dist-info/METADATA,sha256=NJL3BwQ7cUm7Azf7NS1-ttm5v0ST4LW6G9tYD0NlIXA,2671
+encommon-0.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+encommon-0.5.0.dist-info/top_level.txt,sha256=bP8q7-5tLDNm-3XPlqn_bDENfYNug5801H_xfz3BEAM,9
+encommon-0.5.0.dist-info/RECORD,,

{encommon-0.4.1.dist-info → encommon-0.5.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any