python-ubercode-utils 2.0.3__tar.gz → 2.0.5__tar.gz

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/PKG-INFO

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

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/python_ubercode_utils.egg-info/PKG-INFO

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

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/setup.py

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

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/test/test_environment.py

@@ -80,7 +80,9 @@ class TestEnvironment(unittest.TestCase):
         }
         environment = Environment(environment_variable_map=os_vars)
         # test we can override just the database file name
-        DATABASES = environment.override_database_variables(DATABASES)
+        with redirect_stdout(StringIO()) as sout:
+            DATABASES = environment.override_database_variables(DATABASES)
+        print(f"override_vars password log output \n{sout.getvalue()}")
         self.assertEqual(DATABASES['default']['NAME'], BASE_DIR / "sqlite.db")
         # test we can take the default sqlite database and change it to a full mysql connection using env vars
         os_vars = {
@@ -95,8 +97,7 @@ class TestEnvironment(unittest.TestCase):
         # test we can override the default sqllite for dev laptops with a full mysql connection on a deployed server
         with redirect_stdout(StringIO()) as sout:
             DATABASES = environment.override_database_variables(DATABASES)
-        log_output = sout.getvalue()
-        print(log_output)
+        print(f"override_vars log output \n{sout.getvalue()}")
         self.assertEqual(DATABASES['default']['ENGINE'], 'django.db.backends.mysql')
         self.assertEqual(DATABASES['default']['HOST'], 'testdb.example.org')
         self.assertEqual(DATABASES['default']['NAME'], 'test')
@@ -104,11 +105,63 @@ class TestEnvironment(unittest.TestCase):
         self.assertEqual(DATABASES['default']['PASSWORD'], 'Test_insecure_password')
         self.assertEqual(DATABASES['default']['PORT'], 3306)
         # test our password is encoded when logged
-        self.assertTrue("Test_insecure_password" not in log_output)
-        self.assertTrue("Test_************sword" in log_output)
+        self.assertTrue("Test_insecure_password" not in sout.getvalue())
+        self.assertTrue("Test_************sword" in sout.getvalue())
         # test a None still works for initialization
         self.assertIsNotNone(Environment())
 
+    def test_override_database_urls(self):
+        # we will start with the default dict for a new django install
+        BASE_DIR = Path(__file__).resolve().parent
+        DATABASES = {
+            'default': {
+                'ENGINE': 'django.db.backends.sqlite3',
+                'NAME': BASE_DIR / 'db.sqlite3',
+            }
+        }
+        db_override = BASE_DIR / "sqlite.db"
+        os_vars = {
+            "DJ_URL_default": f"://@/{db_override}",
+#            "DATABASES__default__NAME": BASE_DIR / "sqlite.db",
+            "TEST_DATE": "2023-02-21 08:30:00",
+            "TEST_INT": "1",
+            "PW": "abc1234def",
+            "TEST_STRING": "abc1234def"
+        }
+        environment = Environment(environment_variable_map=os_vars)
+        # test we can override just the database file name
+        with redirect_stdout(StringIO()) as djurl_out:
+            DATABASES = environment.override_database_urls(DATABASES)
+        print(f"djurl password log output: \n{djurl_out.getvalue()}")
+
+        self.assertEqual(DATABASES['default']['NAME'], str(db_override))
+        # test we can take the default sqlite database and change it to a full mysql connection using env vars
+        # os_vars = {
+        #     'DATABASES__default__ENGINE': 'django.db.backends.mysql',
+        #     'DATABASES__default__HOST': 'testdb.example.org',
+        #     'DATABASES__default__NAME': 'test',
+        #     'DATABASES__default__USER': 'testuser',
+        #     'DATABASES__default__PASSWORD': 'Test_insecure_password',
+        #     'DATABASES__default__PORT': 3306,
+        # }
+        os_vars = {
+            'DJ_URL_default': 'django.db.backends.mysql://testuser:Test_insecure_password@testdb.example.org:3306/test'
+        }
+        environment = Environment(environment_variable_map=os_vars)
+        # test we can override the default sqllite for dev laptops with a full mysql connection on a deployed server
+        with redirect_stdout(StringIO()) as djurl_out:
+            DATABASES = environment.override_database_urls(DATABASES)
+        print(f"djurl full log output \n{djurl_out.getvalue()}")
+        self.assertEqual(DATABASES['default']['ENGINE'], 'django.db.backends.mysql')
+        self.assertEqual(DATABASES['default']['HOST'], 'testdb.example.org')
+        self.assertEqual(DATABASES['default']['NAME'], 'test')
+        self.assertEqual(DATABASES['default']['USER'], 'testuser')
+        self.assertEqual(DATABASES['default']['PASSWORD'], 'Test_insecure_password')
+        self.assertEqual(DATABASES['default']['PORT'], 3306)
+        # test our password is encoded when logged
+        self.assertTrue("Test_insecure_password" not in djurl_out.getvalue())
+
+
     def test_timer(self):
         timer = Timer().start()
         time.sleep(3)

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/test/test_urls.py

@@ -1,9 +1,8 @@
 import unittest
-from contextlib import redirect_stdout
-from io import StringIO
 
 from ubercode.utils.urls import ParsedUrl
 from ubercode.utils.urls import ParsedQueryString
+from ubercode.utils.urls import DjUrl
 
 
 class TestUrls(unittest.TestCase):
@@ -49,7 +48,61 @@ class TestUrls(unittest.TestCase):
         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)
