strideutils 0.3.15__tar.gz → 0.4.0__tar.gz

{strideutils-0.3.15 → strideutils-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strideutils
-Version: 0.3.15
+Version: 0.4.0
 Summary: 
 Author: Your Name
 Author-email: you@example.com

{strideutils-0.3.15 → strideutils-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "strideutils"
-version = "0.3.15"
+version = "0.4.0"
 description = ""
 authors = ["Your Name <you@example.com>"]
 readme = "README.md"

{strideutils-0.3.15 → strideutils-0.4.0}/strideutils/run_safely.py

@@ -6,7 +6,11 @@ from strideutils.stride_config import config
 
 
 def try_and_log_with_status(
-    *functions: Callable, slack_channel: str = 'alerts-status', job_name: str = "alerts", botname: Optional[str] = None
+    *functions: Callable,
+    slack_channel: str = 'alerts-status',
+    job_name: str = "alerts",
+    botname: Optional[str] = None,
+    print_status: bool = False,
 ):
     """
     Wrap functions in a try/catch and log exceptions.
@@ -21,6 +25,7 @@ def try_and_log_with_status(
     """
     if config.ENV == 'DEV':
         slack_channel = 'alerts-debug'
+        print_status = True
 
     tracebacks = []
     msgs = []
@@ -29,16 +34,30 @@ def try_and_log_with_status(
         # (to cover cases where click was used)
         func_name = getattr(func, 'name', None) or func.__name__
         try:
-            print(f"Running {func_name}...", end="")
-            func()
-            print("✅")
-            msgs += [f':white_check_mark: {func_name}']
+            if print_status:
+                print(f"Running {func_name}...", end="")
+
+            # If the function was wrapped in a run_daily/run_epochly decorator,
+            # the function will return a bool indicating if the function was executed
+            # If it was skipped, use a different emoji
+            output = func()
+            func_skipped = len(output) == 2 and not output[0]
+
+            emoji_print = "⚪" if func_skipped else "✅"
+            emoji_slack = ":white_circle:" if func_skipped else ":white_check_mark:"
+            msgs += [f'{emoji_slack} {func_name}']
+
+            if print_status:
+                print(emoji_print)
+
         except Exception:
-            print("❌")
             print(traceback.format_exc())
             msgs += [f':x: {func_name} ']
             tracebacks.append(f"{func_name} \n\n" + traceback.format_exc())
 
+            if print_status:
+                print("❌")
+
     count_succeeded_msg = f"{len(functions) - len(tracebacks)}/{len(functions)} {job_name} succeeded"
     if len(tracebacks) > 0:
         status_msg = f':x: {count_succeeded_msg}'

{strideutils-0.3.15 → strideutils-0.4.0}/strideutils/stride_alerts.py

@@ -2,7 +2,7 @@ import datetime
 import os
 from enum import Enum
 from functools import wraps
-from typing import Callable, Iterable, List, Optional, Union, cast
+from typing import Any, Callable, Iterable, List, Optional, Tuple, Union, cast
 
 import pandas as pd
 import tabulate
@@ -10,6 +10,8 @@ import tabulate
 from strideutils import slack_connector, twilio_connector
 from strideutils.stride_config import config
 
+DEFAULT_DAILY_UTC_HOUR = 17
+
 
 class AlertType(Enum):
     DEBUG = 'debug'
@@ -38,7 +40,7 @@ def wrap_in_code_block(message: str) -> str:
 
 
 def notify(
-    msgs: Union[str, List[str]],
+    messages: Union[str, List[str]],
     urgency,
     tag: Optional[Union[str, Iterable[str]]] = None,
     call: Optional[Union[str, Iterable[str]]] = None,
@@ -57,8 +59,8 @@ def notify(
     """
     urgency = AlertType(urgency)
 
-    msgs: List = cast(List, [msgs] if type(msgs) is str else msgs)
-    top_level_message = str(msgs[0])
+    messages_list: List = cast(List, [messages] if type(messages) is str else messages)
+    top_level_message = str(messages_list[0])
 
     debug_msg = f"Read more: {debug_readme}{debug_readme_section}"
 
@@ -73,12 +75,12 @@ def notify(
         channel = "#alerts-critical"
 
     if beta_alert:
-        msgs[0] += "\nβ _This alert is in beta and might be unstable_"
+        messages_list[0] += "\nβ _This alert is in beta and might be unstable_"
 
     if tag:
-        msgs[0] += f"\n{get_tags(tag)}"
+        messages_list[0] += f"\n{get_tags(tag)}"
 
-    slack_connector.post_msg(msgs + [debug_msg], channel)
+    slack_connector.post_msg(messages_list + [debug_msg], channel)
 
     if call:
         twilio_connector.send_calls(top_level_message, call)
@@ -110,7 +112,8 @@ def raise_alert(
     def _decorator(f: Callable):
         @wraps(f)
         def _func(*args, **kwargs):
-            msgs = f(*args, **kwargs)
+            output = f(*args, **kwargs)
+            msgs = output[-1] if type(output) is Tuple else output
             if urgency == 'debug':
                 debug_msg = (
                     'In debug mode. Tags and calls have been disabled' 'and the message is routed to alerts-debug.'
@@ -119,7 +122,7 @@ def raise_alert(
                 msgs += [debug_msg]
             if msgs:
                 notify(
-                    msgs=msgs,
+                    messages=msgs,
                     urgency=urgency,
                     tag=tag,
                     call=call,
@@ -150,18 +153,19 @@ def run_daily(utc_hour_or_alert: Union[int, Callable]) -> Callable:
     def bar():
         ...
     ```
-    """
-    DEFAULT_UTC_HOUR = 17
 
+    The returned function also returns a bool to indicate if the function was invoked
+    """
     # If used without an argument, act as an unparameterized decorator
     if callable(utc_hour_or_alert):
         alert = utc_hour_or_alert
 
         @wraps(alert)
-        def _func(*args, **kwargs):
-            dt = datetime.datetime.utcnow()
-            if dt.hour == DEFAULT_UTC_HOUR:
-                return alert(*args, **kwargs)
+        def _func(*args, **kwargs) -> Tuple[bool, Any]:
+            dt = datetime.datetime.now(tz=datetime.timezone.utc)
+            if config.ENV == "DEV" or dt.hour == DEFAULT_DAILY_UTC_HOUR:
+                return True, alert(*args, **kwargs)
+            return False, None
 
         return _func
 
@@ -173,24 +177,45 @@ def run_daily(utc_hour_or_alert: Union[int, Callable]) -> Callable:
     def _decorator(f: Callable):
         @wraps(f)
         def _func(*args, **kwargs):
-            dt = datetime.datetime.utcnow()
-            if dt.hour == utc_hour:
-                return f(*args, **kwargs)
+            dt = datetime.datetime.now(tz=datetime.timezone.utc)
+            if config.ENV == "DEV" or dt.hour == utc_hour:
+                return True, f(*args, **kwargs)
+            return False, None
 
         return _func
 
     return _decorator
 
 
-def run_epochly(f: Callable) -> Callable:
+def run_stride_epochly(f: Callable) -> Callable:
     """
     Modifies an function to run once per stride epoch
+    Returns the new function returns a bool indicating if the function was executed
+    When running in DEV mode, the function always executes
+    """
+
+    @wraps(f)
+    def _func(*args, **kwargs) -> Tuple[bool, Any]:
+        dt = datetime.datetime.now(tz=datetime.timezone.utc)
+        if config.ENV == "DEV" or dt.hour in {1, 7, 13, 19}:
+            return True, f(*args, **kwargs)
+        return False, None
+
+    return _func
+
+
+def run_day_epochly(f: Callable) -> Callable:
+    """
+    Modifies an function to run once per day epoch
+    Returns the new function returns a bool indicating if the function was executed
+    When running in DEV mode, the function always executes
     """
 
     @wraps(f)
-    def _func(*args, **kwargs):
-        dt = datetime.datetime.utcnow()
-        if dt.hour in {1, 7, 13, 19}:
-            return f(*args, **kwargs)
+    def _func(*args, **kwargs) -> Tuple[bool, Any]:
+        dt = datetime.datetime.now(tz=datetime.timezone.utc)
+        if config.ENV == "DEV" or dt.hour == 19:
+            return True, f(*args, **kwargs)
+        return False, None
 
     return _func

{strideutils-0.3.15 → strideutils-0.4.0}/strideutils/stride_config.py

@@ -345,25 +345,36 @@ def _load_raw_secrets() -> dict[str, Optional[str]]:
 def _parse_raw_configs(raw_config: dict[str, Any], raw_secrets: dict[str, Optional[str]]) -> Config:
     """
     Builds the relevant config data classes from the raw jsons
+
+    When parsing into the dataclasses, only consider fields that are defined in the dataclass
+    so that the package maintains backwards compatibility when new fields are added
     """
-    host_chain_fields = [field.name for field in fields(HostChainsConfig)]
-    app_chain_fields = [field.name for field in fields(AppChainsConfig)]
+    host_chain_names = [field.name for field in fields(HostChainsConfig)]
+    app_chain_names = [field.name for field in fields(AppChainsConfig)]
 
-    host_chain_config_dict = {
-        name: HostChainConfig(**info) for name, info in raw_config["host_zones"].items() if name in host_chain_fields
-    }
-    app_chain_config_dict = {
-        name: ChainConfig(**info) for name, info in raw_config["app_chains"].items() if name in app_chain_fields
-    }
+    host_chain_fields = [field.name for field in fields(HostChainConfig)]
+    app_chain_fields = [field.name for field in fields(ChainConfig)]
+
+    host_chain_config_dict = {}
+    for name, info in raw_config["host_zones"].items():
+        if name in host_chain_names:
+            filtered_info = {key: value for key, value in info.items() if key in host_chain_fields}
+            host_chain_config_dict[name] = HostChainConfig(**filtered_info)
+
+    app_chain_config_dict = {}
+    for name, info in raw_config["app_chains"].items():
+        if name in app_chain_names:
+            filtered_info = {key: value for key, value in info.items() if key in app_chain_fields}
+            app_chain_config_dict[name] = ChainConfig(**filtered_info)
 
     stride_chain_config = StrideChainConfig(**raw_config["stride"])
     host_zone_config = HostChainsConfig(**host_chain_config_dict)
     app_chain_config = AppChainsConfig(**app_chain_config_dict)
 
     chain_configs = {
-        'stride': stride_chain_config,
-        'host_zones': host_zone_config,
-        'app_chains': app_chain_config,
+        "stride": stride_chain_config,
+        "host_zones": host_zone_config,
+        "app_chains": app_chain_config,
     }
 
     # Load non-nested configs, then overwrite with the chain configs