dcicutils 8.8.3.1b14__py3-none-any.whl → 8.8.3.1b16__py3-none-any.whl

dcicutils/captured_output.py

@@ -24,6 +24,8 @@ def captured_output(capture: bool = True, encoding: Optional[str] = None):
 
     original_stdout = _real_stdout
     original_stderr = _real_stderr
+    # FYI: This encoding business with _EncodedStringIO was introduced (circa April 2024)
+    # when ran into issues unit testing progress_bar which outputs those funny block characters.
     captured_output = io.StringIO() if not encoding else _EncodedStringIO(encoding)
 
     def set_original_output() -> None:

dcicutils/datetime_utils.py

@@ -3,6 +3,22 @@ from datetime import datetime, timedelta, timezone
 from dateutil import parser as datetime_parser
 from typing import Optional, Tuple, Union
 
+TIMEZONE_LOCAL = datetime.now().astimezone().tzinfo  # type: datetime.timezone
+TIMEZONE_LOCAL_NAME = TIMEZONE_LOCAL.tzname(None)  # type: str
+TIMEZONE_LOCAL_OFFSET = TIMEZONE_LOCAL.utcoffset(None)  # type: datetime.timedelta
+TIMEZONE_LOCAL_OFFSET_TOTAL_MINUTES = int(TIMEZONE_LOCAL_OFFSET.total_seconds()) // 60  # type: int
+TIMEZONE_LOCAL_OFFSET_HOURS = TIMEZONE_LOCAL_OFFSET_TOTAL_MINUTES // 60  # type: int
+TIMEZONE_LOCAL_OFFSET_MINUTES = TIMEZONE_LOCAL_OFFSET_TOTAL_MINUTES % 60  # type: int
+TIMEZONE_LOCAL_SUFFIX = f"{TIMEZONE_LOCAL_OFFSET_HOURS:+03d}:{TIMEZONE_LOCAL_OFFSET_MINUTES:02d}"  # type: str
+
+TIMEZONE_UTC = timezone.utc  # type: datetime.timezone
+TIMEZONE_UTC_NAME = TIMEZONE_UTC.tzname(None)  # type: str
+TIMEZONE_UTC_OFFSET = timedelta(0)  # type: datetime.timedelta
+TIMEZONE_UTC_OFFSET_TOTAL_MINUTES = 0  # type: int
+TIMEZONE_UTC_OFFSET_HOURS = 0  # type: int
+TIMEZONE_UTC_OFFSET_MINUTES = 0  # type: int
+TIMEZONE_UTC_SUFFIX = "Z"  # type: str
+
 
 def parse_datetime_string(value: str) -> Optional[datetime]:
     """
@@ -83,46 +99,60 @@ def normalize_date_string(value: str) -> Optional[str]:
     return d.strftime("%Y-%m-%d") if d else None
 
 
-def get_timezone(hours: int, minutes: Optional[int] = None) -> timezone:
+def get_timezone(hours_or_timedelta: Union[int, timedelta], minutes: Optional[int] = None) -> timezone:
+    try:
+        if isinstance(hours_or_timedelta, timedelta):
+            return timezone(hours_or_timedelta)
+        return timezone(timedelta(hours=hours_or_timedelta, minutes=minutes or 0))
+    except Exception:
+        return TIMEZONE_LOCAL
+
+
+def get_timezone_offset(tz: timezone) -> timedelta:
     try:
-        return timezone(timedelta(hours=hours, minutes=minutes or 0))
+        return tz.utcoffset(None)
     except Exception:
-        return timezone.utc
+        return TIMEZONE_LOCAL_OFFSET
 
 
 def get_timezone_hours_minutes(tz: timezone) -> Tuple[int, int]:
     """
     Returns a tuple with the integer hours and minutes offset for the given timezone.
+    If negative then only the hours is negative; the mintutes is always positive;
+    this is okay because there are no timezones less than one hour from UTC.
     """
-    tz_minutes = datetime.now(tz).utcoffset().total_seconds() / 60
-    return int(tz_minutes // 60), int(abs(tz_minutes % 60))
+    tz_offset = get_timezone_offset(tz)
+    tz_offset_total_minutes = int(tz_offset.total_seconds()) // 60
+    tz_offset_hours = tz_offset_total_minutes // 60
+    tz_offset_minutes = abs(tz_offset_total_minutes % 60)
+    return tz_offset_hours, tz_offset_minutes
 
 
 def get_utc_timezone() -> timezone:
-    return timezone.utc
+    return TIMEZONE_UTC
 
 
 def get_local_timezone() -> timezone:
     """
     Returns current/local timezone as a datetime.timezone object.
     """
-    return datetime.now().astimezone().tzinfo
+    return TIMEZONE_LOCAL
 
 
 def get_local_timezone_string() -> str:
     """
     Returns current/local timezone in format like: "-05:00".
     """
-    tz_hours, tz_minutes = get_local_timezone_hours_minutes()
-    return f"{tz_hours:+03d}:{tz_minutes:02d}"
+    return TIMEZONE_LOCAL_SUFFIX
 
 
 def get_local_timezone_hours_minutes() -> Tuple[int, int]:
     """
     Returns a tuple with the integer hours and minutes offset for the current/local timezone.
