sapiopycommons 2024.11.25a373__tar.gz → 2024.12.4a375__tar.gz

{sapiopycommons-2024.11.25a373 → sapiopycommons-2024.12.4a375}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2024.11.25a373
+Version: 2024.12.4a375
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2024.11.25a373 → sapiopycommons-2024.12.4a375}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sapiopycommons"
-version='2024.11.25a373'
+version='2024.12.04a375'
 authors = [
     { name="Jonathan Steck", email="jsteck@sapiosciences.com" },
     { name="Yechen Qiao", email="yqiao@sapiosciences.com" },

{sapiopycommons-2024.11.25a373 → sapiopycommons-2024.12.4a375}/src/sapiopycommons/eln/experiment_handler.py

@@ -824,7 +824,7 @@ class ExperimentHandler:
             The record to remove from the given step.
             The record may be provided as either a DataRecord, PyRecordModel, or WrappedRecordModel.
         """
-        self.remove_eln_row(step, [record])
+        self.remove_eln_rows(step, [record])
 
     def add_sample_details(self, step: Step, samples: list[RecordModel], wrapper_type: type[WrappedType]) \
             -> list[PyRecordModel | WrappedType]:

{sapiopycommons-2024.11.25a373 → sapiopycommons-2024.12.4a375}/src/sapiopycommons/general/time_util.py

@@ -2,9 +2,12 @@ from __future__ import annotations
 
 import time
 from datetime import datetime
+from typing import Any
 
 import pytz
 
+from sapiopycommons.general.exceptions import SapioException
+
 __timezone = None
 """The default timezone. Use TimeUtil.set_default_timezone in a global context before making use of TimeUtil."""
 
@@ -26,7 +29,7 @@ class TimeUtil:
     with static date fields, use "UTC" as your input timezone.
     """
     @staticmethod
-    def get_default_timezone():
+    def get_default_timezone() -> Any:
         """
         Returns the timezone that TimeUtil is currently using as its default.
         """
@@ -45,7 +48,7 @@ class TimeUtil:
         __timezone = TimeUtil.__to_tz(new_timezone)
 
     @staticmethod
-    def __to_tz(timezone: str | int = None):
+    def __to_tz(timezone: str | int = None) -> Any:
         """
         :param timezone: Either the name of a timezone, a UTC offset in seconds, or None if the default should be used.
         :return: The timezone object to use for the given input. If the input is None, uses the default timezone.
@@ -55,11 +58,28 @@ class TimeUtil:
             # because pytz may return timezones from strings in Local Mean Time instead of a timezone with a UTC offset.
             # LMT may be a few minutes off of the actual time in that timezone right now.
             # https://stackoverflow.com/questions/35462876
-            offset: int = int(datetime.now(pytz.timezone(timezone)).utcoffset().total_seconds() / 60)
-            return pytz.FixedOffset(offset)
+            offset: int = TimeUtil.__get_timezone_offset(timezone)
+            # This function takes an offset in minutes, so divide the provided offset seconds by 60.
+            return pytz.FixedOffset(offset // 60)
         if isinstance(timezone, int):
             return pytz.FixedOffset(timezone // 60)
-        return TimeUtil.get_default_timezone()
+        if timezone is None:
+            return TimeUtil.get_default_timezone()
+        raise SapioException(f"Unhandled timezone object of type {type(timezone)}: {timezone}")
+
+    @staticmethod
+    def __get_timezone_offset(timezone: str | int | None) -> int:
+        """
+        :param timezone: Either the name of a timezone, a UTC offset in seconds, or None if the default should be used.
+        :return: The UTC offset in seconds of the provided timezone.
+        """
+        if isinstance(timezone, int):
+            return timezone
+        if isinstance(timezone, str):
+            timezone = pytz.timezone(timezone)
+        if timezone is None:
+            timezone = TimeUtil.get_default_timezone()
+        return int(datetime.now(timezone).utcoffset().total_seconds())
 
     @staticmethod
     def current_time(timezone: str | int = None) -> datetime:
@@ -127,6 +147,64 @@ class TimeUtil:
         tz = TimeUtil.__to_tz(timezone)
         return int(datetime.strptime(time_point, time_format).replace(tzinfo=tz).timestamp() * 1000)
 
+    # FR-47296: Provide functions for shifting between timezones.
+    @staticmethod
+    def shift_now(to_timezone: str = "UTC", from_timezone: str | None = None) -> int:
+        """
+        Take the current time in from_timezone and output the epoch timestamp that would display that same time in
+        to_timezone. A use case for this is when dealing with static date fields to convert a provided timestamp to the
+        value necessary to display that timestamp in the same way when viewed in the static date field.
+
+        :param to_timezone: The timezone to shift to. If not provided, uses UTC.
+        :param from_timezone: The timezone to shift from. If no timezone is provided, uses the global
+            timezone variable set by the TimeUtil. A list of valid timezones can be found at
+            https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. May also accept a UTC offset in seconds.
+        :return: The epoch timestamp that would display as the same time in to_timezone as the current time in
+            from_timezone.
+        """
+        millis: int = TimeUtil.now_in_millis()
+        return TimeUtil.shift_millis(millis, to_timezone, from_timezone)
+
+    @staticmethod
+    def shift_millis(millis: int, to_timezone: str = "UTC", from_timezone: str | None = None) -> int:
+        """
+        Take a number of milliseconds for a time in from_timezone and output the epoch timestamp that would display that
+        same time in to_timezone. A use case for this is when dealing with static date fields to convert a provided
+        timestamp to the value necessary to display that timestamp in the same way when viewed in the static date field.
+
+        :param millis: The time in milliseconds to convert from.
+        :param to_timezone: The timezone to shift to. If not provided, uses UTC.
+        :param from_timezone: The timezone to shift from. If no timezone is provided, uses the global
+            timezone variable set by the TimeUtil. A list of valid timezones can be found at
+            https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. May also accept a UTC offset in seconds.
+        :return: The epoch timestamp that would display as the same time in to_timezone as the given time in
+            from_timezone.
+        """
+        to_offset: int = TimeUtil.__get_timezone_offset(to_timezone) * 1000
+        from_offset: int = TimeUtil.__get_timezone_offset(from_timezone) * 1000
+        return millis + from_offset - to_offset
+
+    @staticmethod
+    def shift_format(time_point: str, time_format: str, to_timezone: str = "UTC", from_timezone: str | None = None) \
+            -> int:
+        """
+        Take a timestamp for a time in from_timezone and output the epoch timestamp that would display that same time
+        in to_timezone. A use case for this is when dealing with static date fields to convert a provided timestamp to
+        the value necessary to display that timestamp in the same way when viewed in the static date field.
+
+        :param time_point: The time in some date/time format to convert from.
+        :param time_format: The format that the time_point is in. Documentation for how the time formatting works
+            can be found at https://docs.python.org/3.10/library/datetime.html#strftime-and-strptime-behavior
+        :param to_timezone: The timezone to shift to. If not provided, uses UTC.
+        :param from_timezone: The timezone to shift from. If no timezone is provided, uses the global
+            timezone variable set by the TimeUtil. A list of valid timezones can be found at
+            https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. May also accept a UTC offset in seconds.
+        :return: The epoch timestamp that would display as the same time in to_timezone as the given time in
+            from_timezone.
+        """
+        millis: int = TimeUtil.format_to_millis(time_point, time_format, from_timezone)
+        return TimeUtil.shift_millis(millis, to_timezone, from_timezone)
+
     # FR-46154: Create a function that determines if a string matches a time format.
     @staticmethod
     def str_matches_format(time_point: str, time_format: str) -> bool: