Adding function to list all data qualities

Author: Neeratyoy

doc/api.rst

@@ -72,6 +72,7 @@ Modules
     get_dataset
     get_datasets
     list_datasets
+    list_qualities
     status_update
 
 :mod:`openml.evaluations`: Evaluation Functions

openml/datasets/__init__.py

@@ -6,6 +6,7 @@
     get_datasets,
     list_datasets,
     status_update,
+    list_qualities
 )
 from .dataset import OpenMLDataset
 from .data_feature import OpenMLDataFeature
@@ -20,4 +21,5 @@
     'OpenMLDataset',
     'OpenMLDataFeature',
     'status_update',
+    'list_qualities'
 ]

openml/datasets/functions.py

@@ -165,6 +165,36 @@ def _get_cache_directory(dataset: OpenMLDataset) -> str:
     return _create_cache_directory_for_id(DATASETS_CACHE_DIR_NAME, dataset.dataset_id)
 
 
+def list_qualities(verbose=False):
+    """ Return list of data qualities available
+
+    The function performs an API call to retrieve the entire list of
+    data qualities that are available are computed on the datasets uploaded.
+
+    Parameters
+    ----------
+    verbose : bool (default=False)
+        If True, prints out the list with an index
+
+    """
+    api_call = "data/qualities/list"
+    xml_string = openml._api_calls._perform_api_call(api_call, 'get')
+    qualities = xmltodict.parse(xml_string)
+    # Minimalistic check if the XML is useful
+    if 'oml:data_qualities_list' not in qualities:
+        raise ValueError('Error in return XML, does not contain '
+                         '"oml:data_qualities_list"')
+    assert type(qualities['oml:data_qualities_list']['oml:quality']) == list
+    qualities = qualities['oml:data_qualities_list']['oml:quality']
+    if verbose:
+        header = "List of available data qualities:"
+        print(header)
+        print("=" * len(header))
+        for i, quality in enumerate(qualities):
+            print("{:>3}....{}".format(i + 1, quality))
+    return qualities
+
+
 def list_datasets(
     offset: Optional[int] = None,
     size: Optional[int] = None,