+    If negative then only the hours is negative; the mintutes is always positive;
+    this is okay because there are no timezones less than one hour from UTC.
     """
-    tz_minutes = datetime.now(timezone.utc).astimezone().utcoffset().total_seconds() / 60
-    return int(tz_minutes // 60), int(abs(tz_minutes % 60))
+    return TIMEZONE_LOCAL_OFFSET_HOURS, TIMEZONE_LOCAL_OFFSET_MINUTES
 
 
 def parse_datetime(value: str, utc: bool = False, tz: Optional[timezone] = None) -> Optional[datetime]:
@@ -154,14 +184,16 @@ def parse_datetime(value: str, utc: bool = False, tz: Optional[timezone] = None)
 
 def format_datetime(value: datetime,
                     utc: bool = False,
-                    iso: bool = False,
-                    ms: bool = False,
                     tz: Optional[Union[timezone, bool]] = None,
+                    iso: bool = False,
                     notz: bool = False,
                     noseconds: bool = False,
+                    ms: bool = False,
                     verbose: bool = False,
                     noseparator: bool = False,
-                    noday: bool = False) -> Optional[str]:
+                    noday: bool = False,
+                    nodate: bool = False,
+                    notime: bool = False) -> str:
     """
     Returns the given datetime as a string in "YYYY:MM:DD hh:mm:ss tz" format, for
     example "2024-04-17 15:42:26 EDT". If the given notz argument is True then omits
