encommon 0.7.6__py3-none-any.whl → 0.8.0__py3-none-any.whl

encommon/times/timers.py

@@ -20,10 +20,9 @@ if TYPE_CHECKING:
 
 
 
-TABLE = (
+CACHE_TABLE = (
     """
-    create table
-     if not exists
+    create table if not exists
      {0} (
       "unique" text not null,
       "update" text not null,
@@ -32,6 +31,11 @@ TABLE = (
 
 
 
+_TIMERS = dict[str, float]
+_CACHED = dict[str, Times]
+
+
+
 class Timers:
     """
     Track timers on unique key and determine when to proceed.
@@ -53,51 +57,57 @@ class Timers:
     True
 
     :param timers: Seconds that are used for each of timers.
-    :param cache_file: Optional path to SQLite database for
+    :param file: Optional path to SQLite database for
         cache. This will allow for use between executions.
-    :param cache_name: Optional override default table name.
+    :param table: Optional override default table name.
     """
 
-    __timers: dict[str, float]
-    __cache_file: 'Connection'
-    __cache_name: str
-    __cache_dict: dict[str, Times]
+    __config: _TIMERS
+    __sqlite: 'Connection'
+    __file: str
+    __table: str
+    __cache: _CACHED
 
 
     def __init__(
         self,
         timers: Optional[dict[str, NUMERIC]] = None,
-        cache_file: str = ':memory:',
-        cache_name: str = 'encommon_timers',
+        file: str = ':memory:',
+        table: str = 'timers',
     ) -> None:
         """
         Initialize instance for class using provided parameters.
         """
 
-        timers = timers or {}
 
+        timers = dict(timers or {})
 
-        self.__timers = {
-            k: float(v)
-            for k, v in
-            timers.items()}
+        items = timers.items()
 
+        for key, value in items:
+            timers[key] = float(value)
 
-        cached = SQLite(cache_file)
 
-        cached.execute(
-            TABLE.format(cache_name))
+        sqlite = SQLite(file)
 
-        cached.commit()
+        sqlite.execute(
+            CACHE_TABLE
+            .format(table))
+
+        sqlite.commit()
+
+
+        cached: _CACHED = {}
 
-        self.__cache_file = cached
-        self.__cache_name = cache_name
+        for timer in timers:
+            cached[timer] = Times()
 
 
-        self.__cache_dict = {
-            x: Times()
-            for x in
-            self.__timers}
+        self.__config = timers
+        self.__sqlite = sqlite
+        self.__file = file
+        self.__table = table
+        self.__cache = cached
 
 
         self.load_cache()
@@ -111,9 +121,9 @@ class Timers:
         Load the timers cache from the database into attribute.
         """
 
-        cached = self.__cache_file
-        table = self.__cache_name
-        cachem = self.__cache_dict
+        cached = self.__sqlite
+        table = self.__table
+        cachem = self.__cache
 
         cursor = cached.execute(
             f'select * from {table}'
@@ -138,19 +148,29 @@ class Timers:
         Save the timers cache from the attribute into database.
         """
 
-        cached = self.__cache_file
-        table = self.__cache_name
-        cachem = self.__cache_dict
+        insert = tuple[str, str]
+        inserts: list[insert] = []
+
+
+        cached = self.__sqlite
+        table = self.__table
+        cachem = self.__cache
+
+
+        items = cachem.items()
+
+        for key, value in items:
+
+            append = (key, str(value))
+
+            inserts.append(append)
 
-        insert = [
-            (k, str(v)) for k, v
-            in cachem.items()]
 
         cached.executemany(
             (f'replace into {table}'
              ' ("unique", "update")'
              ' values (?, ?)'),
-            tuple(insert))
+            tuple(sorted(inserts)))
 
         cached.commit()
 
@@ -158,18 +178,18 @@ class Timers:
     @property
     def timers(
         self,
-    ) -> dict[str, float]:
+    ) -> _TIMERS:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return dict(self.__timers)
+        return dict(self.__config)
 
 
     @property
-    def cache_file(
+    def sqlite(
         self,
     ) -> 'Connection':
         """
@@ -178,24 +198,24 @@ class Timers:
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__cache_file
+        return self.__sqlite
 
 
     @property
-    def cache_dict(
+    def file(
         self,
-    ) -> dict[str, Times]:
+    ) -> str:
         """
         Return the value for the attribute from class instance.
 
         :returns: Value for the attribute from class instance.
         """
 
-        return dict(self.__cache_dict)
+        return self.__file
 
 
     @property
-    def cache_name(
+    def table(
         self,
     ) -> str:
         """
@@ -204,7 +224,20 @@ class Timers:
         :returns: Value for the attribute from class instance.
         """
 
-        return self.__cache_name
+        return self.__table
+
+
+    @property
+    def cache(
+        self,
+    ) -> _CACHED:
+        """
+        Return the value for the attribute from class instance.
+
+        :returns: Value for the attribute from class instance.
+        """
+
+        return dict(self.__cache)
 
 
     def ready(
@@ -219,18 +252,18 @@ class Timers:
            For performance reasons, this method will not notice
            changes within the database unless refreshed first.
 
-        :param unique: Unique identifier for the timer in mapping.
+        :param unique: Which timer configuration from reference.
         :param update: Determines whether or not time is updated.
         """
 
-        timers = self.__timers
-        caches = self.__cache_dict
+        config = self.__config
+        caches = self.__cache
 
         if unique not in caches:
             raise ValueError('unique')
 
         cache = caches[unique]
-        timer = timers[unique]
+        timer = config[unique]
 
         ready = cache.since >= timer
 
@@ -248,11 +281,11 @@ class Timers:
         """
         Update the existing timer from mapping within the cache.
 
-        :param unique: Unique identifier for the timer in mapping.
+        :param unique: Which timer configuration from reference.
         :param started: Override the start time for timer value.
         """
 
-        caches = self.__cache_dict
+        caches = self.__cache
 
         if unique not in caches:
             raise ValueError('unique')
@@ -271,18 +304,18 @@ class Timers:
         """
         Update the existing timer from mapping within the cache.
 
-        :param unique: Unique identifier for the timer in mapping.
-        :param minimum: Determines minimum seconds that must pass.
-        :param started: Determines when the time starts for timer.
+        :param unique: Which timer configuration from reference.
+        :param minimum: Determine minimum seconds that must pass.
+        :param started: Determine when time starts for the timer.
         """
 
-        timers = self.__timers
-        caches = self.__cache_dict
+        config = self.__config
+        caches = self.__cache
 
-        if unique in timers:
+        if unique in config:
             raise ValueError('unique')
 
-        timers[unique] = float(minimum)
+        config[unique] = float(minimum)
         caches[unique] = Times(started)
 
         self.save_cache()

encommon/times/times.py

@@ -7,17 +7,17 @@ is permitted, for more information consult the project license file.
 
 
 
+from contextlib import suppress
 from datetime import datetime
 from datetime import timedelta
-from datetime import timezone
 from typing import Optional
 
-from dateutil.tz import gettz
-
 from .common import PARSABLE
 from .common import STAMP_HUMAN
 from .common import STAMP_SIMPLE
 from .common import STAMP_SUBSEC
+from .common import findtz
+from .common import strftime
 from .parse import parse_time
 from .parse import since_time
 
@@ -40,6 +40,7 @@ class Times:
     """
 
     __source: datetime
+    __hashed: int
 
 
     def __init__(
@@ -54,12 +55,16 @@ class Times:
         Initialize instance for class using provided parameters.
         """
 
-        self.__source = parse_time(
+        parsed = parse_time(
             source=source,
             anchor=anchor,
             format=format,
             tzname=tzname)
 
+        self.__source = parsed
+        self.__hashed = int(
+            self.mpoch * 1000)
+
 
     def __repr__(
         self,
@@ -82,7 +87,7 @@ class Times:
         :returns: Boolean indicating outcome from the operation.
         """
 
-        return int(self.mpoch * 100000)
+        return int(1e9 + self.__hashed)
 
 
     def __str__(
@@ -103,7 +108,7 @@ class Times:
         """
         Built-in method representing numeric value for instance.
 
-        :returns: Numeric representation for values from instance.
+        :returns: Numeric representation for value in instance.
         """
 
         return int(self.epoch)
@@ -115,7 +120,7 @@ class Times:
         """
         Built-in method representing numeric value for instance.
 
-        :returns: Numeric representation for values from instance.
+        :returns: Numeric representation for value in instance.
         """
 
         return float(self.epoch)
@@ -168,13 +173,16 @@ class Times:
         :returns: Boolean indicating outcome from the operation.
         """
 
-        try:
-            parsed = parse_time(other)  # type: ignore
+        source = self.__source
+
+        with suppress(Exception):
 
-        except Exception:
-            return False
+            parsed = parse_time(
+                other)  # type: ignore
 
-        return self.__source == parsed
+            return source == parsed
+
+        return False
 
 
     def __ne__(
@@ -278,7 +286,9 @@ class Times:
         :returns: Seconds since the Unix epoch for the instance.
         """
 
-        return self.__source.timestamp()
+        source = self.__source
+
+        return source.timestamp()
 
 
     @property
@@ -369,10 +379,10 @@ class Times:
         :returns: Object containing time just before the time.
         """
 
-        delta = timedelta(
-            microseconds=1)
+        source = self.__source
 
-        source = self.__source - delta
+        source -= timedelta(
+            microseconds=1)
 
         return Times(source)
 
@@ -387,10 +397,10 @@ class Times:
         :returns: Object containing time just after the time.
         """
 
-        delta = timedelta(
-            microseconds=1)
+        source = self.__source
 
-        source = self.__source + delta
+        source += timedelta(
+            microseconds=1)
 
         return Times(source)
 
@@ -409,21 +419,13 @@ class Times:
         :returns: Timestamp using provided format for instance.
         """
 
-        parsed = self.__source
+        source = self.__source
 
+        tzinfo = findtz(tzname)
 
-        if tzname is not None:
-            tzinfo = gettz(tzname)
-        else:
-            tzinfo = timezone.utc
+        parsed = source.astimezone(tzinfo)
 
-        if tzinfo is None:
-            raise ValueError('tzname')
-
-
-        return datetime.strftime(
-            parsed.astimezone(tzinfo),
-            format)
+        return strftime(parsed, format)
 
 
     def shift(
@@ -437,6 +439,6 @@ class Times:
         :returns: New instance of the class using shifted time.
         """
 
-        return Times(
-            source=notate,
-            anchor=self.__source)
+        source = self.__source
+
+        return Times(notate, anchor=source)

encommon/times/window.py

@@ -170,7 +170,7 @@ class Window:
 
 
     @property
-    def next(
+    def last(
         self,
     ) -> Times:
         """
@@ -179,11 +179,11 @@ class Window:
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__winext)
+        return Times(self.__wilast)
 
 
     @property
-    def last(
+    def next(
         self,
     ) -> Times:
         """
@@ -192,7 +192,7 @@ class Window:
         :returns: Value for the attribute from class instance.
         """
 
-        return Times(self.__wilast)
+        return Times(self.__winext)
 
 
     @property

encommon/types/dicts.py

@@ -49,12 +49,16 @@ def merge_dicts(
         elif (isinstance(dict1[key], list)
                 and isinstance(value, list)
                 and merge_list is True):
-            dict1[key] = [] + dict1[key] + value
+
+            dict1[key] = (
+                [] + dict1[key] + value)
 
         elif (isinstance(dict1[key], dict)
                 and isinstance(value, dict)
                 and merge_dict is True):
-            merge_dicts(dict1[key], value, force)
+
+            merge_dicts(
+                dict1[key], value, force)
 
         elif force is True:
             dict1[key] = value
@@ -81,6 +85,8 @@ def sort_dict(
     :returns: New dictionary with keys sorted alphabetical.
     """
 
-    return dict(sorted(
+    items = sorted(
         value.items(),
-        reverse=reverse))
+        reverse=reverse)
+
+    return dict(items)

encommon/types/empty.py

@@ -51,8 +51,13 @@ class EmptyType:
         :returns: Same instance of class that first instantiated.
         """
 
-        if cls.__empty is None:
-            cls.__empty = object.__new__(cls)
+        empty = cls.__empty
+
+        if empty is not None:
+            return empty
+
+        cls.__empty = (
+            object.__new__(cls))
 
         return cls.__empty
 

encommon/types/strings.py

@@ -7,6 +7,16 @@ is permitted, for more information consult the project license file.
 
 
 
+COMMAS = ', '
+COMMAD = ','
+
+NEWLINE = '\n'
+
+SEMPTY = ''
+SPACED = ' '
+
+
+
 def striplower(
     value: str,
 ) -> str:

encommon/types/test/test_dicts.py

@@ -14,14 +14,14 @@ from ..dicts import sort_dict
 
 
 
-DICT1 = {
+_DICT1 = {
     'dict1': 'dict1',
     'str': 'd1string',
     'list': ['d1list'],
     'dict': {'key': 'd1value'},
     'bool': False}
 
-DICT2 = {
+_DICT2 = {
     'dict2': 'dict2',
     'str': 'd2string',
     'list': ['d2list'],
@@ -35,8 +35,8 @@ def test_merge_dicts() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    dict1 = deepcopy(DICT1)
-    dict2 = deepcopy(DICT2)
+    dict1 = deepcopy(_DICT1)
+    dict2 = deepcopy(_DICT2)
 
     dict1['recurse'] = deepcopy(dict1)
     dict2['recurse'] = deepcopy(dict2)
@@ -114,7 +114,7 @@ def test_sort_dict() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    assert sort_dict(DICT1) == {
+    assert sort_dict(_DICT1) == {
         'bool': False,
         'dict': {'key': 'd1value'},
         'dict1': 'dict1',

encommon/types/test/test_empty.py

@@ -22,15 +22,18 @@ def test_EmptyType() -> None:
 
     empty = EmptyType()
 
+
     attrs = list(empty.__dict__)
 
     assert attrs == [
         '_EmptyType__empty']
 
+
     assert repr(empty) == 'Empty'
-    assert isinstance(hash(empty), int)
+    assert hash(empty) > 0
     assert str(empty) == 'Empty'
 
+
     assert not (Empty or None)
     assert Empty is empty
     assert Empty is Empty

encommon/types/test/test_strings.py

@@ -16,4 +16,4 @@ def test_striplower() -> None:
     Perform various tests associated with relevant routines.
     """
 
-    assert striplower('  Foo ') == 'foo'
+    assert striplower(' Foo ') == 'foo'

encommon/utils/__init__.py

@@ -7,6 +7,8 @@ is permitted, for more information consult the project license file.
 
 
 
+from .common import read_text
+from .common import save_text
 from .match import fuzz_match
 from .match import rgxp_match
 from .paths import resolve_path
@@ -30,8 +32,10 @@ __all__ = [
     'make_ansi',
     'prep_sample',
     'print_ansi',
+    'read_text',
     'resolve_path',
     'resolve_paths',
     'rgxp_match',
+    'save_text',
     'stats_path',
     'strip_ansi']