Add more linting (#369)

Author: blink1073

.pre-commit-config.yaml

@@ -36,7 +36,7 @@ repos:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.206
+    rev: v0.0.236
     hooks:
       - id: ruff
         args: ["--fix"]

jupyterlab_server/config.py

@@ -321,7 +321,8 @@ def _get_config_manager(level):
     """
     allowed = ["all", "user", "sys_prefix", "system", "app", "extension"]
     if level not in allowed:
-        raise ValueError(f"Page config level must be one of: {allowed}")
+        msg = f"Page config level must be one of: {allowed}"
+        raise ValueError(msg)
 
     config_name = "labconfig"
 

jupyterlab_server/licenses_handler.py

@@ -85,7 +85,8 @@ def report(self, report_format, bundles_pattern, full_text):
                 "text/markdown",
             )
 
-        raise ValueError(f"Unsupported report format {report_format}.")
+        msg = f"Unsupported report format {report_format}."
+        raise ValueError(msg)
 
     def report_json(self, bundles):
         """create a JSON report
@@ -97,7 +98,7 @@ def report_csv(self, bundles):
         """create a CSV report"""
         outfile = io.StringIO()
         fieldnames = ["name", "versionInfo", "licenseId", "extractedText"]
-        writer = csv.DictWriter(outfile, fieldnames=["bundle"] + fieldnames)
+        writer = csv.DictWriter(outfile, fieldnames=["bundle", *fieldnames])
         writer.writeheader()
         for bundle_name, bundle in bundles.items():
             for package in bundle["packages"]:

jupyterlab_server/process.py

@@ -85,10 +85,12 @@ def __init__(self, cmd, logger=None, cwd=None, kill_event=None, env=None, quiet=
             Whether to suppress output.
         """
         if not isinstance(cmd, (list, tuple)):
-            raise ValueError("Command must be given as a list")
+            msg = "Command must be given as a list"
+            raise ValueError(msg)
 
         if kill_event and kill_event.is_set():
-            raise ValueError("Process aborted")
+            msg = "Process aborted"
+            raise ValueError(msg)
 
         self.logger = logger or self.get_log()
         self._last_line = ""
@@ -143,7 +145,8 @@ def wait(self):
         while proc.poll() is None:
             if kill_event.is_set():
                 self.terminate()
-                raise ValueError("Process was aborted")
+                msg = "Process was aborted"
+                raise ValueError(msg)
             time.sleep(1.0)
         return self.terminate()
 
@@ -155,7 +158,8 @@ def wait_async(self):
         while proc.poll() is None:
             if kill_event.is_set():
                 self.terminate()
-                raise ValueError("Process was aborted")
+                msg = "Process was aborted"
+                raise ValueError(msg)
             yield gen.sleep(1.0)
 
         raise gen.Return(self.terminate())
@@ -218,7 +222,8 @@ def __init__(self, cmd, startup_regex, logger=None, cwd=None, kill_event=None, e
         while 1:
             line = self._stdout.readline().decode("utf-8")
             if not line:
-                raise RuntimeError("Process ended improperly")
+                msg = "Process ended improperly"
+                raise RuntimeError(msg)
             print(line.rstrip())  # noqa
             if re.match(startup_regex, line):
                 break

jupyterlab_server/test_utils.py

@@ -42,7 +42,8 @@ def __init__(self, request: HTTPRequest, spec: Spec):
         self.request = request
         self.spec = spec
         if request.url is None:
-            raise RuntimeError("Request URL is missing")
+            msg = "Request URL is missing"
+            raise RuntimeError(msg)
         self._url_parsed = urlparse(request.url)
 
         cookie: SimpleCookie = SimpleCookie()
@@ -90,7 +91,8 @@ def path(self) -> str:
                     url = u[: len(path)] + r"foo"
 
         if url is None:
-            raise ValueError(f"Could not find matching pattern for {o.path}")
+            msg = f"Could not find matching pattern for {o.path}"
+            raise ValueError(msg)
         return url
 
     @property
@@ -103,7 +105,8 @@ def body(self) -> Optional[str]:
         if self.request.body is None:
             return None
         if not isinstance(self.request.body, bytes):
-            raise AssertionError('Request body is invalid')
+            msg = 'Request body is invalid'
+            raise AssertionError(msg)
         return self.request.body.decode("utf-8")
 
     @property
@@ -128,7 +131,8 @@ def __init__(self, response: HTTPResponse):
     @property
     def data(self) -> str:
         if not isinstance(self.response.body, bytes):
-            raise AssertionError('Response body is invalid')
+            msg = 'Response body is invalid'
+            raise AssertionError(msg)
         return self.response.body.decode("utf-8")
 
     @property
@@ -165,21 +169,23 @@ def validate_request(response):
 
 def maybe_patch_ioloop():
     """a windows 3.8+ patch for the asyncio loop"""
-    if sys.platform.startswith("win") and tornado.version_info < (6, 1):
-        if sys.version_info >= (3, 8):
-
-            try:
-                from asyncio import WindowsProactorEventLoopPolicy, WindowsSelectorEventLoopPolicy
-            except ImportError:
-                pass
-                # not affected
-            else:
-                from asyncio import get_event_loop_policy, set_event_loop_policy
-
-                if type(get_event_loop_policy()) is WindowsProactorEventLoopPolicy:
-                    # WindowsProactorEventLoopPolicy is not compatible with tornado 6
-                    # fallback to the pre-3.8 default of Selector
-                    set_event_loop_policy(WindowsSelectorEventLoopPolicy())
+    if (
+        sys.platform.startswith("win")
+        and tornado.version_info < (6, 1)
+        and sys.version_info >= (3, 8)
+    ):
+        try:
+            from asyncio import WindowsProactorEventLoopPolicy, WindowsSelectorEventLoopPolicy
+        except ImportError:
+            pass
+            # not affected
+        else:
+            from asyncio import get_event_loop_policy, set_event_loop_policy
+
+            if type(get_event_loop_policy()) is WindowsProactorEventLoopPolicy:
+                # WindowsProactorEventLoopPolicy is not compatible with tornado 6
+                # fallback to the pre-3.8 default of Selector
+                set_event_loop_policy(WindowsSelectorEventLoopPolicy())
 
 
 def expected_http_error(error, expected_code, expected_message=None):

jupyterlab_server/translation_utils.py

@@ -348,31 +348,30 @@ def get_language_pack(locale_: str) -> tuple:
     found_packages_locales, message = get_installed_packages_locale(locale_)
     locale_data = {}
     messages = message.split("\n")
-    if not message and is_valid_locale(locale_):
-        if locale_ in found_locales:
-            path = found_locales[locale_]
-            for root, __, files in os.walk(path, topdown=False):
-                for name in files:
-                    if name.endswith(".json"):
-                        pkg_name = name.replace(".json", "")
-                        json_path = os.path.join(root, name)
-                        try:
-                            with open(json_path, encoding="utf-8") as fh:
-                                merged_data = json.load(fh)
-                        except Exception:
-                            messages.append(traceback.format_exc())
-
-                        # Load packages with locale data and merge them
-                        if pkg_name in found_packages_locales:
-                            pkg_data = found_packages_locales[pkg_name]
-                            merged_data = merge_locale_data(merged_data, pkg_data)
-
-                        locale_data[pkg_name] = merged_data
-
-            # Check if package locales exist that do not exists in language pack
-            for pkg_name, data in found_packages_locales.items():
-                if pkg_name not in locale_data:
-                    locale_data[pkg_name] = data
+    if not message and is_valid_locale(locale_) and locale_ in found_locales:
+        path = found_locales[locale_]
+        for root, __, files in os.walk(path, topdown=False):
+            for name in files:
+                if name.endswith(".json"):
+                    pkg_name = name.replace(".json", "")
+                    json_path = os.path.join(root, name)
+                    try:
+                        with open(json_path, encoding="utf-8") as fh:
+                            merged_data = json.load(fh)
+                    except Exception:
+                        messages.append(traceback.format_exc())
+
+                    # Load packages with locale data and merge them
+                    if pkg_name in found_packages_locales:
+                        pkg_data = found_packages_locales[pkg_name]
+                        merged_data = merge_locale_data(merged_data, pkg_data)
+
+                    locale_data[pkg_name] = merged_data
+
+        # Check if package locales exist that do not exists in language pack
+        for pkg_name, data in found_packages_locales.items():
+            if pkg_name not in locale_data:
+                locale_data[pkg_name] = data
 
     return locale_data, "\n".join(messages)
 

jupyterlab_server/workspaces_app.py

@@ -175,14 +175,16 @@ def _validate(self, data):
         workspace = json.load(data)
 
         if "data" not in workspace:
-            raise Exception("The `data` field is missing.")
+            msg = "The `data` field is missing."
+            raise Exception(msg)
 
         # If workspace_name is set in config, inject the
         # name into the workspace metadata.
         if self.workspace_name is not None and self.workspace_name != "":
             workspace["metadata"] = {"id": self.workspace_name}
         else:
             if "id" not in workspace["metadata"]:
-                raise Exception("The `id` field is missing in `metadata`.")
+                msg = "The `id` field is missing in `metadata`."
+                raise Exception(msg)
 
         return workspace

jupyterlab_server/workspaces_handler.py

@@ -97,7 +97,8 @@ def __init__(self, path):
         """Initialize a workspaces manager with content in ``path``."""
         super()
         if not path:
-            raise ValueError("Workspaces directory is not set")
+            msg = "Workspaces directory is not set"
+            raise ValueError(msg)
         self.workspaces_dir = Path(path)
 
     def delete(self, space_name):
@@ -106,7 +107,8 @@ def delete(self, space_name):
         workspace_path = self.workspaces_dir / (slug + WORKSPACE_EXTENSION)
 
         if not workspace_path.exists():
-            raise FileNotFoundError(f"Workspace {space_name!r} ({slug!r}) not found")
+            msg = f"Workspace {space_name!r} ({slug!r}) not found"
+            raise FileNotFoundError(msg)
 
         # to delete the workspace file.
         workspace_path.unlink()

pyproject.toml

@@ -118,7 +118,7 @@ dependencies = [
   "black[jupyter]==22.12.0",
   "mdformat>0.7",
   "mdformat-gfm>=0.3.5",
-  "ruff==0.0.206"
+  "ruff==0.0.236"
 ]
 detatched = true
 [tool.hatch.envs.lint.scripts]
@@ -194,8 +194,31 @@ skip-string-normalization = true
 target-version = "py37"
 line-length = 100
 select = [
-  "A", "B", "C", "E", "F", "FBT", "I", "N", "Q", "RUF", "S", "T",
-  "UP", "W", "YTT",
+  "A",
+  "B",
+  "C",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "SIM",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
 ]
 ignore = [
 # Q000 Single quotes found but double quotes preferred
@@ -208,13 +231,17 @@ ignore = [
 "C408", "C416",
 # E501 Line too long (108 > 100 characters)
 "E501",
+# SIM105 Use `contextlib.suppress(...)`
+"SIM105",
 ]
 
 [tool.ruff.per-file-ignores]
 # S101 Use of `assert` detected
 # A001 Variable `id` is shadowing a python builtin
+# PLR2004 Magic value used in comparison
 # F841 Local variable `list_data` is assigned to but never used
-"tests/*" = ["S101", "A001", "F841"]
+# EM101 Exception must not use a string literal
+"tests/*" = ["S101", "A001", "F841", "EM101", "EM102", "EM103", "PLR2004"]
 # F401 `foo` imported but unused
 "jupyterlab_server/server.py" = ["F401"]