@@ -173,9 +205,11 @@ def format_datetime(value: datetime,
     one; if the given utc argument is True then it will be UTC; or if the given tz
     argument is a datetime.timezone it will be in that timezone.
     """
+    if nodate is True and notime is True:
+        return ""
     if not isinstance(value, datetime):
         if not isinstance(value, str) or not (value := parse_datetime(value)):
-            return None
+            return ""
     try:
         if utc is True:
             tz = timezone.utc
@@ -195,19 +229,70 @@ def format_datetime(value: datetime,
                 value = value.replace(microsecond=0)
             if noseconds is True:
                 if notz is True:
-                    return value.strftime(f"%Y-%m-%dT%H:%M")
+                    if nodate is True:
+                        return value.strftime(f"%H:%M")
+                    elif notime is True:
+                        return value.strftime(f"%Y-%m-%d")
+                    else:
+                        return value.strftime(f"%Y-%m-%dT%H:%M")
                 tz = value.strftime("%z")
                 tz = tz[:3] + ":" + tz[3:]
-                return value.strftime(f"%Y-%m-%dT%H:%M") + tz
-            return value.isoformat()
+                if nodate is True:
+                    return value.strftime(f"%H:%M") + tz
+                elif notime is True:
+                    return value.strftime(f"%Y-%m-%d") + tz
+                else:
+                    return value.strftime(f"%Y-%m-%dT%H:%M") + tz
+            if nodate is True:
+                return value.strftime(f"%H:%M:%S{f'.%f' if ms is True else ''}")
+            elif notime is True:
+                return value.strftime(f"%Y-%m-%d")
+            else:
+                return value.isoformat()
         if verbose:
-            return value.strftime(
-                f"{'' if noday is True else '%A, '}%B %-d, %Y{'' if noseparator is True else ' |'}"
-                f" %-I:%M{'' if noseconds is True else ':%S'}"
-                f"{f'.%f' if ms is True else ''} %p{'' if notz is True else ' %Z'}")
+            if nodate is True:
+                return value.strftime(
+                    f"%-I:%M{'' if noseconds is True else ':%S'}"
+                    f"{f'.%f' if ms is True else ''} %p{'' if notz is True else ' %Z'}")
+            elif notime is True:
+                return value.strftime(f"{'' if noday is True else '%A, '}%B %-d, %Y")
+            else:
+                return value.strftime(
+                    f"{'' if noday is True else '%A, '}%B %-d, %Y{'' if noseparator is True else ' |'}"
+                    f" %-I:%M{'' if noseconds is True else ':%S'}"
+                    f"{f'.%f' if ms is True else ''} %p{'' if notz is True else ' %Z'}")
         else:
-            return value.strftime(
-                f"%Y-%m-%d %H:%M{'' if noseconds is True else ':%S'}"
-                f"{f'.%f' if ms is True else ''}{'' if notz is True else ' %Z'}")
+            if nodate is True:
+                return value.strftime(
+                    f"%H:%M{'' if noseconds is True else ':%S'}"
+                    f"{f'.%f' if ms is True else ''}{'' if notz is True else ' %Z'}")
+            elif notime is True:
+                return value.strftime(f"%Y-%m-%d")
+            else:
+                return value.strftime(
+                    f"%Y-%m-%d %H:%M{'' if noseconds is True else ':%S'}"
+                    f"{f'.%f' if ms is True else ''}{'' if notz is True else ' %Z'}")
     except Exception:
         return None
+
+
+def format_date(value: datetime,
+                utc: bool = False,
+                iso: bool = False,
+                tz: Optional[Union[timezone, bool]] = None,
+                verbose: bool = False,
+                noday: bool = False) -> str:
+    return format_datetime(value, utc=utc, iso=iso, tz=tz, verbose=verbose, noday=noday, notime=True)
+
+
+def format_time(value: datetime,
+                utc: bool = False,
+                iso: bool = False,
+                ms: bool = False,
+                tz: Optional[Union[timezone, bool]] = None,
+                notz: bool = False,
+                noseconds: bool = False,
+                verbose: bool = False,
+                noday: bool = False) -> str:
+    return format_datetime(value, utc=utc, iso=iso, ms=ms, tz=tz, notz=notz,
+                           noseconds=noseconds, verbose=verbose, nodate=True)

dcicutils/structured_data.py

@@ -174,6 +174,18 @@ class StructuredDataSet:
         result = []
         if self._norefs:
             for ref in self._resolved_refs:
+                # The structure of this self._resolved_refs is setup in Schema._map_function_ref,
+                # which is called whenever a reference (linkTo) is encountered. It is a set of
+                # tuples containing three items: [0] the ref path, [1] its uuid (if applicable),
+                # and [2] its src. The src identifies the place where this ref occurred and is a
+                # dictionary containing file, type, column, and row properties. For this case, of
+                # norefs (i.e. unchecked refs), the uuid ([1]) is None because we are skipping
+                # ref resolution. But the src is actually a *string* dump of the dictionary, only
+                # because dictionaries cannot be put in a set (which is what _resolved_refs is);
+                # this dump is also done in Schema._map_function_ref (should probably change this
+                # to be a list to avoid this - TODO); we only even store this src info for this
+                # norefs case, as not really needed otherwise. This is just to support the
+                # useful-for-troublehsooting options --info --refs for smaht-submitr.
                 if len(ref) >= 3 and (ref_path := ref[0]) and (ref_src := load_json(ref[2])):
                     if existing_ref := [item for item in result if item.get("path") == ref_path]:
                         existing_ref[0]["srcs"].append(ref_src)
@@ -681,9 +693,11 @@ class Schema(SchemaBase):
                 # Here the caller has specified the (StructuredDataSet) norefs option
                 # which means we do not check for the existence of references at all.
                 if value:
-                    # Dump the src as a JSON string because a dictionary cannot be added to a set; note
-                    # that this is ONLY used for smaht-submitr/submit-metadata-bundle --info --refs.
-                    # This info can be gotten at using StructureDataSet.unchecked_refs.
+                    # Dump the src as a JSON string because a dictionary cannot be added to a set;
+                    # this is ONLY used for smaht-submitr/submit-metadata-bundle --info --refs.
+                    # This info exposed via StructureDataSet.unchecked_refs. TODO: Should probably
+                    # make this not a set type so we dont' have to do this dump (and corresponding
+                    # load, in StructureDataSet.unchecked_refs).
                     self._resolved_refs.add((f"/{link_to}/{value}", None,
                                              json.dumps(src) if isinstance(src, dict) else None))
                 return value

{dcicutils-8.8.3.1b14.dist-info → dcicutils-8.8.3.1b16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.3.1b14
+Version: 8.8.3.1b16
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT

{dcicutils-8.8.3.1b14.dist-info → dcicutils-8.8.3.1b16.dist-info}/RECORD

@@ -2,7 +2,7 @@ dcicutils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dcicutils/base.py,sha256=gxNEv3DSVUfoX3NToWw7pcCdguxsJ75NDqsPi3wdFG4,5115
 dcicutils/beanstalk_utils.py,sha256=nHMWfFnZAXFiJh60oVouwbAPMKsQfHnDtkwz_PDE6S4,51434
 dcicutils/bundle_utils.py,sha256=ZVQcqlt7Yly8-YbL3A-5DW859_hMWpTL6dXtknEYZIw,34669
-dcicutils/captured_output.py,sha256=2pzkq7vtC47zwsSeXS6cJNxC_LXpUbw6ArudKlJHdb0,3108
+dcicutils/captured_output.py,sha256=0hP7sPwleMaYXQAvCfJOxG8Z8T_JJYy8ADp8A5ZoblE,3295
 dcicutils/cloudformation_utils.py,sha256=MtWJrSTXyiImgbPHgRvfH9bWso20ZPLTFJAfhDQSVj4,13786
 dcicutils/codebuild_utils.py,sha256=CKpmhJ-Z8gYbkt1I2zyMlKtFdsg7T8lqrx3V5ieta-U,1155
 dcicutils/command_utils.py,sha256=JExll5TMqIcmuiGvuS8q4XDUvoEfi2oSH0E2FVF6suU,15285
@@ -12,7 +12,7 @@ dcicutils/contribution_utils.py,sha256=vYLS1JUB3sKd24BUxZ29qUBqYeQBLK9cwo8x3k64u
 dcicutils/creds_utils.py,sha256=xrLekD49Ex0GOpL9n7LlJA4gvNcY7txTVFOSYD7LvEU,11113
 dcicutils/data_readers.py,sha256=6EMrY7TjDE8H7bA_TCWtpLQP7slJ0YTL77_dNh6e7sg,7626
 dcicutils/data_utils.py,sha256=k2OxOlsx7AJ6jF-YNlMyGus_JqSUBe4_n1s65Mv1gQQ,3098
-dcicutils/datetime_utils.py,sha256=S3SCmpqv_Z0CS8_yqZsoN4aL1Epu8jwKs6DDYs96OdM,9427
+dcicutils/datetime_utils.py,sha256=STFFakdCIwtuRLA1PCbieeXniTPY8Rchg5Psv1CUJ84,13342
 dcicutils/deployment_utils.py,sha256=sKv8Jb-_Zw2aH3OAywRlsre-Cqm3a7fEGG3_1PT-r-s,69908
 dcicutils/diff_utils.py,sha256=sQx-yz56DHAcQWOChYbAG3clXu7TbiZKlw-GggeveO0,8118
 dcicutils/docker_utils.py,sha256=30gUiqz7X9rJwSPXTPn4ewjQibUgoSJqhP9o9vn5X-A,1747
@@ -63,7 +63,7 @@ dcicutils/secrets_utils.py,sha256=8dppXAsiHhJzI6NmOcvJV5ldvKkQZzh3Fl-cb8Wm7MI,19
 dcicutils/sheet_utils.py,sha256=VlmzteONW5VF_Q4vo0yA5vesz1ViUah1MZ_yA1rwZ0M,33629
 dcicutils/snapshot_utils.py,sha256=ymP7PXH6-yEiXAt75w0ldQFciGNqWBClNxC5gfX2FnY,22961
 dcicutils/ssl_certificate_utils.py,sha256=F0ifz_wnRRN9dfrfsz7aCp4UDLgHEY8LaK7PjnNvrAQ,9707
-dcicutils/structured_data.py,sha256=Ho97KAqPgfn9QVfIMpjp0gS1FXLAnEJu6usdVi2lGHc,59927
+dcicutils/structured_data.py,sha256=BQuIMv6OPySsn6YxtXE2Er-zLE2QJuCYhEQ3V0u_UXY,61238
 dcicutils/submitr/progress_constants.py,sha256=5bxyX77ql8qEJearfHEvsvXl7D0GuUODW0T65mbRmnE,2895
 dcicutils/submitr/ref_lookup_strategy.py,sha256=Js2cVznTmgjciLWBPLCvMiwLIHXjDn3jww-gJPjYuFw,3467
 dcicutils/task_utils.py,sha256=MF8ujmTD6-O2AC2gRGPHyGdUrVKgtr8epT5XU8WtNjk,8082
@@ -72,8 +72,8 @@ dcicutils/trace_utils.py,sha256=g8kwV4ebEy5kXW6oOrEAUsurBcCROvwtZqz9fczsGRE,1769
 dcicutils/validation_utils.py,sha256=cMZIU2cY98FYtzK52z5WUYck7urH6JcqOuz9jkXpqzg,14797
 dcicutils/variant_utils.py,sha256=2H9azNx3xAj-MySg-uZ2SFqbWs4kZvf61JnK6b-h4Qw,4343
 dcicutils/zip_utils.py,sha256=rnjNv_k6L9jT2SjDSgVXp4BEJYLtz9XN6Cl2Fy-tqnM,2027
-dcicutils-8.8.3.1b14.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.3.1b14.dist-info/METADATA,sha256=Od4jg67J1tt_7cxv1n04p8PGmpjbnlfi9-EKsMS-GKk,3357
-dcicutils-8.8.3.1b14.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.3.1b14.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.3.1b14.dist-info/RECORD,,
+dcicutils-8.8.3.1b16.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.3.1b16.dist-info/METADATA,sha256=911IvUnQQ4KuLpV7KUYEOz9rduwKZVugINSficjzMIY,3357
+dcicutils-8.8.3.1b16.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.3.1b16.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.3.1b16.dist-info/RECORD,,