python-ubercode-utils 2.0.2__py3-none-any.whl → 2.0.4__py3-none-any.whl

{python_ubercode_utils-2.0.2.dist-info → python_ubercode_utils-2.0.4.dist-info}/METADATA

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

python_ubercode_utils-2.0.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+ubercode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ubercode/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ubercode/utils/convert.py,sha256=INxAIlIkwTeHSdVpqm8R_N5MzrSrjY9CduioHipu39g,11370
+ubercode/utils/cursor.py,sha256=zHqbmUavCF0l7ck_Tu4PfgSzRO762ULKHYsnqa3r0uY,1118
+ubercode/utils/data.py,sha256=DStj9BAXPSPvQRZwfEQVYt19EoMavyNFt11U8ZnhagE,4364
+ubercode/utils/dataframe.py,sha256=3AYoZGZB7wtN5brBDfRgnuIaEubhRrSc7qx8hi_vaaE,1616
+ubercode/utils/environment.py,sha256=97uYs0zGBkk7TfKuml6Th27kpdtYX_ILwfZTQW3Xac8,15818
+ubercode/utils/logging.py,sha256=s4yIJWHo9MVO4oSk5IF3z6XTk-FOuyEiKnPFkiza3h4,9204
+ubercode/utils/urls.py,sha256=N2B0s849WRpV_JWc20hBb4129UZZkeWEcPjfd9rggrY,13399
+python_ubercode_utils-2.0.4.dist-info/LICENSE,sha256=lch0WEJaqJY3C5aCYSr0u6Gw0set96a2fp9ZWJRYuR8,1069
+python_ubercode_utils-2.0.4.dist-info/METADATA,sha256=L5_YcnH89oIyTP_EeOLQR-AycJUR4YLHvEly5_RSRV0,1225
+python_ubercode_utils-2.0.4.dist-info/WHEEL,sha256=hPN0AlP2dZM_3ZJZWP4WooepkmU9wzjGgCLCeFjkHLA,92
+python_ubercode_utils-2.0.4.dist-info/top_level.txt,sha256=5BojzbvNCpPkFXcVQVr7cfovhbYQYAlMKgiHSMgi7VU,9
+python_ubercode_utils-2.0.4.dist-info/RECORD,,

{python_ubercode_utils-2.0.2.dist-info → python_ubercode_utils-2.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.44.0)
+Generator: bdist_wheel (0.46.3)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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

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

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,99 @@ 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 to_dict(self) -> dict:
+        dct = {}
+        for attr, value in vars(self).items():
+            dct[attr.upper()] = value
+        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"

python_ubercode_utils-2.0.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-ubercode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ubercode/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ubercode/utils/convert.py,sha256=YWIacPg3MaUTGSANZ2yzxanIkUCH2oyqOR6Wvtz91Fg,11371
-ubercode/utils/cursor.py,sha256=zHqbmUavCF0l7ck_Tu4PfgSzRO762ULKHYsnqa3r0uY,1118
-ubercode/utils/data.py,sha256=DStj9BAXPSPvQRZwfEQVYt19EoMavyNFt11U8ZnhagE,4364
-ubercode/utils/dataframe.py,sha256=3AYoZGZB7wtN5brBDfRgnuIaEubhRrSc7qx8hi_vaaE,1616
-ubercode/utils/environment.py,sha256=zSgemMspWx1mBPeI2CSStCSj_kjVm_rEVZaNRkEMsZM,13657
-ubercode/utils/logging.py,sha256=s4yIJWHo9MVO4oSk5IF3z6XTk-FOuyEiKnPFkiza3h4,9204
-ubercode/utils/urls.py,sha256=PaksDHVg_aSXEqcN4SlLgY-erqeMCNw8mYK9qt3q05I,9652
-python_ubercode_utils-2.0.2.dist-info/LICENSE,sha256=lch0WEJaqJY3C5aCYSr0u6Gw0set96a2fp9ZWJRYuR8,1069
-python_ubercode_utils-2.0.2.dist-info/METADATA,sha256=Oe6G8phzfGZ6SFVZdd7FDgsNGjjF999kF4e70dU4dEE,1225
-python_ubercode_utils-2.0.2.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-python_ubercode_utils-2.0.2.dist-info/top_level.txt,sha256=5BojzbvNCpPkFXcVQVr7cfovhbYQYAlMKgiHSMgi7VU,9
-python_ubercode_utils-2.0.2.dist-info/RECORD,,