ipulse-shared-core-ftredge 2.6__py3-none-any.whl → 2.6.1__py3-none-any.whl

ipulse_shared_core_ftredge/utils/utils_common.py

@@ -0,0 +1,145 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=logging-fstring-interpolation
+# pylint: disable=line-too-long
+# pylint: disable=missing-class-docstring
+# pylint: disable=broad-exception-caught
+
+import os 
+import json
+
+def log_error(message, logger=None , print_out=False, exc_info=False):
+    if logger:
+        logger.error(message, exc_info=exc_info)
+    elif print_out:
+        print(message)
+
+def log_warning(message, logger=None, print_out=False):
+    if logger:
+        logger.warning(message)
+    elif print_out:
+        print(message)
+
+def log_info(message, logger=None, print_out=False):
+    if logger:
+        logger.info(message)
+    elif print_out:
+        print(message)
+
+
+def save_json_locally_extended(data:dict | list | str, file_name:str, local_path:str, file_exists_if_starts_with_prefix:str=None, overwrite_if_exists:bool=False, increment_if_exists:bool=False,
+                      max_deletable_files:int=1, logger=None, print_out=False):
+    
+    """Saves data to a local JSON file.
+
+    Args:
+        data (dict | list | str): The data to save.
+        file_name (str): The desired file name.
+        local_path (str): The directory where the file should be saved.
+        file_exists_if_starts_with_prefix (str, optional):  If provided, used to check for
+            existing files with the given prefix. Defaults to None.
+        overwrite_if_exists (bool, optional): If True, overwrites existing files. Defaults to False.
+        increment_if_exists (bool, optional): If True, increments the file name if it exists.
+            Defaults to False.
+        max_deletable_files (int, optional): Maximum number of files to delete when overwriting. 
+            Defaults to 1.
+
+    Returns:
+        dict: Metadata about the save operation, including:
+            - local_path (str): The full path to the saved file (or None if not saved).
+            - local_file_already_exists (bool): True if a file with the same name or prefix existed.
+            - local_file_overwritten (bool): True if an existing file was overwritten.
+            - local_deleted_file_names (str): A comma-separated string of deleted file names (or None).
+            - local_file_saved_with_increment (bool): True if the file was saved with an incremented name.
+            - local_save_error (bool): True if there was an error saving the file.
+    """
+
+    local_save_error=None
+    # Input validation
+    if overwrite_if_exists and increment_if_exists:
+        msg = "Both 'overwrite_if_exists' and 'increment_if_exists' cannot be True simultaneously."
+        log_error(msg, logger=logger, print_out=print_out)
+        return {"local_save_error" : msg} 
+    if max_deletable_files > 10:
+        msg = "max_deletable_files should be less than 10 for safety. For more, use another method."
+        log_error(msg, logger=logger, print_out=print_out)
+        return {"local_save_error" : msg}
+    
+
+    # Prepare data
+    if isinstance(data, (list, dict)):
+        data_str = json.dumps(data, indent=2)
+    else:
+        data_str = data
+
+
+    # Extract directory from file_name if present
+    directory = os.path.dirname(file_name)
+    full_local_path = os.path.join(local_path, directory)
+
+    # Create the full directory path if it doesn't exist
+    os.makedirs(full_local_path, exist_ok=True)
+
+    # Now use the full file path including the subdirectories
+    base_file_name, ext = os.path.splitext(os.path.basename(file_name)) 
+    increment = 0
+    full_file_path = os.path.join(full_local_path, f"{base_file_name}{ext}")
+
+    # Metadata
+    local_path = None
+    local_file_already_exists = False
+    local_file_overwritten = False
+    local_file_saved_with_increment = False
+    local_deleted_file_names = None
+    local_save_error = None
+
+    try:
+        # --- Overwrite Logic ---
+        if overwrite_if_exists:
+            if file_exists_if_starts_with_prefix:
+                files_to_delete = [
+                    f for f in os.listdir(full_local_path)
+                    if f.startswith(file_exists_if_starts_with_prefix)
+                ]
+                if len(files_to_delete) > max_deletable_files:
+                    raise ValueError(
+                        f"Error: Attempt to delete {len(files_to_delete)} matched files, but limit is {max_deletable_files}."
+                    )
+                if files_to_delete:
+                    local_file_already_exists = True
+                    for file in files_to_delete:
+                        os.remove(os.path.join(full_local_path, file))
+                    local_file_overwritten = True
+                    local_deleted_file_names = ",,,".join(files_to_delete)
+            elif os.path.exists(full_file_path):
+                local_file_already_exists = True
+                os.remove(full_file_path)
+                local_file_overwritten = True
+
+        # --- Increment Logic ---
+        elif increment_if_exists:
+            while os.path.exists(full_file_path):
+                local_file_already_exists = True
+                increment += 1
+                file_name = f"{base_file_name}_v{increment}{ext}"
+                full_file_path = os.path.join(full_local_path, file_name)
+                local_file_saved_with_increment = True
+
+        # --- Save the File ---
+        with open(full_file_path, "w", encoding="utf-8") as f:
+            f.write(data_str)
+        local_path = full_file_path
+
+    except Exception as e:
+        local_save_error=f"Error saving file to local path: {full_file_path} : {type(e).__name__}-{str(e)}"
+        log_error(local_save_error, logger=logger, print_out=print_out)
+        return {"local_save_error" : msg}
+
+    return {
+        "local_path": local_path,
+        "local_file_already_exists": local_file_already_exists,
+        "local_file_overwritten": local_file_overwritten,
+        "local_deleted_file_names": local_deleted_file_names,
+        "local_file_saved_with_increment": local_file_saved_with_increment,
+        "local_save_error": local_save_error,
+    }

