dcicutils 8.8.3.1b15__py3-none-any.whl → 8.8.3.1b17__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/progress_bar.py

@@ -335,7 +335,15 @@ class ProgressBar:
             nonlocal sys_stdout_write
             if sys_stdout_write is not None:
                 sys.stdout.write = sys_stdout_write
+        def ascii_spinners() -> list:  # noqa
+            # Fun with ASCII spinners.
+            return list("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏")  # borrowed from rich python package
+            # return list("⣾⣽⣻⢿⡿⣟⣯⣷")  # borrowed from rich python package
+            # return list("⠿⠻⠽⠾⠷⠯⠟")
+            # return list("⠏⠛⠹⠼⠶⠧")
+            # return list("⠻⠽⠾⠷⠯⠟")
+            # return list("|/—◦\\")
         sys.stdout.write = tidy_stdout_write
-        spina = ["|", "/", "—", "◦", "\\"] ; spini = 0 ; spinn = len(spina)  # noqa
+        spina = ascii_spinners() ; spini = 0 ; spinn = len(spina)  # noqa
         sentinel = "[progress]" ; sentinel_internal = f"{sentinel}:"  # noqa
         return namedtuple("tidy_output_hack", ["restore", "sentinel"])(restore_stdout_write, sentinel)

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.1b15.dist-info → dcicutils-8.8.3.1b17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.3.1b15
+Version: 8.8.3.1b17
 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.1b15.dist-info → dcicutils-8.8.3.1b17.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
@@ -48,7 +48,7 @@ dcicutils/obfuscation_utils.py,sha256=fo2jOmDRC6xWpYX49u80bVNisqRRoPskFNX3ymFAmj
 dcicutils/opensearch_utils.py,sha256=V2exmFYW8Xl2_pGFixF4I2Cc549Opwe4PhFi5twC0M8,1017
 dcicutils/portal_object_utils.py,sha256=gDXRgPsRvqCFwbC8WatsuflAxNiigOnqr0Hi93k3AgE,15422
 dcicutils/portal_utils.py,sha256=DYyE5o15GekDgzpJWas9iS7klAYbjJZUPW0G42McArk,30779
-dcicutils/progress_bar.py,sha256=th-M7Q1UfkmQWc8M36lfVoRhFAQVRT9fSpdHi5RHqNY,17389
+dcicutils/progress_bar.py,sha256=ux0fKSgXyX6sVfQR2II7TGEYH_ztcBMTH7OBb6J24OY,17833
 dcicutils/project_utils.py,sha256=qPdCaFmWUVBJw4rw342iUytwdQC0P-XKpK4mhyIulMM,31250
 dcicutils/qa_checkers.py,sha256=cdXjeL0jCDFDLT8VR8Px78aS10hwNISOO5G_Zv2TZ6M,20534
 dcicutils/qa_utils.py,sha256=TT0SiJWiuxYvbsIyhK9VO4uV_suxhB6CpuC4qPacCzQ,160208
@@ -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.1b15.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.8.3.1b15.dist-info/METADATA,sha256=JY0PlcvcINCPnQ0qQ6u5flnCWSw1237wWPTfmlg43T4,3357
-dcicutils-8.8.3.1b15.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.8.3.1b15.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
-dcicutils-8.8.3.1b15.dist-info/RECORD,,
+dcicutils-8.8.3.1b17.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.8.3.1b17.dist-info/METADATA,sha256=lbXFoEaBL0YX-S_n15vciHm69phgyYG1Ryr3H8fJcdM,3357
+dcicutils-8.8.3.1b17.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.8.3.1b17.dist-info/entry_points.txt,sha256=51Q4F_2V10L0282W7HFjP4jdzW4K8lnWDARJQVFy_hw,270
+dcicutils-8.8.3.1b17.dist-info/RECORD,,