python-ubercode-utils 1.0.9__tar.gz → 2.0.0__tar.gz

{python-ubercode-utils-1.0.9/python_ubercode_utils.egg-info → python-ubercode-utils-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-ubercode-utils
-Version: 1.0.9
+Version: 2.0.0
 Summary: Core python utilities for all apps
 Home-page: https://github.com/sstacha/python-ubercode-utils
 Author: Steve Stacha

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0/python_ubercode_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-ubercode-utils
-Version: 1.0.9
+Version: 2.0.0
 Summary: Core python utilities for all apps
 Home-page: https://github.com/sstacha/python-ubercode-utils
 Author: Steve Stacha

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0}/python_ubercode_utils.egg-info/SOURCES.txt

@@ -9,19 +9,17 @@ python_ubercode_utils.egg-info/not-zip-safe
 python_ubercode_utils.egg-info/top_level.txt
 test/test_convert.py
 test/test_cursor.py
+test/test_data.py
 test/test_dataframe.py
 test/test_environment.py
-test/test_json.py
 test/test_logging.py
 test/test_urls.py
-test/test_xml.py
 ubercode/__init__.py
 ubercode/utils/__init__.py
 ubercode/utils/convert.py
 ubercode/utils/cursor.py
+ubercode/utils/data.py
 ubercode/utils/dataframe.py
 ubercode/utils/environment.py
-ubercode/utils/json.py
 ubercode/utils/logging.py
-ubercode/utils/urls.py
-ubercode/utils/xml.py
+ubercode/utils/urls.py

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0}/setup.py

