sweatstack 0.37.0__py3-none-any.whl → 0.38.0__py3-none-any.whl

sweatstack/schemas.py

@@ -1,5 +1,104 @@
 from enum import Enum
+from typing import List, Union
 
 from .openapi_schemas import (
-    ActivityDetails, ActivitySummary, Metric, Scope, Sport, TraceDetails, UserInfoResponse, UserSummary
-)
+    ActivityDetails, ActivitySummary, Metric, Scope, Sport,
+    TraceDetails, UserInfoResponse, UserSummary
+)
+
+
+def parent_sport(sport: Sport) -> Sport:
+    """Returns the parent sport of a given sport.
+
+    For sports with a hierarchical structure (e.g., 'cycling.road'), returns the parent sport
+    ('cycling'). If the sport has no parent (is already a root sport), returns the sport itself.
+
+    Args:
+        sport (Sport): The sport enum value to find the parent of.
+
+    Returns:
+        Sport: The parent sport enum value, or the original sport if it has no parent.
+    """
+    parts = sport.value.split(".")
+    if len(parts) == 1:
+        return sport
+    return sport.__class__(".".join(parts[:-1]))
+
+
+def root_sport(sport: Sport) -> Sport:
+    """Returns the root sport of a given sport.
+
+    For sports with a hierarchical structure (e.g., 'cycling.road' or 'cycling.road.gravel'),
+    returns the root sport ('cycling'). If the sport is already a root sport, returns the sport itself.
+
+    Args:
+        sport (Sport): The sport enum value to find the root of.
+
+    Returns:
+        Sport: The root sport enum value.
+    """
+    return sport.__class__(sport.value.split(".")[0])
+
+
+def is_root_sport(sport: Sport) -> bool:
+    """Determines if a sport is a root sport.
+
+    A root sport is one that doesn't have a parent sport in the hierarchy
+    (e.g., 'cycling' is a root sport, while 'cycling.road' is not).
+
+    Args:
+        sport (Sport): The sport enum value to check.
+
+    Returns:
+        bool: True if the sport is a root sport, False otherwise.
+    """
+    return sport == root_sport(sport)
+
+
+def is_sub_sport_of(sport: Sport, sport_or_sports: Union[Sport, List[Sport]]) -> bool:
+    """Determines if a sport is a sub-sport of another sport or list of sports.
+
+    For example, 'cycling.road' is a sub-sport of 'cycling', but not of 'running'.
+
+    Args:
+        sport (Sport): The sport to check.
+        sport_or_sports (Union[Sport, List[Sport]]): A sport or list of sports to check against.
+
+    Returns:
+        bool: True if the sport is a sub-sport of any of the provided sports, False otherwise.
+
+    Raises:
+        ValueError: If sport_or_sports is not a Sport or a list of Sports.
+    """
+    if isinstance(sport_or_sports, Sport):
+        return sport.value.startswith(sport_or_sports.value)
+    elif isinstance(sport_or_sports, (list, tuple)):
+        return any(is_sub_sport_of(sport, sport) for sport in sport_or_sports)
+    else:
+        raise ValueError(f"Invalid type for sport_or_sports: {type(sport_or_sports)}")
+
+
+def display_name(sport: Sport) -> str:
+    """Returns a human-readable display name for a sport.
+
+    This function converts a Sport enum value into a formatted string suitable for display.
+
+    Args:
+        sport (Sport): The sport enum value to format.
+
+    Returns:
+        str: A human-readable display name for the sport.
+    """
+    parts = sport.value.split(".")
+    base_sport = parts[0]
+    base_sport = base_sport.replace("_", " ")
+    if len(parts) == 1:
+        return base_sport
+    the_rest = " ".join(parts[1:]).replace("_", " ")
+    return f"{base_sport} ({the_rest})"
+
+
+Sport.root_sport = root_sport
+Sport.parent_sport = parent_sport
+Sport.is_sub_sport_of = is_sub_sport_of
+Sport.display_name = display_name

sweatstack/utils.py

@@ -52,29 +52,4 @@ def make_dataframe_streamlit_compatible(df: pd.DataFrame) -> pd.DataFrame:
                         lambda x: x.value if isinstance(x, Enum) else x
                     )
 
-    return df_copy if df_copy is not None else df
-
-
-def format_sport(sport: Sport):
-    """Formats a sport enum value into a human-readable string.
-
-    This function takes a Sport enum and converts it to a formatted string representation.
-    For example, "cycling.road" becomes "cycling (road)" and "running" remains "running".
-    Underscores in sport names are replaced with spaces.
-
-    Args:
-        sport: A Sport enum value to format.
-
-    Returns:
-        str: A human-readable formatted string representation of the sport.
-    """
-    parts = sport.value.split(".")
-    base_sport = parts[0]
-    base_sport = base_sport.replace("_", " ")
-
-    if len(parts) == 1:
-        return base_sport
-
-    remainder = " ".join(parts[1:]).replace("_", " ")
-
-    return f"{base_sport} ({remainder})"
+    return df_copy if df_copy is not None else df

{sweatstack-0.37.0.dist-info → sweatstack-0.38.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sweatstack
-Version: 0.37.0
+Version: 0.38.0
 Summary: The official Python client for SweatStack
 Author-email: Aart Goossens <aart@gssns.io>
 Requires-Python: >=3.9

{sweatstack-0.37.0.dist-info → sweatstack-0.38.0.dist-info}/RECORD

@@ -6,12 +6,12 @@ sweatstack/ipython_init.py,sha256=zBGUlMFkdpLvsNpOpwrNaKRUpUZhzaICvH8ODJgMPcI,22
 sweatstack/jupyterlab_oauth2_startup.py,sha256=eZ6xi0Sa4hO4vUanimq0SqjduHtiywCURSDNWk_I-7s,1200
 sweatstack/openapi_schemas.py,sha256=rB_gdkob49AISTebZXmNjOOz3it28Y42_PEKcBF24c0,13576
 sweatstack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sweatstack/schemas.py,sha256=zRxssFvsXmCTtLr69a7n_EHUUbfAG27w6cTr730ZeUY,159
+sweatstack/schemas.py,sha256=d6KRMJalaABO61CPm3afs-hM6zUcwbGrZ5mc6SVuc54,3370
 sweatstack/streamlit.py,sha256=dtli4RpBiS8cH4GAQ9lDI_ZRDMLoU7GnTc676nLV_4A,13008
 sweatstack/sweatshell.py,sha256=MYLNcWbOdceqKJ3S0Pe8dwHXEeYsGJNjQoYUXpMTftA,333
-sweatstack/utils.py,sha256=WMY0THAfktzeDNH3kuwYNtVaoS1OQMaobONtGhpLI2E,2547
+sweatstack/utils.py,sha256=AwHRdC1ziOZ5o9RBIB21Uxm-DoClVRAJSVvgsmSmvps,1801
 sweatstack/Sweat Stack examples/Getting started.ipynb,sha256=k2hiSffWecoQ0VxjdpDcgFzBXDQiYEebhnAYlu8cgX8,6335204
-sweatstack-0.37.0.dist-info/METADATA,sha256=MQf29vXxKG9b22yMQvH9apE5uWwljU1RY0NQRVSuUng,779
-sweatstack-0.37.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sweatstack-0.37.0.dist-info/entry_points.txt,sha256=kCzOUQI3dqbTpEYqtgYDeiKFaqaA7BMlV6D24BMzCFU,208
-sweatstack-0.37.0.dist-info/RECORD,,
+sweatstack-0.38.0.dist-info/METADATA,sha256=z3dU5Jjlozd1kyYvIb7ELhNYN-a1hKcsl-efEEQyCbU,779
+sweatstack-0.38.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sweatstack-0.38.0.dist-info/entry_points.txt,sha256=kCzOUQI3dqbTpEYqtgYDeiKFaqaA7BMlV6D24BMzCFU,208
+sweatstack-0.38.0.dist-info/RECORD,,