dcicutils 8.13.3__py3-none-any.whl → 8.13.3.1b1__py3-none-any.whl

dcicutils/scripts/view_portal_object.py

@@ -114,16 +114,13 @@ def main():
                         help="Copy object data to clipboard.")
     parser.add_argument("--output", required=False, help="Output file.", type=str)
     parser.add_argument("--indent", required=False, default=False, help="Indent output.", type=int)
-    parser.add_argument("--details", action="store_true", required=False, default=False, help="Detailed output.")
-    parser.add_argument("--more-details", action="store_true", required=False, default=False,
-                        help="More detailed output.")
+    parser.add_argument("--summary", action="store_true", required=False, default=False,
+                        help="Summary output (for schema only).")
+    parser.add_argument("--terse", action="store_true", required=False, default=False, help="Terse output.")
     parser.add_argument("--verbose", action="store_true", required=False, default=False, help="Verbose output.")
     parser.add_argument("--debug", action="store_true", required=False, default=False, help="Debugging output.")
     args = parser.parse_args()
 
-    if args.more_details:
-        args.details = True
-
     portal = _create_portal(ini=args.ini, env=args.env or os.environ.get("SMAHT_ENV"),
                             server=args.server, app=args.app, verbose=args.verbose, debug=args.debug)
 
@@ -143,9 +140,8 @@ def main():
         _output_file = io.open(args.output, "w")
 
     if args.uuid and ((args.uuid.lower() == "schemas") or (args.uuid.lower() == "schema")):
-        _print_all_schema_names(portal=portal, details=args.details,
-                                more_details=args.more_details, all=args.all,
-                                tree=args.tree, raw=args.raw, raw_yaml=args.yaml)
+        _print_all_schema_names(portal=portal, terse=args.terse, all=args.all,
+                                tree=args.tree, summary=args.summary, yaml=args.yaml)
         return
     elif args.uuid and (args.uuid.lower() == "info"):
         if consortia := portal.get_metadata("/consortia?limit=1000"):
@@ -182,7 +178,7 @@ def main():
         if schema:
             if args.copy:
                 pyperclip.copy(json.dumps(schema, indent=4))
-            if not args.raw:
+            if args.summary:
                 if parent_schema_name := _get_parent_schema_name(schema):
                     if schema.get("isAbstract") is True:
                         _print_output(f"{schema_name} | parent: {parent_schema_name} | abstract")
@@ -190,8 +186,8 @@ def main():
                         _print_output(f"{schema_name} | parent: {parent_schema_name}")
                 else:
                     _print_output(schema_name)