ipulse_shared_core_ftredge/utils/utils_templates_and_schemas.py

@@ -0,0 +1,151 @@
+# pylint: disable=missing-module-docstring
+# pylint: disable=missing-function-docstring
+# pylint: disable=logging-fstring-interpolation
+# pylint: disable=line-too-long
+# pylint: disable=broad-exception-caught
+
+import datetime
+from ipulse_shared_core_ftredge.enums.enums_logs import LogLevel
+from ipulse_shared_core_ftredge.utils.logs.context_log import ContextLog
+
+
+def check_format_against_schema_template(data_to_check, schema, dt_ts_to_str=True, check_max_length=True):
+    """Ensure Update dict corresponds to the config schema, ensuring proper formats and lengths."""
+    checked_data = {}
+    warnings_or_error = []  # Group warnings and errors for a given run
+
+    try:
+        # Process updates to conform to the schema
+        for field in schema:
+            field_name = field["name"]
+            field_type = field["type"]
+            mode = field["mode"]
+
+            # Initialize notice to None at the start of each field processing
+            warning = None
+
+            if field_name in data_to_check:
+                value = data_to_check[field_name]
+                if value is None:
+                    if mode == "REQUIRED":
+                        warnings_or_error.append(ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                                subject=field_name,
+                                                description=f"Required field '{field_name}' is missing in the updates."))
+                        continue
+                else:
+                    # Handle date and timestamp formatting
+                    if field_type == "DATE":
+                        value, warning = handle_date_fields(field_name, value, dt_ts_to_str)
+                    elif field_type == "TIMESTAMP":
+                        value, warning = handle_timestamp_fields(field_name, value, dt_ts_to_str)
+                    elif field_type in ["STRING", "INT64", "FLOAT64", "BOOL"]:
+                        value, warning = handle_type_conversion(field_type, field_name, value)
+
+                    if warning:
+                        warnings_or_error.append(warning)
+
+                    # Check and handle max length restriction
+                    if check_max_length and "max_length" in field:
+                        value, warning = check_and_truncate_length(field_name, value, field["max_length"])
+                        if warning:
+                            warnings_or_error.append(warning)
+
+                    # Only add to the dictionary if value is not None or the field is required
+                    checked_data[field_name] = value
+
+            elif mode == "REQUIRED":
+                warnings_or_error.append(ContextLog(level=LogLevel.WARNING,
+                                              subject=field_name,
+                                              description=f"Required field '{field_name}' is missing in the updates."))
+
+    except Exception as e:
+        warnings_or_error.append(ContextLog(level=LogLevel.ERROR_EXCEPTION,
+                                            e=e,
+                               subject=data_to_check,
+                               description=f"An error occurred during update check: {str(e)}"))
+
+    return checked_data, warnings_or_error
+
+
+
+def handle_date_fields(field_name, value, dt_ts_to_str):
+    """Handles date fields, ensuring they are in the correct format and optionally converts them to string."""
+    if isinstance(value, datetime.date):
+        if dt_ts_to_str:
+            return value.strftime("%Y-%m-%d"), None
+        return value, None
+    elif isinstance(value, str):
+        try:
+            parsed_date = datetime.datetime.strptime(value, "%Y-%m-%d").date()
+            if dt_ts_to_str:
+                return value, None
+            return parsed_date, None
+        except ValueError:
+            return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                                  subject=field_name,
+                                                   description=f"Expected a DATE in YYYY-MM-DD format but got {value}.")
+    else:
+        return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                              subject=field_name,
+                                              description= f"Expected a DATE or YYYY-MM-DD str format but got {value} of type {type(value).__name__}.")
+
+
+def handle_timestamp_fields(field_name, value, dt_ts_to_str):
+    """Handles timestamp fields, ensuring they are in the correct format and optionally converts them to ISO format string."""
+    if isinstance(value, datetime.datetime):
+        if dt_ts_to_str:
+            return value.isoformat(), None
+        return value, None
+    elif isinstance(value, str):
+        try:
+            parsed_datetime = datetime.datetime.fromisoformat(value)
+            if dt_ts_to_str:
+                return value, None
+            return parsed_datetime, None
+        except ValueError:
+            return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                                  subject=field_name,
+                                                  description= f"Expected ISO format TIMESTAMP but got {value}.")
+    else:
+        return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                              subject=field_name,
+                                              description= f"Expected ISO format TIMESTAMP but got {value} of type {type(value).__name__}.")
+
+
+def check_and_truncate_length(field_name, value, max_length):
+    """Checks and truncates the length of string fields if they exceed the max length."""
+    if isinstance(value, str) and len(value) > max_length:
+        return value[:max_length], ContextLog(level=LogLevel.WARNING_FIX_RECOMMENDED,
+                            subject= field_name,
+                             description= f"Field exceeds max length: {len(value)}/{max_length}. Truncating.")
+
+    return value, None
+
+
+
+def handle_type_conversion(field_type, field_name, value):
+    if field_type == "STRING" and not isinstance(value, str):
+        return str(value), ContextLog(level=LogLevel.WARNING_REVIEW_RECOMMENDED,
+                             subject=field_name,
+                             description= f"Expected STRING but got {value} of type {type(value).__name__}.")
+
+    if field_type == "INT64" and not isinstance(value, int):
+        try:
+            return int(value), None
+        except ValueError:
+            return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                                subject= field_name,
+                                                description=f"Expected INTEGER, but got {value} of type {type(value).__name__}.")
+    if field_type == "FLOAT64" and not isinstance(value, float):
+        try:
+            return float(value), None
+        except ValueError:
+            return None, ContextLog(level=LogLevel.WARNING_FIX_REQUIRED,
+                                                subject=field_name,
+                                                description=f"Expected FLOAT, but got  {value} of type {type(value).__name__}.")
+    if field_type == "BOOL" and not isinstance(value, bool):
+        return bool(value), ContextLog(level=LogLevel.WARNING_REVIEW_RECOMMENDED,
+                                                subject=field_name,
+                                                description=f"Expected BOOL, but got  {value}. Converting as {bool(value)}.")
+
+    return value, None

