encommon 0.13.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

encommon/times/windows.py

@@ -21,7 +21,7 @@ from sqlalchemy.orm import sessionmaker
 
 from .common import PARSABLE
 from .params import WindowsParams
-from .times import Times
+from .time import Time
 from .window import Window
 
 if TYPE_CHECKING:
@@ -114,8 +114,8 @@ class Windows:
         # pylint: disable=unsubscriptable-object
         sessionmaker[Session])
 
-    __start: Times
-    __stop: Times
+    __start: Time
+    __stop: Time
 
     __windows: WINDOWS
 
@@ -147,8 +147,8 @@ class Windows:
         self.__make_engine()
 
 
-        start = Times(start)
-        stop = Times(stop)
+        start = Time(start)
+        stop = Time(stop)
 
         assert stop > start
 
@@ -249,27 +249,27 @@ class Windows:
     @property
     def start(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__start)
+        return Time(self.__start)
 
 
     @property
     def stop(
         self,
-    ) -> Times:
+    ) -> Time:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__stop)
+        return Time(self.__stop)
 
 
     @property
@@ -386,7 +386,7 @@ class Windows:
 
         for unique, window in items:
 
-            update = Times('now')
+            update = Time('now')
 
             append = WindowsTable(
                 group=group,

encommon/types/__init__.py

@@ -7,27 +7,45 @@ is permitted, for more information consult the project license file.
 
 
 
+from .classes import BaseModel
+from .classes import clsname
+from .classes import lattrs
 from .dicts import merge_dicts
 from .dicts import sort_dict
 from .empty import Empty
+from .lists import inlist
 from .notate import delate
 from .notate import getate
 from .notate import setate
 from .strings import hasstr
 from .strings import inrepr
 from .strings import instr
-from .strings import striplower
+from .strings import rplstr
+from .strings import strplwr
+from .types import DictStrAny
+from .types import NCFalse
+from .types import NCNone
+from .types import NCTrue
 
 
 
 __all__ = [
+    'BaseModel',
+    'clsname',
     'delate',
+    'DictStrAny',
     'Empty',
     'getate',
     'hasstr',
+    'inlist',
     'inrepr',
     'instr',
+    'lattrs',
     'merge_dicts',
+    'rplstr',
     'setate',
     'sort_dict',
-    'striplower']
+    'strplwr',
+    'NCTrue',
+    'NCFalse',
+    'NCNone']

encommon/types/classes.py

@@ -0,0 +1,84 @@
+"""
+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 pydantic import BaseModel as Pydantic
+
+from .types import DictStrAny
+
+
+
+class BaseModel(Pydantic, extra='forbid'):
+    """
+    Pydantic base model but with added methods and routines.
+
+    :param data: Keyword arguments passed to Pydantic model.
+    """
+
+
+    @property
+    def model_dumped(
+        self,
+    ) -> DictStrAny:
+        """
+        Return the facts about the attributes from the instance.
+
+        :returns: Facts about the attributes from the instance.
+        """
+
+        return self.model_dump()
+
+
+    @property
+    def model_pruned(
+        self,
+    ) -> DictStrAny:
+        """
+        Return the facts about the attributes from the instance.
+
+        :returns: Facts about the attributes from the instance.
+        """
+
+        return self.model_dump(
+            exclude_none=True)
+
+
+
+def clsname(
+    cls: object,
+) -> str:
+    """
+    Return the actual definition name for the Python class.
+
+    :param cls: Provided Python class related to operation.
+    :returns: Actual definition name for the Python class.
+    """
+
+    assert hasattr(
+        cls, '__class__')
+
+    _cls = cls.__class__
+
+    assert hasattr(
+        _cls, '__name__')
+
+    return str(_cls.__name__)
+
+
+
+def lattrs(
+    cls: object,
+) -> list[str]:
+    """
+    Return the list of attributes which are found in class.
+
+    :param cls: Provided Python class related to operation.
+    :returns: List of attributes which are found in class.
+    """
+
+    return list(cls.__dict__)

encommon/types/lists.py

@@ -0,0 +1,33 @@
+"""
+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 typing import Any
+from typing import Sequence
+
+
+
+def inlist(
+    needle: Any,  # noqa: ANN401
+    haystack: Sequence[Any],
+) -> bool:
+    """
+    Return the boolean indicating whether needle in haystack.
+
+    Example
+    -------
+    >>> haystack = [1, 2, 3]
+    >>> inlist(2, haystack)
+    True
+
+    :param needle: Provided item that may be within haystack.
+    :param haystack: List of items which may contain needle.
+    :returns: Boolean indicating whether needle in haystack.
+    """
+
+    return needle in haystack

encommon/types/notate.py

@@ -15,6 +15,7 @@ from typing import Optional
 from typing import Union
 
 from .empty import Empty
+from .types import DictStrAny
 
 
 
