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

encommon/times/params.py

@@ -10,11 +10,15 @@ is permitted, for more information consult the project license file.
 from typing import Any
 from typing import Optional
 
-from pydantic import BaseModel
-
 from .common import PARSABLE
 from .common import SCHEDULE
 from .times import Times
+from ..types import BaseModel
+
+
+
+_TIMERS = dict[str, 'TimerParams']
+_WINDOWS = dict[str, 'WindowParams']
 
 
 
@@ -62,11 +66,24 @@ class TimersParams(BaseModel, extra='forbid'):
     Process and validate the core configuration parameters.
 
     :param timers: Seconds that are used for related timer.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    timers: dict[str, TimerParams] = {}
+    timers: _TIMERS
+
+
+    def __init__(
+        self,
+        timers: Optional[_TIMERS] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        if timers is None:
+            timers = {}
+
+        super().__init__(
+            timers=timers)
 
 
 
@@ -144,8 +161,21 @@ class WindowsParams(BaseModel, extra='forbid'):
     Process and validate the core configuration parameters.
 
     :param windows: Parameters for defining scheduled time.
-    :param data: Keyword arguments passed to Pydantic model.
-        Parameter is picked up by autodoc, please ignore.
     """
 
-    windows: dict[str, WindowParams] = {}
+    windows: _WINDOWS
+
+
+    def __init__(
+        self,
+        windows: Optional[_WINDOWS] = None,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        if windows is None:
+            windows = {}
+
+        super().__init__(
+            windows=windows)

encommon/times/parse.py

@@ -9,7 +9,6 @@ is permitted, for more information consult the project license file.
 
 from contextlib import suppress
 from datetime import datetime
-from datetime import timezone
 from re import match as re_match
 from typing import Optional
 from typing import TYPE_CHECKING
@@ -31,7 +30,7 @@ if TYPE_CHECKING:
 
 
 
-def parse_time(  # noqa: CFQ004
+def parse_time(
     source: Optional[PARSABLE] = None,
     *,
     anchor: Optional[PARSABLE] = None,
@@ -79,14 +78,20 @@ def parse_time(  # noqa: CFQ004
     :returns: Python datetime object containing related time.
     """
 
+
     if (source is not None
             and hasattr(source, 'source')):
+
         source = source.source
+        assert isinstance(
+            source, datetime)
+
 
     if (isinstance(source, str)
             and re_match(NUMERISH, source)):
         source = float(source)
 
+
     tzinfo = findtz(tzname)
 
 
@@ -94,8 +99,11 @@ def parse_time(  # noqa: CFQ004
         source = datetime.fromtimestamp(
             float(source), tz=tzinfo)
 
-    if str(source) in STRINGNOW:
-        return utcdatetime()
+
+    if source in STRINGNOW:
+        source = (
+            utcdatetime()
+            .astimezone(tzinfo))
 
     if source in ['max', float('inf')]:
         source = datetime.max
@@ -116,11 +124,15 @@ def parse_time(  # noqa: CFQ004
             formats=format,
             tzname=tzname)
 
-    if isinstance(source, datetime):
-        return (
-            source.replace(tzinfo=tzinfo)
-            .astimezone(timezone.utc))
 
+    if (isinstance(source, datetime)
+            and not source.tzinfo):
+        source = source.replace(
+            tzinfo=findtz(tzname))
+
+
+    if isinstance(source, datetime):
+        return source
 
     raise ValueError('source')  # NOCVR
 
@@ -155,7 +167,12 @@ def shift_time(
     anchor = parse_time(
         anchor, tzname=tzname)
 
-    return snap(anchor, notate)
+    parsed = snap(anchor, notate)
+
+    assert parsed.tzinfo is not None
+
+    return parse_time(
+        parsed, tzname=tzname)
 
 
 
@@ -186,11 +203,21 @@ def string_time(
     """
 
     if formats is not None:
+
         with suppress(ValueError):
-            return strptime(source, formats)
+
+            return strptime(
+                source, formats)
 
     parsed = parser.parse(source)
 
+    if parsed.tzinfo is None:
+
+        tzinfo = findtz(tzname)
+
+        parsed = parsed.replace(
+            tzinfo=tzinfo)
+
     return parse_time(
         parsed, tzname=tzname)
 

encommon/times/test/test_parse.py

@@ -8,6 +8,7 @@ is permitted, for more information consult the project license file.
 
 
 from datetime import timedelta
+from datetime import timezone
 
 from pytest import mark
 
@@ -41,10 +42,10 @@ def test_parse_time() -> None:
         '12/31/1969 6:00pm',
         tzname='US/Central')
 
-    assert parsed.year == 1970
-    assert parsed.month == 1
-    assert parsed.day == 1
-    assert parsed.hour == 0
+    assert parsed.year == 1969
+    assert parsed.month == 12
+    assert parsed.day == 31
+    assert parsed.hour == 18
 
 
     parsed = parse_time(0)
@@ -139,7 +140,10 @@ def test_string_time() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    expect = utcdatetime(1980, 1, 1)
+    utc = timezone.utc
+    expect = (
+        utcdatetime(1980, 1, 1)
+        .astimezone(None))
 
 
     strings = [
@@ -151,7 +155,9 @@ def test_string_time() -> None:
 
     for string in strings:
 
-        parsed = string_time(string)
+        parsed = (
+            string_time(string)
+            .astimezone(utc))
 
         assert parsed == expect
 
@@ -170,9 +176,10 @@ def test_string_time() -> None:
     assert parsed == expect
 
 
-    parsed = string_time(
-        '1979-12-31 18:00:00',
-        tzname='US/Central')
+    parsed = (
+        string_time(
+            '1979-12-31 18:00:00',
+            tzname='US/Central'))
 
     assert parsed == expect
 

encommon/times/test/test_times.py

@@ -30,8 +30,7 @@ def test_Times() -> None:
     attrs = list(times.__dict__)
 
     assert attrs == [
-        '_Times__source',
-        '_Times__hashed']
+        '_Times__source']
 
 
     assert inrepr(
@@ -65,8 +64,12 @@ def test_Times() -> None:
 
     assert times.epoch == 0.0
 
+    assert times.spoch == 0
+
     assert times.mpoch == 0.0
 
+    assert str(times.time) == '00:00:00'
+
     assert times.simple == UNIXEPOCH
 
     assert times.subsec == UNIXMPOCH
@@ -87,3 +90,33 @@ def test_Times() -> None:
 
     times = times.shift('+1y')
     assert times == '1971-01-01'
+
+    times = times.shifz('UTC-1')
+    assert times == (
+        '12/31/1970 23:00 -0100')
+
+
+
+def test_Times_tzname() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    times1 = Times(
+        '1970-01-01T00:00:00Z')
+
+    times2 = times1.shifz(
+        'US/Central')
+
+
+    delta = times1 - times2
+
+    assert -1 < delta < 1
+
+
+    stamp1 = times1.stamp(
+        tzname='US/Central')
+
+    stamp2 = times2.stamp()
+
+    assert stamp1 == stamp2

encommon/times/test/test_unitime.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 ..unitime import unitime
+
+
+
+def test_unitime() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert unitime('1s') == 1
+    assert unitime('1h') == 3600
+    assert unitime('1') == 1
+    assert unitime(1) == 1
+    assert unitime('1.0') == 1

encommon/times/times.py

@@ -9,6 +9,7 @@ is permitted, for more information consult the project license file.
 
 from contextlib import suppress
 from datetime import datetime
+from datetime import time as dtime
 from datetime import timedelta
 from typing import Optional
 
@@ -40,7 +41,6 @@ class Times:
     """
 
     __source: datetime
-    __hashed: int
 
 
     def __init__(
@@ -62,8 +62,6 @@ class Times:
             tzname=tzname)
 
         self.__source = parsed
-        self.__hashed = int(
-            self.mpoch * 1000)
 
 
     def __repr__(
@@ -87,7 +85,9 @@ class Times:
         :returns: Boolean indicating outcome from the operation.
         """
 
-        return int(1e9 + self.__hashed)
+        hashed = int(self.mpoch)
+
+        return int(1e9 + hashed)
 
 
     def __str__(
@@ -291,6 +291,19 @@ class Times:
         return source.timestamp()
 
 
+    @property
+    def spoch(
+        self,
+    ) -> int:
+        """
+        Return the seconds since the Unix epoch for the instance.
+
+        :returns: Seconds since the Unix epoch for the instance.
+        """
+
+        return int(self.epoch)
+
+
     @property
     def mpoch(
         self,
@@ -304,14 +317,27 @@ class Times:
         return self.epoch * 1000
 
 
+    @property
+    def time(
+        self,
+    ) -> dtime:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return self.__source.time()
+
+
     @property
     def simple(
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_SIMPLE)
@@ -322,9 +348,9 @@ class Times:
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_SUBSEC)
@@ -335,9 +361,9 @@ class Times:
         self,
     ) -> str:
         """
-        Return the timestamp using provided format for instance.
+        Return the value for the attribute from class instance.
 
-        :returns: Timestamp using provided format for instance.
+        :returns: Value for the attribute from class instance.
         """
 
         return self.stamp(STAMP_HUMAN)
@@ -423,9 +449,14 @@ class Times:
 
         tzinfo = findtz(tzname)
 
-        parsed = source.astimezone(tzinfo)
+        if tzname is not None:
+
+            source = (
+                source
+                .astimezone(tzinfo))
 
-        return strftime(parsed, format)
+        return strftime(
+            source, format)
 
 
     def shift(
@@ -441,4 +472,31 @@ class Times:
 
         source = self.__source
 
-        return Times(notate, anchor=source)
+        return Times(
+            notate, anchor=source)
+
+
+    def shifz(
+        self,
+        tzname: str,
+    ) -> 'Times':
+        """
+        Return the new instance of object shifted using datetime.
+
+        :param tzname: Name of the timezone associated to source.
+            This is not relevant in timezone included in source.
+        :returns: New instance of the class using shifted time.
+        """
+
+        source = self.__source
+
+        tzinfo = findtz(tzname)
+
+        if tzname is not None:
+
+            source = (
+                source
+                .astimezone(tzinfo))
+
+        return Times(
+            source, tzname=tzname)

encommon/times/unitime.py

@@ -0,0 +1,48 @@
+"""
+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 re import match as re_match
+
+from .parse import since_time
+
+
+
+def unitime(
+    input: int | float | str,
+) -> int:
+    """
+    Return the seconds in integer format for provided input.
+
+    :param input: Input that will be converted into seconds.
+    :returns: Seconds in integer format for provided input.
+    """
+
+    notate = r'^(\d+(s|m|h|d|w|y))*$'
+    strint = r'^\d+$'
+    strflt = r'^\d+\.\d+$'
+
+    if isinstance(input, str):
+
+        if re_match(notate, input):
+            input = since_time(
+                'now', f'+{input}')
+
+        elif re_match(strint, input):
+            input = int(input)
+
+        elif re_match(strflt, input):
+            input = int(
+                input.split('.')[0])
+
+    if isinstance(input, float):
+        input = int(input)
+
+    assert isinstance(input, int)
+
+    return input

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,97 @@
+"""
+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 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.
+    """
+
+
+    def __init__(
+        self,
+        **data: Any,
+    ) -> None:
+        """
+        Initialize instance for class using provided parameters.
+        """
+
+        super().__init__(**data)
+
+
+    @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,27 @@
+"""
+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.
+
+    :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