ipulse_shared_core_ftredge-2.6.1.dist-info/METADATA

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: ipulse_shared_core_ftredge
+Version: 2.6.1
+Summary: Shared Core models and Logger util for the Pulse platform project. Using AI for financial advisory and investment management.
+Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
+Author: Russlan Ramdowar
+License-File: LICENCE
+Requires-Dist: pydantic[email]~=2.5
+Requires-Dist: python-dateutil~=2.8
+Requires-Dist: pytest~=7.1
+Requires-Dist: google-cloud-logging~=3.10.0
+Requires-Dist: google-cloud-error-reporting~=1.11.0
+Requires-Dist: google-cloud-bigquery~=3.24.0
+

ipulse_shared_core_ftredge-2.6.1.dist-info/RECORD

@@ -0,0 +1,33 @@
+ipulse_shared_core_ftredge/__init__.py,sha256=7yQzgsmIy7SlAwxTxUBIor_OuFfvoCMBBuonDXjMCC4,1188
+ipulse_shared_core_ftredge/enums/__init__.py,sha256=KWDgmon4URp9PpRw4HCwiviggWXzTo-icTuaOWKjrcI,1034
+ipulse_shared_core_ftredge/enums/enums_cloud.py,sha256=svlVyTwOr4C9XuMBSu3_B7nBEyJUT1rnEJaLvt53NjU,375
+ipulse_shared_core_ftredge/enums/enums_common_utils.py,sha256=AtLcAq5_NmVzCmX4WEYw6T0-O3UQQjdyu7XZUizC8Y8,3476
+ipulse_shared_core_ftredge/enums/enums_data_eng.py,sha256=U6SBw3CjoNt29bMOH-aw0yxmWldcwwouT1Hp9x1gSGI,4080
+ipulse_shared_core_ftredge/enums/enums_logs.py,sha256=WR6i9T7EmBAEN_Q4nXe435IHPxoAoPnbVm4joqLTwBs,3881
+ipulse_shared_core_ftredge/enums/enums_module_fincore.py,sha256=W1TkSLu3ryLf_aif2VcKsFznWz0igeMUR_buoGEG6w8,1406
+ipulse_shared_core_ftredge/enums/enums_modules.py,sha256=I-EfnpB7WMPXEQMK18vCO711uq84pt8b3ycSVB7oLcU,548
+ipulse_shared_core_ftredge/enums/pulse_enums.py,sha256=0RjIJbK0pt1Mzo4k_lhhxZL8myEUergQwOY9JOLZIJ4,4716
+ipulse_shared_core_ftredge/models/__init__.py,sha256=MeGH2ZBxkrwldUiWyUaI_TMyfq78tuSwRkN_mEfKD8U,161
+ipulse_shared_core_ftredge/models/organisation.py,sha256=22esRGYuJmKN3papkgozleEmDNJrVwUgIzKp7annvWs,3280
+ipulse_shared_core_ftredge/models/resource_catalog_item.py,sha256=mEGX8AftzrhEHqFVXjr62CuRnXC1vK4z3bHl_XBJodU,4964
+ipulse_shared_core_ftredge/models/user_auth.py,sha256=35HNN7ZW4ZELCqaJrAtoSsVLFAZ1KL2S_VmuzbcEMm4,119
+ipulse_shared_core_ftredge/models/user_profile.py,sha256=D3BB9D6XEv7IVZgsURgf0hWmUZW5rms3uiBXS0ZGLeE,1927
+ipulse_shared_core_ftredge/models/user_profile_update.py,sha256=oKK0XsQDKkgDvjFPhX2XlqEqlKLBQ4AkvPHXEuZbFMY,1712
+ipulse_shared_core_ftredge/models/user_status.py,sha256=8TyRd8tBK9_xb0MPKbI5pn9-lX7ovKbeiuWYYPtIOiw,3202
+ipulse_shared_core_ftredge/utils/__init__.py,sha256=hGi4WtdFSUxI_LQBsRUADS2-FmNifM9BSMTH9KhEmpg,851
+ipulse_shared_core_ftredge/utils/utils_cloud.py,sha256=eWMwr1ZBbUy3TdUSnO2-MGiUeq5RIoG1p_jZJ3f6LOw,2386
+ipulse_shared_core_ftredge/utils/utils_cloud_gcp.py,sha256=8HvizgqXaRjLCvIfsxtfC6SnO7KY7ONScB0_1FqumbE,14162
+ipulse_shared_core_ftredge/utils/utils_cloud_gcp_with_collectors.py,sha256=hiesZhK-UMHMAy9QZZXAHKItLY30EqS-RDeUdEz-uaY,11251
+ipulse_shared_core_ftredge/utils/utils_cloud_with_collectors.py,sha256=5siDvpgHJxfdykS1bjPS5sqtn5SYYPLV4ZYSoniSd0E,1678
+ipulse_shared_core_ftredge/utils/utils_collector_pipelinemon.py,sha256=QTZA0UIXAbYEuwUuYrP4QfELAFEg36ef1iJbAad1nxM,15017
+ipulse_shared_core_ftredge/utils/utils_common.py,sha256=n9TgX1RNVWlXA5AJjtkvVQqL_B2tr0NOZgPLKivyUZ4,6044
+ipulse_shared_core_ftredge/utils/utils_templates_and_schemas.py,sha256=6mtuaGui5y8ECA87eCiaptUi6o-7m_vqaqni7mIxIQU,7512
+ipulse_shared_core_ftredge/utils/logs/__init__.py,sha256=fY6UNr197HYwUDi7uj5fsXw1Ma5gyAFzALxnoDSHFG0,71
+ipulse_shared_core_ftredge/utils/logs/audit_log_firestore.py,sha256=5AwO6NHuOncq65n400eqM8QPrS2EGGaP3Z_6l2rxdBE,261
+ipulse_shared_core_ftredge/utils/logs/context_log.py,sha256=nsUfVmC_DP5QjQuSlBRalqpaaktxedwmx834h4_ZhYA,8673
+ipulse_shared_core_ftredge/utils/logs/get_logger.py,sha256=RPSdqT1O8MbfwAqdIdH8P9fOn39AmDLW8N7sCU2EAbM,3255
+ipulse_shared_core_ftredge-2.6.1.dist-info/LICENCE,sha256=YBtYAXNqCCOo9Mr2hfkbSPAM9CeAr2j1VZBSwQTrNwE,1060
+ipulse_shared_core_ftredge-2.6.1.dist-info/METADATA,sha256=C6xUGmUY19PDLy0o8nz8pfQ5DCGTQ-1fxrqjYvt3aNU,556
+ipulse_shared_core_ftredge-2.6.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+ipulse_shared_core_ftredge-2.6.1.dist-info/top_level.txt,sha256=8sgYrptpexkA_6_HyGvho26cVFH9kmtGvaK8tHbsGHk,27
+ipulse_shared_core_ftredge-2.6.1.dist-info/RECORD,,