@@ -25,7 +26,7 @@ _RECURSE = dict
 
 
 _SETABLE = Union[
-    dict[str, Any],
+    DictStrAny,
     list[Any]]
 
 _GETABLE = Union[

encommon/types/strings.py

@@ -21,22 +21,24 @@ SPACED = ' '
 
 
 
-def striplower(
-    value: str,
+def strplwr(
+    value: Any,  # noqa: ANN401
 ) -> str:
     """
     Return the provided string but stripped and lower cased.
 
     Example
     -------
-    >>> striplower('  Foo ')
+    >>> strplwr('  Foo ')
     'foo'
 
     :param value: String which will be stripped and lowered.
     :returns: Provided string but stripped and lower cased.
     """
 
-    return value.strip().lower()
+    _value = str(value)
+
+    return _value.strip().lower()
 
 
 
@@ -108,3 +110,31 @@ def instr(
     """
 
     return hasstr(str(haystack), needle)
+
+
+
+def rplstr(
+    source: str,
+    match: str,
+    value: Any,  # noqa: ANN401
+) -> str:
+    """
+    Return the source string with the match value replaced.
+
+    Example
+    -------
+    >>> rplstr('foo', 'foo', 'bar')
+    'bar'
+
+    :param source: String that to be processed and returned.
+    :param match: What will be replaced within the string.
+    :param value: Replace value for the string is matched.
+    :returns: Source string with the match value replaced.
+    """
+
+    match = str(match)
+    value = str(value)
+
+    return (
+        str(source)
+        .replace(match, value))

encommon/types/test/test_classes.py

@@ -0,0 +1,74 @@
+"""
+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 typing import TYPE_CHECKING
+
+from ..classes import clsname
+from ..classes import lattrs
+from ...config import LoggerParams
+
+if TYPE_CHECKING:
+    from ...config import Config
+
+
+
+def test_BaseModel() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    params = LoggerParams(
+        stdo_level='info')
+
+    dumped = params.model_dumped
+    pruned = params.model_pruned
+
+    assert dumped == {
+        'file_level': None,
+        'file_path': None,
+        'stdo_level': 'info'}
+
+    assert pruned == {
+        'stdo_level': 'info'}
+
+
+
+def test_clsname(
+    config: 'Config',
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param config: Primary class instance for configuration.
+    """
+
+    assert clsname(config) == 'Config'
+
+
+
+def test_lattrs(
+    config: 'Config',
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param config: Primary class instance for configuration.
+    """
+
+    attrs = lattrs(config)
+
+    assert attrs == [
+        '_Config__model',
+        '_Config__files',
+        '_Config__cargs',
+        '_Config__sargs',
+        '_Config__params',
+        '_Config__paths',
+        '_Config__logger',
+        '_Config__crypts']

encommon/types/test/test_empty.py

@@ -10,6 +10,7 @@ is permitted, for more information consult the project license file.
 from copy import copy
 from copy import deepcopy
 
+from ..classes import lattrs
 from ..empty import Empty
 from ..empty import EmptyType
 
@@ -23,7 +24,7 @@ def test_EmptyType() -> None:
     empty = EmptyType()
 
 
-    attrs = list(empty.__dict__)
+    attrs = lattrs(empty)
 
     assert attrs == [
         '_EmptyType__empty']

encommon/types/test/test_lists.py

@@ -0,0 +1,23 @@
+"""
+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 ..lists import inlist
+
+
+
+def test_inlist() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    needle = 123
+
+    haystack = [123, 456]
+
+    assert inlist(needle, haystack)

encommon/types/test/test_strings.py

@@ -10,16 +10,17 @@ is permitted, for more information consult the project license file.
 from ..strings import hasstr
 from ..strings import inrepr
 from ..strings import instr
-from ..strings import striplower
+from ..strings import rplstr
+from ..strings import strplwr
 
 
 
-def test_striplower() -> None:
+def test_strplwr() -> None:
     """
     Perform various tests associated with relevant routines.
     """
 
-    assert striplower(' Foo ') == 'foo'
+    assert strplwr(' Foo ') == 'foo'
 
 
 
@@ -59,3 +60,14 @@ def test_instr() -> None:
     item = MyClass()
 
     assert instr('MyClass', item)
+
+
+
+def test_rplstr() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    string = rplstr('foo', 'o', 'O')
+
+    assert string == 'fOO'

encommon/types/types.py

@@ -0,0 +1,20 @@
+"""
+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 typing import Any
+
+
+
+DictStrAny = dict[str, Any]
+
+
+
+NCTrue = True
+NCFalse = False
+NCNone = None

encommon/utils/__init__.py

@@ -16,6 +16,8 @@ from .paths import resolve_paths
 from .paths import stats_path
 from .sample import load_sample
 from .sample import prep_sample
+from .sample import read_sample
+from .sample import rvrt_sample
 from .stdout import array_ansi
 from .stdout import kvpair_ansi
 from .stdout import make_ansi
@@ -32,7 +34,9 @@ __all__ = [
     'make_ansi',
     'prep_sample',
     'print_ansi',
+    'read_sample',
     'read_text',
+    'rvrt_sample',
     'resolve_path',
     'resolve_paths',
     'rgxp_match',

encommon/utils/paths.py

@@ -13,6 +13,7 @@ from typing import Optional
 from typing import TYPE_CHECKING
 
 from .match import rgxp_match
+from ..types import rplstr
 from ..types import sort_dict
 
 if TYPE_CHECKING:
@@ -50,13 +51,11 @@ def resolve_path(
 
         for old, new in items:
 
-            if isinstance(old, Path):
-                old = str(old)
+            old = str(old)
+            new = str(new)
 
-            if isinstance(new, Path):
-                new = str(new)
-
-            path = path.replace(old, new)
+            path = rplstr(
+                path, old, new)
 
     return Path(path).resolve()