Formatting

Author: d-giles

pyvo/dal/adhoc.py

@@ -400,8 +400,8 @@ def iter_datalinks(self, preserve_order=False):
     def iter_get_cloud_params(
         self,
         provider: str,
-        colname: str="cloud_access",
-        verbose: bool=False,
+        colname: str = "cloud_access",
+        verbose: bool = False,
         **match_params
     ):
         """
@@ -416,7 +416,7 @@ def iter_get_cloud_params(
         verbose : bool, optional
             Whether to print debug text, by default False.
         **match_params : str, optional
-            Further parameters on which to match beyond `provider`.
+            Further parameters on which to match beyond provider.
 
         Returns
         -------
@@ -430,15 +430,15 @@ def iter_get_cloud_params(
             products = dl_results.bysemantics("#this")
 
             for jrow, row in enumerate(products):
-                # if no colname column, there is nothing to do    
+                # if no colname column, there is nothing to do
                 jsontxt = row._guess_cloud_column(colname=colname)
                 if jsontxt:
                     access_points = row.parse_json_params(
                         json_txt=jsontxt,
                         json_key=provider,
                         verbose=verbose,
                         **match_params
-                        )
+                    )
                     access_points.add_column([jrow]*len(access_points), name="datalink_row", index=0)
                     if jrow == 0:
                         new_dl_table = access_points
@@ -462,6 +462,7 @@ def iter_get_cloud_params(
 
         return new_table
 
+
 class DatalinkRecordMixin:
     """
     Mixin for record classes, providing functionallity for datalink.
@@ -514,11 +515,11 @@ def getdataset(self, timeout=None):
     def parse_json_params(
         json_txt: str,
         json_key: str,
-        verbose: bool=False,
+        verbose: bool = False,
         **match_params
-        ):
+    ):
         """Parse information stored as JSON by key
-        
+
         Parameters
         ----------
         json_txt : str
@@ -528,7 +529,7 @@ def parse_json_params(
         verbose : bool, optional
             Whether to print progress and errors, by default False
         **match_params : str, optional
-            Further parameters on which to match beyond `json_key`.
+            Further parameters on which to match beyond json_key.
 
         Returns
         -------
@@ -540,7 +541,7 @@ def parse_json_params(
 
         # init results table (avoiding adding import of astropy.table.Table)
         new_table = TableElement(VOTableFile()).to_table()
-    
+
         jsonDict = json.loads(json_txt)
         if json_key not in jsonDict and verbose:
             print(f'No key "{json_key}" found in json_txt given.')
@@ -591,7 +592,7 @@ def _guess_cloud_column(self, colname="cloud_access"):
         if cloud_access:
             return cloud_access
 
-        cloud_access = self.getbyucd("meta.ref.cloudstorage") 
+        cloud_access = self.getbyucd("meta.ref.cloudstorage")
         if cloud_access:
             return cloud_access
 
@@ -601,9 +602,9 @@ def get_cloud_params(
         colname: str = "cloud_access",
         verbose: bool = False,
         **match_params
-        ):
+    ):
         """Parse cloud information stored as JSON by provider
-        
+
         Parameters
         ----------
         provider: str
