Merge branch 'black' into 'main'

Black conformance

See merge request cit/mathworks/jupyter-matlab-proxy!19

Author: dpwrussell

jupyter_matlab_proxy/app.py

@@ -286,7 +286,7 @@ async def wsforward(ws_from, ws_to):
 
 
 async def transform_body(req):
-    """ Transform some requests as required by the MATLAB JavaScript Desktop. """
+    """Transform some requests as required by the MATLAB JavaScript Desktop."""
 
     body = await req.read()
 
@@ -319,7 +319,7 @@ async def license_init(app):
 
 
 async def matlab_starter(app):
-    """ Upon app startup, start MATLAB if able to do so. """
+    """Upon app startup, start MATLAB if able to do so."""
 
     state = app["state"]
 

jupyter_matlab_proxy/app_state.py

@@ -44,7 +44,7 @@ def __init__(self, settings):
             return
 
     async def init_licensing(self):
-        """ Initialise licensing from persisted details or environment variable. """
+        """Initialise licensing from persisted details or environment variable."""
 
         # Persisted licensing details present
         if self.settings["matlab_config_file"].exists():
@@ -105,7 +105,7 @@ async def init_licensing(self):
             }
 
     def get_matlab_state(self):
-        """ Determine the state of MATLAB to be down/starting/up. """
+        """Determine the state of MATLAB to be down/starting/up."""
 
         matlab = self.processes["matlab"]
         xvfb = self.processes["xvfb"]
@@ -129,7 +129,7 @@ def get_matlab_state(self):
         return "starting"
 
     async def set_licensing_nlm(self, conn_str):
-        """ Set the licensing type to NLM and the connection string. """
+        """Set the licensing type to NLM and the connection string."""
 
         # TODO Validate connection string
         self.licensing = {"type": "nlm", "conn_str": conn_str}
@@ -143,7 +143,7 @@ async def set_licensing_mhlm(
         entitlements=[],
         entitlement_id=None,
     ):
-        """ Set the licensing type to MHLM and the details. """
+        """Set the licensing type to MHLM and the details."""
 
         try:
 
@@ -178,7 +178,7 @@ async def set_licensing_mhlm(
             log_error(logger, e)
 
     def unset_licensing(self):
-        """ Unset the licensing. """
+        """Unset the licensing."""
 
         self.licensing = None
 
@@ -187,7 +187,7 @@ def unset_licensing(self):
             self.error = None
 
     def is_licensed(self):
-        """ Is MATLAB licensing configured? """
+        """Is MATLAB licensing configured?"""
 
         if self.licensing is not None:
             if self.licensing["type"] == "nlm":
@@ -204,7 +204,7 @@ def is_licensed(self):
         return False
 
     def is_matlab_present(self):
-        """ Is MATLAB install accessible? """
+        """Is MATLAB install accessible?"""
 
         return self.settings["matlab_path"] is not None
 
@@ -289,7 +289,7 @@ def persist_licensing(self):
             f.write(json.dumps(config))
 
     def reserve_matlab_port(self):
-        """ Reserve a free port for MATLAB Embedded Connector in the allowed range. """
+        """Reserve a free port for MATLAB Embedded Connector in the allowed range."""
 
         # FIXME Because of https://github.com/http-party/node-http-proxy/issues/1342 the
         # node application in development mode always uses port 31515 to bypass the
@@ -316,7 +316,7 @@ def reserve_matlab_port(self):
                         raise e
 
     async def start_matlab(self, restart=False):
-        """ Start MATLAB. """
+        """Start MATLAB."""
 
         # FIXME
         if self.get_matlab_state() != "down" and restart is False:
@@ -445,7 +445,7 @@ async def reader():
         loop.create_task(reader())
 
     async def stop_matlab(self):
-        """ Terminate MATLAB. """
+        """Terminate MATLAB."""
 
         matlab = self.processes["matlab"]
         xvfb = self.processes["xvfb"]

jupyter_matlab_proxy/devel.py

@@ -24,7 +24,7 @@
 
 
 def wait_for_port(port):
-    """ Waits for the given port to become available """
+    """Waits for the given port to become available"""
 
     while True:
         print(f"Waiting for port {port} to be available")

jupyter_matlab_proxy/settings.py

@@ -16,7 +16,7 @@ def get_matlab_path():
 
 
 def get_matlab_version(matlab_path):
-    """ Get the MATLAB Release version in this image"""
+    """Get the MATLAB Release version in this image"""
 
     if matlab_path is None:
         return None

tests/test_mw.py

@@ -27,7 +27,9 @@ def mwa_api_data_fixture():
 
     mwa_api_endpoint = "https://login.mathworks.com/authenticationws/service/v4"
     mwa_api_endpoint_pattern = re.compile("^" + mwa_api_endpoint)
-    mhlm_api_endpoint = "https://licensing.mathworks.com/mls/service/v1/entitlement/list"
+    mhlm_api_endpoint = (
+        "https://licensing.mathworks.com/mls/service/v1/entitlement/list"
+    )
     mhlm_api_endpoint_pattern = re.compile("^" + mhlm_api_endpoint)
 
     identity_token = secrets.token_urlsafe(324)
@@ -123,7 +125,9 @@ def mock_aiohttp_client_session():
         yield m
 
 
-async def test_fetch_access_token(mwa_api_data, fetch_access_token_valid_json, mock_response):
+async def test_fetch_access_token(
+    mwa_api_data, fetch_access_token_valid_json, mock_response
+):
     """Test to check mw.fetch_access_token method returns valid json response.
 
     The mock_response fixture mocks the aiohttp.ClientSession().post() method to return a custom HTTP response.
@@ -224,7 +228,9 @@ def fetch_expand_token_valid_json_fixture():
     return json_data
 
 
-async def test_fetch_expand_token(mock_response, fetch_expand_token_valid_json, mwa_api_data):
+async def test_fetch_expand_token(
+    mock_response, fetch_expand_token_valid_json, mwa_api_data
+):
     """Test to check if mw.fetch_expand_token returns a correct json response
 
     mock_response is used to mock ClientSession.post method to return a HTTP Response containing a valid json response.
@@ -245,7 +251,9 @@ async def test_fetch_expand_token(mock_response, fetch_expand_token_valid_json,
         referenceId=json_data["referenceDetail"]["referenceId"],
     )
 
-    payload = dict(expirationDate=json_data["expirationDate"], referenceDetail=referenceDetail)
+    payload = dict(
+        expirationDate=json_data["expirationDate"], referenceDetail=referenceDetail
+    )
 
     mock_response.post(url_pattern, payload=payload)