{ipulse_shared_core_ftredge-2.6.dist-info → ipulse_shared_core_ftredge-2.6.1.dist-info}/WHEEL

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

ipulse_shared_core_ftredge/tests/test.py

@@ -1,17 +0,0 @@
-from ipulse_shared_core_ftredge import UserProfile,  UserAuth
-import datetime
-import logging
-logging.basicConfig(level=logging.INFO)
-ex=UserProfile(uid="uid",
-                organizations_uids={"20231220retailcustomer_coreorgn"},
-                email="email@gmail.com",
-                creat_date= datetime.datetime.now(datetime.UTC),
-                creat_by_user='creat_by_user',
-                updt_date=datetime.datetime.now(datetime.UTC),
-                updt_by_user="subscriber_cf_persistUserAuthToUserProfile",
-                approved=True,
-                provider_id='provider_id',
-                username='username')
-
-
-logging.info(ex.model_dump(exclude_unset=True))

ipulse_shared_core_ftredge-2.6.dist-info/METADATA

@@ -1,11 +0,0 @@
-Metadata-Version: 2.1
-Name: ipulse_shared_core_ftredge
-Version: 2.6
-Summary: Shared models for the Pulse platform project. Using AI for financial advisory and investment management.
-Home-page: https://github.com/TheFutureEdge/ipulse_shared_core
-Author: Russlan Ramdowar
-License-File: LICENCE
-Requires-Dist: pydantic[email] ~=2.5
-Requires-Dist: python-dateutil ~=2.8
-Requires-Dist: pytest ~=7.1
-