@@ -4,7 +4,7 @@ with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setuptools.setup(name='python-ubercode-utils',
-      version='1.0.9',
+      version='2.0.0',
       description='Core python utilities for all apps',
       long_description=long_description,
       long_description_content_type="text/markdown",

python-ubercode-utils-1.0.9/test/test_json.py → python-ubercode-utils-2.0.0/test/test_data.py

@@ -1,7 +1,8 @@
 import unittest
 from pathlib import Path
 
-from ubercode.utils.json import JSON
+from ubercode.utils.data import JSON
+from ubercode.utils.data import XML
 
 
 class TestJSON(unittest.TestCase):
@@ -48,12 +49,10 @@ class TestJSON(unittest.TestCase):
 """
         # test we can construct from a json string
         json = JSON(json_string=json_string)
-        self.assertEqual(len(json.json_dict['people']), 3)
+        self.assertEqual(len(json.data['people']), 3)
         # test we can construct by chaining and reading file
-        json2 = JSON().from_json_file(file_path)
-        self.assertEqual(json.json_dict, json2.json_dict)
-        # test the dict matches the to_dict() result
-        self.assertEqual(json.json_dict, json.to_dict())
+        json2 = JSON().from_json_file(str(file_path))
+        self.assertEqual(json.data, json2.data)
         # test encoding
         json_string = """
 {
@@ -91,12 +90,71 @@ class TestJSON(unittest.TestCase):
 }
 """
         json = JSON(json_string=json_string, encode_ampersands=True)
-        self.assertEqual(len(json.json_dict['people']), 3)
-        first_name = json.to_dict()['people'][0]['firstName']
+        self.assertEqual(len(json.data['people']), 3)
+        first_name = json.data['people'][0]['firstName']
         self.assertEqual(first_name, "Joe & Baker")
         #  make sure the second name isn't double encoded
-        second_name = json.to_dict()['people'][1]['firstName']
+        second_name = json.data['people'][1]['firstName']
         self.assertEqual(second_name, "James &")
         # test the str function
         result = "{'people': [{'firstName': 'Joe & Baker', 'lastName': 'Jackson', 'gender': 'male', 'age': 28, 'number': '7349282382', 'groups': ['members', 'student']}, {'firstName': 'James &', 'lastName': 'Smith', 'gender': 'male', 'age': 32, 'number': '5678568567', 'groups': ['members', 'professional']}, {'firstName': 'Emily', 'lastName': 'Jones', 'gender': 'female', 'age': 24, 'number': '456754675'}]}"
         self.assertEqual(str(json), result)
+
+
+class TestXML(unittest.TestCase):
+
+    # -------- common usages ----------
+    def test_XML(self):
+        # calculate the filename for our test.xml file from this file (much like settings does)
+        file_path = Path(__file__).resolve().parent / 'test.xml'
+        xml_string = """
+<contacts>
+    <contact>
+        <name>Steve Stacha</name>
+    </contact>
+    <contact>
+        <name>Buggs Bunny</name>
+    </contact>
+    <contact>
+        <name>Daffy Duck</name>
+    </contact>
+</contacts>
+"""
+        # test we can construct from an xml string
+        xml = XML(xml_string=xml_string)
+        # NOTE: because we used a multiline string we need to strip the extra newlines before and after <contacts>
+        self.assertEqual(str(xml), xml_string.strip())
+        # normal string doesn't need stripping
+        xml_compact_string = "<contacts><contact><name>Buggs Bunny</name></contact><contact><name>Daffy Duck</name></contact></contacts>"
+        xml2 = XML(xml_compact_string)
+        self.assertEqual(str(xml2), xml_compact_string)
+        # test we can create using the from_xml_string() method chaining
+        xml3 = XML().from_xml_string(xml_compact_string)
+        self.assertEqual(str(xml2), str(xml3))
+        # test that method chaining after constructor overrides the value in place
+        self.assertNotEqual(str(xml), str(xml2))
+        xml.from_xml_string(xml_compact_string)
+        self.assertEqual(str(xml), str(xml2))
+        # test that we can read from file
+        xml.from_xml_file(str(file_path))
+        # we should be back to before
+        self.assertEqual(str(xml), xml_string.strip())
+        # test an attribute
+        xml_string = """
+<contacts>
+    <contact attr="1">
+        <name>Steve Stacha</name>
+    </contact>
+    <contact>
+        <name>Buggs & Bunny</name>
+    </contact>
+    <contact>
+        <name>Daffy Duck</name>
+    </contact>
+</contacts>
+"""
+        xml = XML(xml_string=xml_string, encode_ampersands=True)
+        xml_dict = xml.to_dict()
+        self.assertEqual(xml_dict['contacts']['contact'][0]['@attr'], '1')
+
+

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0}/test/test_urls.py

@@ -40,6 +40,16 @@ class TestUrls(unittest.TestCase):
         self.assertEqual(test_uri, str(parsed_url))
         parsed_url = ParsedUrl(test_uri, default_scheme='https')
         self.assertEqual("https:" + test_uri, str(parsed_url))
+        # test that mailto and tel links don't get defaulted
+        test_uri = 'mailto:me@mail.com?subject=mysubject&body=mybody'
+        parsed_url = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/booger/')
+        self.assertEqual("mailto", str(parsed_url.scheme))
+        self.assertEqual(test_uri, parsed_url.url)
+        test_uri = 'tel: 222.222.2222'
+        parsed_url = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/booger/')
+        self.assertEqual("tel", str(parsed_url.scheme))
+        self.assertEqual(test_uri, parsed_url.url)
+
 
     # --- basic retrieval
     # -------------------

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0}/ubercode/utils/convert.py

@@ -250,3 +250,31 @@ def to_mask(value: str or None) -> str or None:
         _mask += value[-_iqtr:]
     return _mask
 
+def obj_to_str(obj, property_filter_list=None):
+    """
+    Mostly used for debugging.  Very useful to print the properties of an object on a line; condensing reasonably
+
+    :param obj: the object to inspect properties for
+    :param property_filter_list: any property names we want to omit
+    :return: a string containing the outputted properties
+    """
+    attbuf = ""
+    for key, value in vars(obj).items():
+        if property_filter_list and key in property_filter_list:
+            continue
+        if not key.startswith('__'):
+            if len(attbuf) > 0:
+                attbuf += ", "
+            # show the first 50 chars and last 25 chars
+            this_content = str(value)
+            this_content = this_content.replace('\n', ' ').replace('\r', '').strip()
+            if this_content:
+                if len(this_content) > 150:
+                    attbuf += str(key) + ": [" + this_content[0:25] + " ... " + this_content[
+                                                                                len(this_content) - 25:len(
+                                                                                    this_content)] + "]"
+                else:
+                    attbuf += str(key) + ": " + this_content or ""
+            else:
+                attbuf += str(key) + ": " + this_content or ""
+    return "[" + attbuf + "]"

python-ubercode-utils-1.0.9/ubercode/utils/xml.py → python-ubercode-utils-2.0.0/ubercode/utils/data.py

@@ -1,18 +1,59 @@
 """
-A collection of basic xml conversion helper utilities.
+A collection of basic json/xml conversion helper utilities.
 """
-import xml.etree.ElementTree as Etree
+import json
 import re
 # from typing import Self (Not available until 3.9; omitting for now)
+import xml.etree.ElementTree as Etree
+# from typing import Self (Not available until 3.9; omitting for now)
 from collections import defaultdict
 
 
-class XML:
-    """ simple xml class to encapsulate basic xml operations """
-    # the base implementation will be Etree from the base python lib
-    xml_tree = None
+class JSON:
+    """ simple json class to encapsulate basic json operations """
+    def __init__(self, json_string: str or None = None, encode_ampersands: bool = False):
+        # data is core python objects (list, dict, object, etc) from the core python JSON.loads
+        self.data = None
+        self.encode_ampersands = encode_ampersands
+        self.from_json_string(json_string)
+
+    def from_json_string(self, json_string: str):
+        """
+        read in from json_string
+        :param json_string:
+        :return: self
+        """
+        if json_string:
+            if self.encode_ampersands:
+                regex = re.compile(r"&(?!amp;|lt;|gt;)")
+                json_string = regex.sub("&", json_string)
+            self.data = json.loads(json_string)
+        return self
 
+    def from_json_file(self, json_file_path: str):
+        """
+        read in from json_file
+        :param json_file_path: string to file
+        :return: self
+        """
+        with open(json_file_path, encoding='utf-8-sig') as json_file:
+            json_string = json_file.read()
+        if json_string:
+            if self.encode_ampersands:
+                regex = re.compile(r"&(?!amp;|lt;|gt;)")
+                json_string = regex.sub("&", json_string)
+            self.data = json.loads(json_string)
+        return self
+
+    def __str__(self):
+        return str(self.data)
+
+
+class XML:
+    """ simple xml class to encapsulate basic xml operations using build in python ETree """
     def __init__(self, xml_string: str or None = None, encode_ampersands: bool = False):
+        # data is core python ElementTree object
+        self.data = None
         self.encode_ampersands = encode_ampersands
         self.from_xml_string(xml_string)
 
@@ -26,7 +67,7 @@ class XML:
             if self.encode_ampersands:
                 regex = re.compile(r"&(?!amp;|lt;|gt;)")
                 xml_string = regex.sub("&", xml_string)
-            self.xml_tree = Etree.fromstring(xml_string)
+            self.data = Etree.fromstring(xml_string)
         return self
 
     def from_xml_file(self, xml_file_path: str):
@@ -46,7 +87,7 @@ class XML:
         else:
             tree = Etree.parse(xml_file_path)
             tree = tree.getroot()
-        self.xml_tree = tree
+        self.data = tree
         return self
 
     def to_dict(self) -> dict:
@@ -54,10 +95,10 @@ class XML:
         output to dict
         :return: dict
         """
-        return XML.tree_to_dict(self.xml_tree)
+        return XML.tree_to_dict(self.data)
 
     @staticmethod
-    def tree_to_dict(t) -> dict:
+    def tree_to_dict(t: Etree) -> dict:
         """
         Convert an etree structure to a dictionary of values
         :param t: etree instance
@@ -83,6 +124,6 @@ class XML:
         return d
 
     def __str__(self):
-        if self.xml_tree:
-            return Etree.tostring(self.xml_tree, encoding='unicode')
+        if self.data:
+            return Etree.tostring(self.data, encoding='unicode')
         return ""

{python-ubercode-utils-1.0.9 → python-ubercode-utils-2.0.0}/ubercode/utils/urls.py

@@ -64,9 +64,11 @@ class ParsedUrl:
             raise Exception(
                 f'Attempted to parse [{str(self.url_filter(url))}].  Url parameter must exist and be a relative or absolute url after filtering!')
         self.parsed = urlsplit(self.url_filter(url), default_scheme or "", allow_fragments=allow_fragments)
-        if default_netloc and not self.parsed.netloc:
+        if default_scheme and not self.parsed.scheme and self.netloc:
+            self.scheme = default_scheme
+        if default_netloc and not self.parsed.netloc and self.scheme in ["http", "https", ""]:
             self.netloc = default_netloc
-        if default_filepath and default_filepath not in self.filepath:
+        if default_filepath and default_filepath not in self.filepath and self.scheme in ["http", "https", ""]:
             # we have a parent path we need to append to the existing one
             new_path = str(PurePath(default_filepath, self.path))
             # note: I don't want .. since this is web urls; using normpath to remove them unless symlinks is true
@@ -80,10 +82,8 @@ class ParsedUrl:
             if new_path.endswith(default_filepath) or new_path.endswith(default_filepath[:-1]) and not new_path.endswith('/'):
                 new_path += '/'
             self.path = new_path
-        if default_scheme and not self.parsed.scheme and self.netloc:
-            self.scheme = default_scheme
         # one last correction; if we have a scheme but no netloc lets omit the scheme so it doesn't give bad results
-        if not self.parsed.netloc and self.parsed.scheme:
+        if not self.parsed.netloc and self.parsed.scheme and self.parsed.scheme in ['http', 'https']:
             self.parsed = self.parsed._replace(scheme='')
 
     @property
@@ -222,12 +222,12 @@ if __name__ == "__main__":
     # parsed_url = ParsedUrl(test_uri)
     # print(f"root domain [{test_uri}]: {parsed_url.get_root_domain()}")
     # print(f"url:{parsed_url.url}")
-    # test_uri = "/?id=1&b=&c=3"
-    # parsed_url = ParsedUrl(test_uri, default_netloc='ex.org')
-    # print(f"root domain [{test_uri}]: {parsed_url.root_domain}")
-    # print(f"url:{parsed_url.url}")
-    # print(f"base: {parsed_url.base}")
-    # print(f"rel: {parsed_url.rel}")
+    test_uri = "/?id=1&b=&c=3"
+    parsed_url = ParsedUrl(test_uri, default_netloc='ex.org')
+    print(f"root domain [{test_uri}]: {parsed_url.root_domain}")
+    print(f"url:{parsed_url.url}")
+    print(f"base: {parsed_url.base}")
+    print(f"rel: {parsed_url.rel}")
     # print(f"url after base: {parsed_url.url}")
     # parsed_url.domain = "ex.org"
     # print(f"root domain [{str(parsed_url)}]: {parsed_url.root_domain}")
@@ -241,9 +241,13 @@ if __name__ == "__main__":
     # print(f"test parent fragment only: {ParsedUrl(test_uri, default_netloc='localhost:8000', default_scheme='http', default_path='/mdb/')}")
     # test_uri = "#testproduct"
     # print(f"test parent fragment only: {ParsedUrl(test_uri, default_netloc='localhost:8000', default_scheme='http', default_path='/mdb/')}")
-    test_uri = "/products/"
-    purl = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/blog')
-    print(purl)
-    test_uri = "../products/"
-    purl = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/')
-    print(purl)
+    # test_uri = "/products/"
+    # purl = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/blog')
+    # print(purl)
+    # test_uri = "../products/"
+    # purl = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000', default_filepath='/')
+    # print(purl)
+    # # test mailto links
+    test_uri = 'mailto:me@mail.com?subject=mysubject&body=mybody'
+    purl = ParsedUrl(test_uri, default_scheme='http', default_netloc='localhost:8000')
+    print(purl)

python-ubercode-utils-1.0.9/test/test_xml.py

@@ -1,61 +0,0 @@
-import unittest
-from ubercode.utils.xml import XML
-from pathlib import Path
-
-
-class TestXML(unittest.TestCase):
-
-    # -------- common usages ----------
-    def test_XML(self):
-        # calculate the filename for our test.xml file from this file (much like settings does)
-        file_path = Path(__file__).resolve().parent / 'test.xml'
-        xml_string = """
-<contacts>
-    <contact>
-        <name>Steve Stacha</name>
-    </contact>
-    <contact>
-        <name>Buggs Bunny</name>
-    </contact>
-    <contact>
-        <name>Daffy Duck</name>
-    </contact>
-</contacts>
-"""
-        # test we can construct from an xml string
-        xml = XML(xml_string=xml_string)
-        # NOTE: because we used a multiline string we need to strip the extra newlines before and after <contacts>
-        self.assertEqual(str(xml), xml_string.strip())
-        # normal string doesn't need stripping
-        xml_compact_string = "<contacts><contact><name>Buggs Bunny</name></contact><contact><name>Daffy Duck</name></contact></contacts>"
-        xml2 = XML(xml_compact_string)
-        self.assertEqual(str(xml2), xml_compact_string)
-        # test we can create using the from_xml_string() method chaining
-        xml3 = XML().from_xml_string(xml_compact_string)
-        self.assertEqual(str(xml2), str(xml3))
-        # test that method chaining after constructor overrides the value in place
-        self.assertNotEqual(str(xml), str(xml2))
-        xml.from_xml_string(xml_compact_string)
-        self.assertEqual(str(xml), str(xml2))
-        # test that we can read from file
-        xml.from_xml_file(file_path)
-        # we should be back to before
-        self.assertEqual(str(xml), xml_string.strip())
-        # test an attribute
-        xml_string = """
-<contacts>
-    <contact attr="1">
-        <name>Steve Stacha</name>
-    </contact>
-    <contact>
-        <name>Buggs & Bunny</name>
-    </contact>
-    <contact>
-        <name>Daffy Duck</name>
-    </contact>
-</contacts>
-"""
-        xml = XML(xml_string=xml_string, encode_ampersands=True)
-        xml_dict = xml.to_dict()
-        self.assertEqual(xml_dict['contacts']['contact'][0]['@attr'], '1')
-

python-ubercode-utils-1.0.9/ubercode/utils/json.py

@@ -1,54 +0,0 @@
-"""
-A collection of basic json conversion helper utilities.
-"""
-import json
-import re
-# from typing import Self (Not available until 3.9; omitting for now)
-
-
-class JSON:
-    """ simple json class to encapsulate basic json operations """
-    # the base implementation will be dict
-    json_dict = {}
-
-    def __init__(self, json_string: str or None = None, encode_ampersands: bool = False):
-        self.encode_ampersands = encode_ampersands
-        self.from_json_string(json_string)
-
-    def from_json_string(self, json_string: str):
-        """
-        read in from json_string
-        :param json_string:
-        :return: self
-        """
-        if json_string:
-            if self.encode_ampersands:
-                regex = re.compile(r"&(?!amp;|lt;|gt;)")
-                json_string = regex.sub("&", json_string)
-            self.json_dict = json.loads(json_string)
-        return self
-
-    def from_json_file(self, json_file_path: str):
-        """
-        read in from json_file
-        :param json_file_path: string to file
-        :return: self
-        """
-        with open(json_file_path, encoding='utf-8-sig') as json_file:
-            json_string = json_file.read()
-        if json_string:
-            if self.encode_ampersands:
-                regex = re.compile(r"&(?!amp;|lt;|gt;)")
-                json_string = regex.sub("&", json_string)
-            self.json_dict = json.loads(json_string)
-        return self
-
-    def to_dict(self) -> dict:
-        """
-        output to dict
-        :return: dict
-        """
-        return self.json_dict
-
-    def __str__(self):
-        return str(self.json_dict)