-
+        # test that a full django database url parses to the individual parts correctly
+        dj_db_url = DjUrl('django.db.backends.mysql://scott:tiger@localhost:1366/test')
+        self.assertEqual(dj_db_url.engine,'django.db.backends.mysql')
+        self.assertEqual(dj_db_url.host, 'localhost')
+        self.assertEqual(dj_db_url.user, 'scott')
+        self.assertEqual(dj_db_url.password, 'tiger')
+        self.assertEqual(dj_db_url.port, 1366)
+        self.assertEqual(dj_db_url.name, 'test')
+        # test that str masks password
+        self.assertNotIn(str(dj_db_url), 'tiger')
+        # test that a missing one is falsy so it doesn't get overridden at startup
+        dj_db_url = DjUrl('://localhost/test')
+        self.assertFalse(dj_db_url.engine)
+        self.assertFalse(dj_db_url.user)
+        self.assertFalse(dj_db_url.password)
+        self.assertFalse(dj_db_url.port)
+        self.assertTrue(dj_db_url.host)
+        self.assertTrue(dj_db_url.name)
+        # test that an empty url doesn't break and returns false for everything
+        dj_db_url = DjUrl('')
+        self.assertFalse(dj_db_url.engine)
+        self.assertFalse(dj_db_url.user)
+        self.assertFalse(dj_db_url.password)
+        self.assertFalse(dj_db_url.port)
+        self.assertFalse(dj_db_url.host)
+        self.assertFalse(dj_db_url.name)
+        # test that str returns an encoded version that may include separators but can be re-initted correctly
+        dj_db_url = DjUrl(str(dj_db_url))
+        self.assertFalse(dj_db_url.engine)
+        self.assertFalse(dj_db_url.user)
+        self.assertFalse(dj_db_url.password)
+        self.assertFalse(dj_db_url.port)
+        self.assertFalse(dj_db_url.host)
+        self.assertFalse(dj_db_url.name)
+        # test that just password works since this is most common
+        dj_db_url = DjUrl(':asdf:!/stuff #')
+        self.assertEqual(dj_db_url.password, 'asdf:!/stuff #')
+        # test encoded @ for password since that could be needed
+        dj_db_url = DjUrl(':asfcasdf23%401:/!?--atencoded')
+        self.assertEqual(dj_db_url.password, 'asfcasdf23@1:/!')
+        # test that we can pass a dict of database properties and have it fill in
+        default = {
+            'ENGINE': 'django.db.backends.mysql',
+            'HOST': 'localhost',
+            'USER': 'scott',
+            'PASSWORD': 'tiger',
+            'PORT': '3306',
+            'NAME': 'test'
+        }
+        dj_db_url = DjUrl().from_dict(default)
+        self.assertEqual(str(dj_db_url), 'django.db.backends.mysql://scott:t***r@localhost:3306/test')
+        # test that to_dict ignores None values so we only have overrides
+        dj_db_url = DjUrl(':testoverridepasswordonly')
+        override_dict = dj_db_url.to_dict()
+        self.assertEqual(str(override_dict), "{'PASSWORD': 'testoverridepasswordonly'}")
 
     # --- basic retrieval
     # -------------------

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/ubercode/utils/convert.py

@@ -13,7 +13,7 @@ FALSE_VALUES = [None, False, 0, "0", "n", "f", "false", "no", "off"]
 
 
 # -------- helper utilities ----------
-def strip(value: str or None, strip_chars: str = None, left: bool = True, right: bool = True) -> str or None:
+def strip(value: str | None, strip_chars: str = None, left: bool = True, right: bool = True) -> str | None:
     """
     return stripped value if possible or original value
     :param value: str value to be stripped
@@ -94,7 +94,7 @@ def to_bool(value) -> bool:
     return bool(value)
 
 
-def is_true(value: int or bool or str) -> bool:
+def is_true(value: int | bool | str) -> bool:
     """
     Convert <value> to a True boolean value.  Useful when you want to convert a passed parameter to True if it matches
     one of the defined TRUE_VALUES above; otherwise False.