@@ -613,8 +614,8 @@ def get_cloud_params(
         verbose: bool, optional
             If True, print progress and debug text, by default False
         **match_params
-            Further parameters on which to match beyond `provider`.
-            
+            Further parameters on which to match beyond provider.
+
         Return
         ------
         astropy.Table
@@ -625,17 +626,16 @@ def get_cloud_params(
         dl_results = self.getdatalink()
         products = dl_results.bysemantics("#this")
 
-
         for irow, row in enumerate(products):
-            # if no colname column, there is nothing to do    
+            # if no colname column, there is nothing to do
             cloud_json = row._guess_cloud_column(colname=colname)
             if cloud_json:
                 access_points = row.parse_json_params(
                     json_txt=cloud_json,
                     json_key=provider,
                     verbose=verbose,
                     **match_params
-                    )
+                )
                 access_points.add_column([irow]*len(access_points), name="datalink_row", index=0)
                 if irow == 0:
                     new_table = access_points
@@ -651,6 +651,7 @@ def get_cloud_params(
 
         return new_table
 
+
 class DatalinkService(DALService, AvailabilityMixin, CapabilityMixin):
     """
     a representation of a Datalink service

pyvo/dal/tests/test_datalink.py

@@ -76,12 +76,14 @@ def callback(request, context):
     ) as matcher:
         yield matcher
 
+
 @pytest.fixture()
 def datalink_cloud1(mocker):
-    def callback(request, context): 
+    def callback(request, context):
         dl_base = parse('pyvo/dal/tests/data/datalink/datalink.xml')
         dl_base_table = dl_base.get_first_table().to_table()
-        cloud_access_str = '{"aws": {"bucket_name": "test", "key":"path/to/cloudfile.fits", "region": "us-west-2"}}'
+        cloud_access_str = ('{"aws": {"bucket_name": "test", '
+        '"key":"path/to/cloudfile.fits", "region": "us-west-2"}}')
         dl_base_table.add_column([cloud_access_str]*4, name='cloud_access')
         out = BytesIO()
         votable = from_table(dl_base_table)
@@ -94,14 +96,17 @@ def callback(request, context):
     ) as matcher:
         yield matcher
 
+
 @pytest.fixture()
 def datalink_cloud2(mocker):
-    def callback(request, context): 
+    def callback(request, context):
         dl_base = parse('pyvo/dal/tests/data/datalink/datalink.xml')
         dl_base_table = dl_base.get_first_table().to_table()
         cloud_access_str = ('{"aws": '
-                            '[{"bucket_name": "test", "key": "path/to/cloudfile.fits", "region": "us-west-2"}, '
-                             '{"bucket_name": "test", "key": "path/to/cloudfile2.fits", "region": "us-west-2"}]}')
+                            '[{"bucket_name": "test", '
+                            '"key": "path/to/cloudfile.fits", "region": "us-west-2"}, '
+                             '{"bucket_name": "test", '
+                             '"key": "path/to/cloudfile2.fits", "region": "us-west-2"}]}')
         dl_base_table.add_column([cloud_access_str]*4, name='cloud_access')
         out = BytesIO()
         votable = from_table(dl_base_table)
@@ -114,6 +119,7 @@ def callback(request, context):
     ) as matcher:
         yield matcher
 
+
 @pytest.fixture()
 def obscore_datalink(mocker):
     def callback(request, context):
@@ -376,31 +382,32 @@ def test_no_datalink():
     with pytest.raises(DALServiceError, match="No datalink found for record."):
         result.getdatalink()
 
+
 @pytest.mark.filterwarnings("ignore::astropy.io.votable.exceptions.E02")
 @pytest.mark.usefixtures('datalink_cloud1', 'datalink_cloud2', 'datalink_product')
 class TestJsonColumns:
-    """Tests for producing datalinks from tables containing links to
-    datalink documents.
+    """Tests for parsing JSON in Records and Results columns.
     """
 
     res = testing.create_dalresults([
-            {"name": "access_url", "datatype": "char", "arraysize": "*",
-                "ucd": "meta.ref.url"},
-            {"name": "access_format", "datatype": "char", "arraysize": "*",
-                "utype": "meta.code.mime"},
-            {"name": "cloud_access", "datatype": "char", "arraysize": "*",
-                "utype": "adhoc:cloudstorage", "ucd": "meta.ref.cloudstorage"},],
-            [("http://example.com/datalink-cloud1.xml",
-                "application/x-votable+xml;content=datalink",
-                '{"aws": {"bucket_name": "test", "key":"path/to/file1.fits", "region": "us-west-2"}}',),
-                ("http://example.com/datalink-cloud2.xml",
-                "application/x-votable+xml;content=datalink",
-                '{"aws": {"bucket_name": "test", "key":"path/to/file2.fits", "region": "us-west-2"}}',),
-                 ("http://example.com/datalink.xml",
-                "application/x-votable+xml;content=datalink",
-                '{"aws": {"bucket_name": "test", "key":"path/to/file2.fits", "region": "us-west-2"}}',),],
-            resultsClass=SIA2Results
-        )
+        {"name": "access_url", "datatype": "char", "arraysize": "*",
+         "ucd": "meta.ref.url"},
+        {"name": "access_format", "datatype": "char", "arraysize": "*",
+         "utype": "meta.code.mime"},
+        {"name": "cloud_access", "datatype": "char", "arraysize": "*",
+         "utype": "adhoc:cloudstorage", "ucd": "meta.ref.cloudstorage"},],
+        [("http://example.com/datalink-cloud1.xml",
+          "application/x-votable+xml;content=datalink",
+          '{"aws": {"bucket_name": "test", "key":"path/to/file1.fits", "region": "us-west-2"}}',),
+        ("http://example.com/datalink-cloud2.xml",
+         "application/x-votable+xml;content=datalink",
+         '{"aws": {"bucket_name": "test", "key":"path/to/file2.fits", "region": "us-west-2"}}',),
+        ("http://example.com/datalink.xml",
+         "application/x-votable+xml;content=datalink",
+         '{"aws": {"bucket_name": "test", "key":"path/to/file2.fits", "region": "us-west-2"}}',),],
+        resultsClass=SIA2Results
+    )
+
     def test_record_w_json(self):
 
         jsontxt = '{"aws": {"bucket_name": "test", "key":"path/to/file1.fits", "region": "us-west-2"}}'
@@ -413,11 +420,14 @@ def test_extra_key(self):
         # Check that giving extra kwargs matches parameters
         jsontxt = '{"aws": {"bucket_name": "test", "key":"path/to/file1.fits", "region": "us-west-2"}}'
         parsed_json_matches0 = self.res[0].parse_json_params(json_txt=jsontxt, json_key="aws")
-        parsed_json_matches1 = self.res[0].parse_json_params(json_txt=jsontxt, json_key="aws", region="us-west-2")
+        parsed_json_matches1 = self.res[0].parse_json_params(json_txt=jsontxt,
+                                                             json_key="aws", region="us-west-2")
 
         assert parsed_json_matches0 == parsed_json_matches1
 
-        parsed_json_matches2 = self.res[0].parse_json_params(json_txt=jsontxt, json_key="aws", region="us-west-1")
+        parsed_json_matches2 = self.res[0].parse_json_params(json_txt=jsontxt,
+                                                             json_key="aws",
+                                                             region="us-west-1")
         assert len(parsed_json_matches2) == 0
 
     def test_datalink_json(self):
@@ -444,7 +454,9 @@ def test_existing_colname(self):
 
     def no_column_in_datalink(self, capsys):
         # All column guesses come back empty
-        parsed_cloud_params = self.res[1].get_cloud_params(provider="aws", colname="cloud_access", verbose=True)
+        parsed_cloud_params = self.res[1].get_cloud_params(provider="aws",
+                                                           colname="cloud_access",
+                                                           verbose=True)
         assert "No column cloud_access" in capsys
         assert parsed_cloud_params is None
 
@@ -463,4 +475,3 @@ def test_iter_datalink_json(self):
         assert parsed_json_matches[2]["record_row"] == 1
         assert parsed_json_matches[2]["datalink_row"] == 0
         assert parsed_json_matches[2]["key"] == "path/to/cloudfile2.fits"
-