encommon 0.22.3__tar.gz → 0.22.5__tar.gz

{encommon-0.22.3/encommon.egg-info → encommon-0.22.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: encommon
-Version: 0.22.3
+Version: 0.22.5
 Summary: Enasis Network Common Library
 License: MIT
 Project-URL: Source, https://github.com/enasisnetwork/encommon

{encommon-0.22.3 → encommon-0.22.5}/encommon/colors/color.py

@@ -79,9 +79,9 @@ class Color:
         self,
     ) -> int:
         """
-        Built-in method called when performing hashing operation.
+        Built-in method used when performing hashing operations.
 
-        :returns: Boolean indicating outcome from the operation.
+        :returns: Integer hash value for the internal reference.
         """
 
         return hash(self.__source)

{encommon-0.22.3 → encommon-0.22.5}/encommon/parse/network.py

@@ -55,9 +55,9 @@ class Network:
         self,
     ) -> int:
         """
-        Built-in method called when performing hashing operation.
+        Built-in method used when performing hashing operations.
 
-        :returns: Boolean indicating outcome from the operation.
+        :returns: Integer hash value for the internal reference.
         """
 
         return hash(self.__source)

{encommon-0.22.3 → encommon-0.22.5}/encommon/times/duration.py

@@ -132,9 +132,9 @@ class Duration:
         self,
     ) -> int:
         """
-        Built-in method called when performing hashing operation.
+        Built-in method used when performing hashing operations.
 
-        :returns: Boolean indicating outcome from the operation.
+        :returns: Integer hash value for the internal reference.
         """
 
         return hash(self.__source)

{encommon-0.22.3 → encommon-0.22.5}/encommon/times/time.py

@@ -129,9 +129,9 @@ class Time:
         self,
     ) -> int:
         """
-        Built-in method called when performing hashing operation.
+        Built-in method used when performing hashing operations.
 
-        :returns: Boolean indicating outcome from the operation.
+        :returns: Integer hash value for the internal reference.
         """
 
         return hash(self.__source)

{encommon-0.22.3 → encommon-0.22.5}/encommon/types/__init__.py

@@ -13,6 +13,7 @@ from .classes import lattrs
 from .dicts import merge_dicts
 from .dicts import sort_dict
 from .empty import Empty
+from .funcs import funcname
 from .lists import dedup_list
 from .lists import fuzzy_list
 from .lists import inlist
@@ -42,6 +43,7 @@ __all__ = [
     'DictStrAny',
     'Empty',
     'expate',
+    'funcname',
     'getate',
     'hasstr',
     'impate',

{encommon-0.22.3 → encommon-0.22.5}/encommon/types/empty.py

@@ -78,9 +78,9 @@ class EmptyType:
         self,
     ) -> int:
         """
-        Built-in method called when performing hashing operation.
+        Built-in method used when performing hashing operations.
 
-        :returns: Boolean indicating outcome from the operation.
+        :returns: Integer hash value for the internal reference.
         """
 
         return hash(EmptyType)

encommon-0.22.5/encommon/types/funcs.py