@@ -121,7 +121,7 @@ def to_js_bool(bool_value: bool) -> str:
     return "false"
 
 
-def to_int(value, default: int = 0, none_to_default: bool = True, suppress_warnings: bool = True) -> int or None:
+def to_int(value, default: int | None = 0, none_to_default: bool = True, suppress_warnings: bool = True) -> int | None:
     """
     Convert <value> to int.  Will always return integer or none instead of throwing exception
     @param value: value to be converted
@@ -201,7 +201,7 @@ def from_iso8601_compact(value: Any = None, tz: timezone = timezone.utc):
     return _value
 
 
-def to_date(value: Any = None, tz: timezone or None = timezone.utc, none_to_now: bool = True, suppress_warnings: bool = True):
+def to_date(value: Any = None, tz: timezone | None = timezone.utc, none_to_now: bool = True, suppress_warnings: bool = True):
     """
     Convert string to python date.  Currently, only concerned about iso8601 and db type formats.
     None returns current date by default but can be overridden with none_to_now optional parameter
@@ -232,7 +232,7 @@ def to_date(value: Any = None, tz: timezone or None = timezone.utc, none_to_now:
 
 
 # -------- helper conversions --------
-def to_mask(value: str or None) -> str or None:
+def to_mask(value: str | None) -> str | None:
     _mask = value
     if isinstance(value, str) and value is not None and len(value) > 0:
         # if we are less than 4 chars then mask the entire string

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/ubercode/utils/environment.py

@@ -7,8 +7,10 @@ import time
 from datetime import datetime
 from typing import Any, Tuple
 from pathlib import Path
+
 from ubercode.utils.logging import ColorLogger
 from ubercode.utils import convert
+from ubercode.utils.urls import DjUrl
 
 _utils_settings_logger = ColorLogger("utils.environment")
 
@@ -225,6 +227,44 @@ class Environment:
                             f"{db_parts[0]}[{db_parts[1]}][{db_parts[2]}] has a database or property naming issue!")
         return db_dict
 
+    def override_database_urls(self, db_dict: dict) -> dict:
+        """
+        Much like above,iterates over environment variables and overrides any database variables. However, instead
+        of looking for each variable with a pattern like DATABASES__default__ENGINE it looks for DJ_URL_ prefix and
+        parses the url into a DjUrl object.  This allows property files to use one line per database config
+        instead of one key,value pair per variable like: DJ_URL_default = 'django.db.backends.mysql://scott:tiger@localhost:1366/test'
+        NOTE: you can omit everything except what you want to replace like: '://:newpassword@' which
+        will only replace the password
+
+        :param db_dict: settings database dictionary to replace variables in ex: DATABASES
+        :return: new dict with updated overridden values
+        """
+        items = []
+        if hasattr(self._env_map, "items"):
+            items = self._env_map.items()
+        elif hasattr(os.environ, "items"):
+            items = os.environ.items()
+        for k, v in items:
+            # unlike override_database_variables() we will look for prefix DJ_URL_
+            if k and str(k).upper().startswith('DJ_URL_') and v:
+                # the actual key is the remaining part left
+                key = str(k)[len('DJ_URL_'):]
+                djurl = DjUrl(str(v))
+                for attr, value in vars(djurl).items():
+                    if value:
+                        if not db_dict.get(key):
+                            self._logger.warn(f'Missing database key [{key}]! creating...')
+                            db_dict[key] = {}
+                        _log_from_value = db_dict[key].get(attr.upper(), 'None')
+                        _log_to_value = value
+                        if attr.upper() in self._secret_properties:
+                            _log_to_value = convert.to_mask(value)
+                        db_dict[key][attr.upper()] = value
+                        self._logger.info(
+                            f'set [{key}][{attr.upper()}] from [{_log_from_value}] to [{_log_to_value}]')
+        return db_dict
+
+
 class FauxApp:
     def __init__(self, logger: ColorLogger = None, notebook_path: Path = Path(), default_dict: dict = None) -> None:
         self._logger = logger if logger else _utils_settings_logger

{python_ubercode_utils-2.0.3 → python_ubercode_utils-2.0.5}/ubercode/utils/urls.py

@@ -1,8 +1,8 @@
 import os
 from urllib.parse import urlsplit
-from ubercode.utils.convert import to_str
+from ubercode.utils.convert import to_str, to_int
 from pathlib import PurePath
-
+from .convert import to_mask
 
 class ParsedQueryString:
     """
@@ -216,6 +216,123 @@ class ParsedUrl:
         """
         return self.url
 