-            _print_schema(schema, details=args.details, more_details=args.details,
-                          all=args.all, raw=args.raw, raw_yaml=args.yaml)
+            _print_schema(schema, terse=args.terse,
+                          all=args.all, summary=args.summary, yaml=args.yaml)
             return
 
     data = _get_portal_object(portal=portal, uuid=args.uuid, raw=args.raw, inserts=args.inserts,
@@ -276,9 +272,26 @@ def _get_portal_object(portal: Portal, uuid: str,
             (isinstance(results_type := response.get("@type"), list) and results_type) and
             (isinstance(results_type := results_type[0], str) and results_type.endswith("SearchResults")) and
             (results_type := results_type[0:-len("SearchResults")])):  # noqa
+            # For search results, the type (from XyzSearchResults, above) may not be precisely correct for
+            # each of the results; it may be the supertype (e.g. QualityMetric vs QualityMetricWorkflowRun);
+            # so for types which are supertypes (gotten via Portal.get_schemas_super_type_map) we actually
+            # lookup each result individually to determine its actual precise type.
+            if not ((supertypes := portal.get_schemas_super_type_map()) and (subtypes := supertypes.get(results_type))):
+                subtypes = None
+            response = {}
             for result in results:
                 result.pop("schema_version", None)
-            response = {f"{results_type}": results}
+                if (subtypes and
+                    (result_uuid := result.get("uuid")) and
+                    (individual_result := portal.get_metadata(result_uuid, raise_exception=False)) and
+                    isinstance(result_type:= individual_result.get("@type"), list) and result_type and result_type[0]):  # noqa
+                    result_type = result_type[0]
+                else:
+                    result_type = results_type
+                if response.get(result_type):
+                    response[result_type].append(result)
+                else:
+                    response[result_type] = [result]
         # Get the result as non-raw so we can get its type.
         elif ((response_cooked := portal.get(path, database=database)) and
               (isinstance(response_type := response_cooked.json().get("@type"), list) and response_type)):
@@ -332,19 +345,19 @@ def _get_schema_name_from_schema_named_json_file_name(portal: Portal, value: str
         return False
 
 
-def _print_schema(schema: dict, details: bool = False, more_details: bool = False, all: bool = False,
-                  raw: bool = False, raw_yaml: bool = False) -> None:
-    if raw:
-        if raw_yaml:
+def _print_schema(schema: dict, terse: bool = False, all: bool = False,
+                  summary: bool = False, yaml: bool = False) -> None:
+    if summary is not True:
+        if yaml:
             _print_output(yaml.dump(schema))
         else:
             _print_output(json.dumps(schema, indent=4))
         return
-    _print_schema_info(schema, details=details, more_details=more_details, all=all)
+    _print_schema_info(schema, terse=terse, all=all)
 
 
 def _print_schema_info(schema: dict, level: int = 0,
-                       details: bool = False, more_details: bool = False, all: bool = False,
+                       terse: bool = False, all: bool = False,
                        required: Optional[List[str]] = None) -> None:
     if not schema or not isinstance(schema, dict):
         return
@@ -396,7 +409,7 @@ def _print_schema_info(schema: dict, level: int = 0,
                     _print_output(f"  - {reference_property['name']}: {reference_property['ref']}")
         if schema.get("additionalProperties") is True:
             _print_output(f"  - additional properties are allowed")
-    if not more_details:
+    if terse:
         return
     if properties := (schema.get("properties") if level == 0 else schema):
         if level == 0:
@@ -422,8 +435,7 @@ def _print_schema_info(schema: dict, level: int = 0,
                     if property.get("calculatedProperty"):
                         suffix += f" | calculated"
                     _print_output(f"{spaces}- {property_name}: {property_type}{suffix}")
-                    _print_schema_info(object_properties, level=level + 1,
-                                       details=details, more_details=more_details, all=all,
+                    _print_schema_info(object_properties, level=level + 1, terse=terse, all=all,
                                        required=property.get("required"))
                 elif property_type == "array":
                     suffix = ""
@@ -447,7 +459,7 @@ def _print_schema_info(schema: dict, level: int = 0,
                                 suffix = ""
                                 _print_output(f"{spaces}- {property_name}: array of object{suffix}")
                                 _print_schema_info(property_items.get("properties"), level=level + 1,
-                                                   details=details, more_details=more_details, all=all,
+                                                   terse=terse, all=all,
                                                    required=property_items.get("required"))
                             elif property_type == "array":
                                 # This (array-of-array) never happens to occur at this time (February 2024).
@@ -523,13 +535,13 @@ def _print_schema_info(schema: dict, level: int = 0,
 
 
 def _print_all_schema_names(portal: Portal,
-                            details: bool = False, more_details: bool = False, all: bool = False,
-                            tree: bool = False, raw: bool = False, raw_yaml: bool = False) -> None:
+                            terse: bool = False, all: bool = False,
+                            tree: bool = False, summary: bool = False, yaml: bool = False) -> None:
     if not (schemas := _get_schemas(portal)):
         return
 
-    if raw:
-        if raw_yaml:
+    if summary is not True:
+        if yaml:
             _print_output(yaml.dump(schemas))
         else:
             _print_output(json.dumps(schemas, indent=4))
@@ -550,8 +562,8 @@ def _print_all_schema_names(portal: Portal,
                 _print_output(f"{schema_name} | abstract")
             else:
                 _print_output(schema_name)
-        if details:
-            _print_schema(schemas[schema_name], details=details, more_details=more_details, all=all)
+        if not terse:
+            _print_schema(schemas[schema_name], terse=terse, all=all)
 
 
 def _get_parent_schema_name(schema: dict) -> Optional[str]:

{dcicutils-8.13.3.dist-info → dcicutils-8.13.3.1b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.13.3
+Version: 8.13.3.1b1
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT
@@ -26,8 +26,8 @@ Requires-Dist: PyJWT (>=2.6.0,<3.0.0)
 Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
 Requires-Dist: appdirs (>=1.4.4,<2.0.0)
 Requires-Dist: aws-requests-auth (>=0.4.2,<1)
-Requires-Dist: boto3 (>=1.34.136,<2.0.0)
-Requires-Dist: botocore (>=1.34.136,<2.0.0)
+Requires-Dist: boto3 (>=1.34.144,<2.0.0)
+Requires-Dist: botocore (>=1.34.144,<2.0.0)
 Requires-Dist: chardet (>=5.2.0,<6.0.0)
 Requires-Dist: docker (>=4.4.4,<5.0.0)
 Requires-Dist: elasticsearch (==7.13.4)

{dcicutils-8.13.3.dist-info → dcicutils-8.13.3.1b1.dist-info}/RECORD

@@ -61,7 +61,7 @@ dcicutils/schema_utils.py,sha256=GmRm-XqZKJ6qine16SQF1txcby9WougDav_sYmKNs9E,124
 dcicutils/scripts/publish_to_pypi.py,sha256=sMd4WASQGlxlh7uLrt2eGkFRXYgONVmvIg8mClMS5RQ,13903
 dcicutils/scripts/run_license_checker.py,sha256=z2keYnRDZsHQbTeo1XORAXSXNJK5axVzL5LjiNqZ7jE,4184
 dcicutils/scripts/update_portal_object.py,sha256=p9pFkoA3ZZOWvh-GMDpgR8qOfx_jQppOVNOjsuZndAU,18810
-dcicutils/scripts/view_portal_object.py,sha256=ddZdOuSsYD-4VlsWth0EBTD_2TycQ4Ktgh-IdzKHweM,31490
+dcicutils/scripts/view_portal_object.py,sha256=h8COy0lcLNWF9b5spjrlQ28wfqyTTMqAeC_xpFXutus,32262
 dcicutils/secrets_utils.py,sha256=8dppXAsiHhJzI6NmOcvJV5ldvKkQZzh3Fl-cb8Wm7MI,19745
 dcicutils/sheet_utils.py,sha256=VlmzteONW5VF_Q4vo0yA5vesz1ViUah1MZ_yA1rwZ0M,33629
 dcicutils/snapshot_utils.py,sha256=YDeI3vD-MhAtHwKDzfEm2q-n3l-da2yRpRR3xp0Ah1M,23021
@@ -75,8 +75,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=_Y9EmL3D2dUZhxucxHvrtmmlbZmK4FpSsHEb7rGSJLU,3265
-dcicutils-8.13.3.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.13.3.dist-info/METADATA,sha256=B583S5ausZLy7zA73GFhcTCgX3KJVnhy008WzM0H6uk,3442
-dcicutils-8.13.3.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.13.3.dist-info/entry_points.txt,sha256=W6kEWdUJk9tQ4myAgpehPdebcwvCAZ7UgB-wyPgDUMg,335
-dcicutils-8.13.3.dist-info/RECORD,,
+dcicutils-8.13.3.1b1.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.13.3.1b1.dist-info/METADATA,sha256=Qf_4Nxv0PpDGb0NuNqilIzyNY_tuJ8-sgXyN9YZZ1Zc,3446
+dcicutils-8.13.3.1b1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.13.3.1b1.dist-info/entry_points.txt,sha256=W6kEWdUJk9tQ4myAgpehPdebcwvCAZ7UgB-wyPgDUMg,335
+dcicutils-8.13.3.1b1.dist-info/RECORD,,