@@ -0,0 +1,53 @@
+"""
+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 inspect import currentframe
+
+
+
+def funcname() -> str:
+    """
+    Return the current function name where code is running.
+
+    :returns: Current function name where code is running.
+    """
+
+    frame = currentframe()
+
+    assert frame is not None, (
+        'Frame not present')
+
+    caller = frame.f_back
+
+    assert caller is not None, (
+        'Caller not present')
+
+    name = caller.f_code.co_name
+    focals = caller.f_locals
+
+
+    if 'self' in focals:
+
+        parent = (
+            focals['self']
+            .__class__
+            .__name__)
+
+        return f'{parent}.{name}'
+
+    elif 'cls' in focals:
+
+        parent = (
+            focals['cls']
+            .__name__)
+
+        return f'{parent}.{name}'
+
+
+    return name

encommon-0.22.5/encommon/types/test/test_funcs.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 ..funcs import funcname
+
+
+
+def test_funcname() -> None:
+    """
+    Perform various tests associated with relevant routines.
+    """
+
+    assert funcname() == 'test_funcname'
+
+
+    class Testing:
+
+        def test1(self) -> str:
+            return funcname()
+
+        @classmethod
+        def test2(cls) -> str:
+            return funcname()
+
+
+    assert Testing().test1() == 'Testing.test1'
+    assert Testing.test2() == 'Testing.test2'

{encommon-0.22.3 → encommon-0.22.5}/encommon/utils/__init__.py

@@ -7,6 +7,7 @@ is permitted, for more information consult the project license file.
 
 
 
+from .files import append_text
 from .files import read_text
 from .files import save_text
 from .match import fuzz_match
@@ -27,6 +28,7 @@ from .stdout import strip_ansi
 
 
 __all__ = [
+    'append_text',
     'array_ansi',
     'fuzz_match',
     'kvpair_ansi',

{encommon-0.22.3 → encommon-0.22.5}/encommon/utils/files.py

@@ -23,6 +23,8 @@ def read_text(
 
     Example
     -------
+    >>> path.exists()
+    False
     >>> save_text(path, 'foo')
     'foo'
     >>> read_text(path)
@@ -52,6 +54,8 @@ def save_text(
 
     Example
     -------
+    >>> path.exists()
+    False
     >>> save_text(path, 'foo')
     'foo'
     >>> read_text(path)
@@ -69,3 +73,38 @@ def save_text(
         encoding='utf-8')
 
     return read_text(path)
+
+
+
+def append_text(
+    path: str | Path,
+    content: str,
+) -> None:
+    """
+    Append the provided text content into provided file path.
+
+    .. testsetup::
+       >>> tmpdir = getfixture('tmpdir')
+       >>> path = Path(f'{tmpdir}/text.txt')
+
+    Example
+    -------
+    >>> path.exists()
+    False
+    >>> append_text(path, 'foo')
+    >>> append_text(path, 'foo')
+    >>> read_text(path)
+    'foofoo'
+
+    :param path: Complete or relative path to the text file.
+    :param content: Content that will be written to the file.
+    """
+
+    path = Path(path).resolve()
+
+    with path.open(
+        mode='a',
+        encoding='utf-8',
+    ) as file:
+
+        file.write(f'{content}')

{encommon-0.22.3 → encommon-0.22.5}/encommon/utils/test/test_files.py

@@ -9,6 +9,7 @@ is permitted, for more information consult the project license file.
 
 from pathlib import Path
 
+from ..files import append_text
 from ..files import read_text
 from ..files import save_text
 
@@ -33,3 +34,30 @@ def test_readsave_text(
         f'{tmp_path}/test.txt')
 
     assert loaded == content
+
+
+
+def test_append_text(
+    tmp_path: Path,
+) -> None:
+    """
+    Perform various tests associated with relevant routines.
+
+    :param tmp_path: pytest object for temporal filesystem.
+    """
+
+    content = 'pytest'
+
+    append_text(
+        f'{tmp_path}/test.txt',
+        content)
+
+    append_text(
+        f'{tmp_path}/test.txt',
+        content)
+
+    loaded = read_text(
+        f'{tmp_path}/test.txt')
+
+    assert loaded == (
+        f'{content}{content}')

encommon-0.22.5/encommon/version.txt

@@ -0,0 +1 @@
+0.22.5

{encommon-0.22.3 → encommon-0.22.5}/encommon/webkit/scripts/color.js

@@ -7,11 +7,15 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * Construct element for displaying the specified color.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function colordiv(
   input,
   label=null,
 ) {
-  // Construct element for displaying the specified color.
 
   assert(!isnull(input));
 

{encommon-0.22.3 → encommon-0.22.5}/encommon/webkit/scripts/datagrid.js

@@ -7,11 +7,15 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * Construct the table with the header using the contents.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function datagrid(
   fields,
   values,
 ) {
-  // Construct the table with the header using the contents.
 
   assert(!isnull(fields));
   assert(!isnull(values));
@@ -34,10 +38,14 @@ function datagrid(
 
 
 
+/**
+ * Construct the header for use with the table contents.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _table_header(
   fields,
 ) {
-  // Construct the header for use with the table contents.
 
   let element = $('<thead/>');
   let trow = $('<tr/>');
@@ -63,11 +71,15 @@ function _table_header(
 
 
 
+/**
+ * Construct the records for use with the table contents.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _table_records(
   fields,
   values,
 ) {
-  // Construct the records for use with the table contents.
 
   let element = $('<tbody/>');
 

{encommon-0.22.3 → encommon-0.22.5}/encommon/webkit/scripts/datetime.js

@@ -7,10 +7,14 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * Return the timestamp using provided format for instance.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function datestamp(
   value,
 ) {
-  // Return the timestamp using provided format for instance.
 
   assert(!isnull(value));
 
@@ -140,10 +144,12 @@ function datestamp(
 
 
 
+/**
+ * Return the located timezone object for the provided date.
+ */
 function _tzname(
   date,
 ) {
-  // Return the located timezone object for the provided date.
 
   assert(!isnull(date));
 

{encommon-0.22.3 → encommon-0.22.5}/encommon/webkit/scripts/default.js

@@ -7,8 +7,10 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * jQuery like object for use in Enasis Network projects.
+ */
 (function (global) {
-  // jQuery like object for use in Enasis Network projects.
 
   'use strict';
 
@@ -98,11 +100,13 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ */
 function _enquery(
   source,
   selector,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   const create = /^<(\w+)\/>$/;
 
@@ -127,10 +131,14 @@ function _enquery(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_each(
   element,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   let items = this.elements;
 
@@ -142,11 +150,15 @@ function _enquery_each(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_css(
   name,
   value,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   function _each() {
     this.style[name] = value; }
@@ -155,10 +167,14 @@ function _enquery_css(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_addcls(
   name,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   function _each() {
     this.classList
@@ -168,10 +184,14 @@ function _enquery_addcls(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_remcls(
   name,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   function _each() {
     this.classList
@@ -181,8 +201,12 @@ function _enquery_remcls(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_hide() {
-  // Helper function for Enasis Network jQuery replacement.
 
 
   function _each() {
@@ -204,8 +228,12 @@ function _enquery_hide() {
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_show() {
-  // Helper function for Enasis Network jQuery replacement.
 
 
   function _each() {
@@ -232,10 +260,15 @@ function _enquery_show() {
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element
+ *                   or the text value in first element.
+ */
 function _enquery_text(
   text,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   if (text === undefined) {
 
@@ -253,10 +286,15 @@ function _enquery_text(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element
+ *                   or the HTML value in first element.
+ */
 function _enquery_html(
   html,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   if (html === undefined) {
 
@@ -280,10 +318,14 @@ function _enquery_html(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_append(
   element,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   assert(element.enquery)
 
@@ -305,10 +347,14 @@ function _enquery_append(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_replace(
   element,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   assert(element.enquery)
 
@@ -330,11 +376,16 @@ function _enquery_replace(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element
+ *                   or the attr value in first element.
+ */
 function _enquery_attr(
   name,
   value,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   if (this.length === 0)
     return undefined;
@@ -359,11 +410,16 @@ function _enquery_attr(
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element
+ *                   or the prop value in first element.
+ */
 function _enquery_prop(
   name,
   value,
 ) {
-  // Helper function for Enasis Network jQuery replacement.
 
   if (this.length === 0)
     return undefined;
@@ -376,13 +432,18 @@ function _enquery_prop(
       this[name] = value; }
 
     if (value !== undefined)
-    return this.each(_each);
+      return this.each(_each);
 
 
   return this[0][name]; }
 
 
 
+/**
+ * Helper function for Enasis Network jQuery replacement.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function _enquery_clone() {
 
   let clones =

{encommon-0.22.3 → encommon-0.22.5}/encommon/webkit/scripts/duration.js

@@ -7,10 +7,14 @@ is permitted, for more information consult the project license file.
 
 
 
+/**
+ * Convert the provided seconds in a human friendly format.
+ *
+ * @returns {Object} jQuery-like object for the element.
+ */
 function duration(
   seconds,
 ) {
-  // Convert the provided seconds in a human friendly format.
 
   assert(!isnull(seconds));
 
@@ -128,10 +132,12 @@ function duration(
 
 
 
+/**
+ * Determine the time in seconds occurring since instance.
+ */
 function _since(
   value,
 ) {
-  // Determine the time in seconds occurring since instance.
 
   assert(!isnull(value));