+class DjUrl:
+    engine = None
+    user = None
+    password = None
+    host = None
+    port = None
+    name = None
+
+    def __init__(self, dj_url: str = None) -> None:
+        """
+        parses a packed "django_url" into its parts following similar rules to SqlAlchemy
+        format: engine://user:password@host[:port]/dbname
+        example: django.db.backends.mysql://scott:tiger@localhost:1366/test
+
+        NOTE: asking for the string value will give back the original packed url masking the password
+        NOTE: to_dict will give back the dictionary values to be added or replaced in the DATABASES dict
+
+        :param url: packed django url  ex: django.db.backends.mysql://scott:tiger@localhost:1366/test
+        """
+        dj_url = dj_url or ""
+        dj_url = dj_url.strip()
+        encoded = False
+        if dj_url.endswith('?--atencoded'):
+            encoded = True
+            dj_url = dj_url[:-len('?--atencoded')].strip()
+        if not dj_url:
+            return
+        pos = dj_url.find('://')
+        if pos > -1:
+            self.engine = dj_url[:pos].strip() or None
+            constr = dj_url[pos + len('://'):].strip()
+        else:
+            constr = dj_url
+        pos = constr.find("@")
+        if pos > -1:
+            loginstr = constr[:pos].strip()
+            constr = constr[pos + len("@"):].strip()
+            pos = loginstr.find(':')
+            if pos > -1:
+                self.user = loginstr[:pos].strip() or None
+                self.password = loginstr[pos + len(':'):].strip() or None
+                if encoded:
+                    self.password = self.password.replace('%40', '@')
+            elif len(loginstr) > 0:
+                self.user = loginstr or None
+        else:
+            # since password is the most common replacement look for that specifically next if we didn't have an @
+            # NOTE: since password can contain / we will assume the only thing there is the password otherwise use @
+            # Ex: DjUrl(':newpassword/newdatabase') -> password=newpassword/newdatabase name=None
+            #     DjUrl(':newpassword@/newdatabase') -> password=newpassword name=newdatabase
+            #     DjUrl(':asfcasdf23%401:/!?--atencoded') -> password=asfcasdf23@1:/! name=None port=None
+            if constr.startswith(':'):
+                self.password = constr.strip(':')
+                constr = ''
+                if encoded:
+                    self.password = self.password.replace('%40', '@')
+        # NOTE: constr now contains everything after @ - no engine, user, password
+        # NOTE: may have port but no db ex: @:8080
+        pos = constr.find('/')
+        if pos > -1:
+            hoststr = constr[:pos].strip()
+            self.name = constr[pos + len('/'):].strip() or None
+        else:
+            hoststr = constr
+        # all that is left is hoststr
+        pos = hoststr.find(':')
+        if pos > -1:
+            self.host = hoststr[:pos].strip() or None
+            self.port = hoststr[pos + len(':'):].strip() or None
+            if self.port:
+                self.port = to_int(self.port, default=None, none_to_default=False)
+        elif len(hoststr) > 0:
+            self.host = hoststr
+
+#
+    def from_dict(self, properties_dict: dict):
+        """
+        overrides instance properties with dictionary values
+        NOTE: rule is that we expect the instance propery to be attribute uppercased
+        EX: self.name = properties_dict[self.name.upper()]
+
+        :param properties_dict: dictionary values
+        :return: this instance for chaining. ex: x = DjUrl().from_dict({"ENGINE": "test"})
+        """
+        if isinstance(properties_dict, dict):
+            for attr, value in vars(DjUrl).items():
+                if not attr.startswith('__') and not callable(value) and not attr.startswith('_'):
+                    setattr(self, attr, properties_dict.get(attr.upper(), value))
+        return self
+
+    def to_dict(self) -> dict:
+        """
+        converts instance properties to dictionary values
+        NOTE: does not convert None values
+
+        :return: dict of values in upper case for replacement in django databases settings
+        """
+        dct = {}
+        for attr, value in vars(DjUrl).items():
+            if not attr.startswith('__') and not callable(value) and not attr.startswith('_'):
+                if getattr(self, attr) is not None:
+                    dct[attr.upper()] = getattr(self, attr)
+        return dct
+
+    def __str__(self) -> str:
+        url = f"{self.engine or ''}://"
+        if self.user:
+            url += self.user
+        if self.password:
+            url += f":{to_mask(self.password)}"
+        url += f"@{self.host or ''}"
+        if self.port:
+            url += f":{self.port}"
+        if self.name:
+            url += f"/{self.name}"
+        return url
+
 
 if __name__ == "__main__":
     # test_uri = "http://localhost:8000/test1/?id=1&x=2"