ipulse_shared_core_ftredge-2.6.dist-info/RECORD

@@ -1,17 +0,0 @@
-ipulse_shared_core_ftredge/__init__.py,sha256=gZ2QIubXOdzhGe4Jd3Vwx8NrULkn4Is6uVZ2ThEvrpE,104
-ipulse_shared_core_ftredge/models/__init__.py,sha256=gE22Gzhil0RYQa7YLtdtT44_AsWqklcDfRtgLAQc1dI,200
-ipulse_shared_core_ftredge/models/audit_log_firestore.py,sha256=jjl9lq-3J0eKXZAdEco8vNVQBLLZq-EH6V7NSubsBWw,270
-ipulse_shared_core_ftredge/models/organisation.py,sha256=4f1ATEWh5WT-CDJBLEZUhUwyl3V06ogRkteZAqW_nko,2953
-ipulse_shared_core_ftredge/models/pulse_enums.py,sha256=PDt1Xhjr885AW_GRfg7Y-zkdVrulNS0O6gWK1xjYOMI,5490
-ipulse_shared_core_ftredge/models/resource_catalog_item.py,sha256=PxeRvI8fe8KOiHr6NW2Jz_yocyLId09PW8QyTZxjHAA,9809
-ipulse_shared_core_ftredge/models/user_auth.py,sha256=35HNN7ZW4ZELCqaJrAtoSsVLFAZ1KL2S_VmuzbcEMm4,119
-ipulse_shared_core_ftredge/models/user_profile.py,sha256=zP4J-bE3oXzgXzxcHlK5Bz-RpgUppIYmP-U8e2lfHe4,1993
-ipulse_shared_core_ftredge/models/user_profile_update.py,sha256=e2jO24JRcnUYJvQWOARbtCW-23WPcGbsWDYw0Iow6mQ,572
-ipulse_shared_core_ftredge/models/user_status.py,sha256=S4ZAilJQ4P931gf6u20UAKOxcGTkkMOTiSVnLzvNd8k,2728
-ipulse_shared_core_ftredge/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ipulse_shared_core_ftredge/tests/test.py,sha256=0lS8HP5Quo_BqNoscU40qOH9aJRaa1Pfam5VUBmdld8,682
-ipulse_shared_core_ftredge-2.6.dist-info/LICENCE,sha256=YBtYAXNqCCOo9Mr2hfkbSPAM9CeAr2j1VZBSwQTrNwE,1060
-ipulse_shared_core_ftredge-2.6.dist-info/METADATA,sha256=hLQSigj32Ug-4LUyB2JtBxZHJf7DqgNWhZeU-Gv5ey0,395
-ipulse_shared_core_ftredge-2.6.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-ipulse_shared_core_ftredge-2.6.dist-info/top_level.txt,sha256=8sgYrptpexkA_6_HyGvho26cVFH9kmtGvaK8tHbsGHk,27
-ipulse_shared_core_ftredge-2.6.dist-info/RECORD,,