cdapython 2.0.10__tar.gz → 2.0.12__tar.gz

{cdapython-2.0.10 → cdapython-2.0.12}/CHANGELOG.md

@@ -1,3 +1,7 @@
+2025-10-31: 2.0.12: standardize debug-layer SQL echo; adjust column\_values() to handle known pathologies
+
+2025-10-27: 2.0.11: _cough_ bugfix for previous
+
 2025-10-27: 2.0.10: integrate column\_values() parameter validation with shared validation library; expand support for column\_values( data\_source ) to accept list values in addition to single strings
 
 2025-10-22: 2.0.9: parametrize data\_source check in column\_values()

{cdapython-2.0.10 → cdapython-2.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdapython
-Version: 2.0.10
+Version: 2.0.12
 Summary: NCI CRDC CDA front-end user interface library
 License-File: LICENSE
 Requires-Python: >=3.9,<4.0

{cdapython-2.0.10 → cdapython-2.0.12}/cdapython/discover.py

@@ -885,6 +885,16 @@ def column_values(
     # Normalize sort_by case. Also, ':asc' is redundant: remove it (politely).
     sort_by = re.sub( r':asc$', r'', sort_by ).lower()
 
+    # Set default sort_by value.
+    if sort_by == '':
+        if return_data_as in [ '', 'dataframe', 'tsv' ]:
+            sort_by = 'count'
+        elif return_data_as in [ 'list' ]:
+            sort_by = 'value'
+        else:
+            log.error( f"Cannot identify default `sort_by` value for unexpected `return_data_as` value '{return_data_as}': please notify the CDA devs of this event." )
+            return
+
     #############################################################################################################################
     # Check in advance for columns flagged as high-overhead.
 

{cdapython-2.0.10 → cdapython-2.0.12}/cdapython/get_data.py

@@ -824,13 +824,15 @@ def get_data(
 
         next_result_batch = pd.json_normalize( api_response_object.to_dict()['result'] )
 
+        log.debug( f"/data/{table} endpoint query SQL:\n{api_response_object.to_dict()['query_sql']}" )
+
         # Add data from this page to our full result set.
 
         if not result_dataframe.empty and not next_result_batch.empty:
             
             # Silence a future deprecation warning about pd.concat and empty DataFrame columns.
             # 
-            # Possiby relevant note: never fill in missing numeric values with 0!
+            # Possibly relevant note: never fill in missing numeric values with 0!
 
             next_result_batch = next_result_batch.astype( result_dataframe.dtypes )
             result_dataframe = pd.concat( [result_dataframe, next_result_batch] )

{cdapython-2.0.10 → cdapython-2.0.12}/cdapython/validation.py

@@ -634,13 +634,16 @@ def validate_parameter_values(
             'list': {
                 '',
                 'value',
+                'value:asc',
                 'value:desc'
             },
             'dataframe_or_tsv': {
                 '',
                 'count',
+                'count:asc',
                 'count:desc',
                 'value',
+                'value:asc',
                 'value:desc'
             }
         }
@@ -653,13 +656,13 @@ def validate_parameter_values(
             # Restrict sorting options for lists.
             if sort_by == '':
                 sort_by = 'value'
-            elif sort_by not in allowed_sort_by_options['list']:
+            elif sort_by.lower() not in allowed_sort_by_options['list']:
                 raise RuntimeError( f"return_data_as='list' can only be processed with sort_by='value' or sort_by='value:desc' (or omitting sort_by altogether). Please modify unsupported sort_by directive '{sort_by}' and try again." )
         else:
             # For TSV output files and DataFrames, we support more user-configurable options (defaulting to sort_by='count:desc'):
             if sort_by == '':
                 sort_by = 'count:desc'
-            elif sort_by not in allowed_sort_by_options['dataframe_or_tsv']:
+            elif sort_by.lower() not in allowed_sort_by_options['dataframe_or_tsv']:
                 raise RuntimeError( f"unrecognized sort_by '{sort_by}'. Please use one of 'count', 'value', 'count:desc', 'value:desc', 'count:asc' or 'value:asc' (or omit the sort_by parameter altogether)." )
 
     elif sort_by is not None:

{cdapython-2.0.10 → cdapython-2.0.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cdapython"
-version = "2.0.10"
+version = "2.0.12"
 description = "NCI CRDC CDA front-end user interface library"
 authors = []
 readme = "README.md"