Add spelling and docstring enforcement (#358)

blink1073 · web-flow · commit dfd340fc754c · 2022-12-23T06:32:59.000-06:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -55,11 +55,11 @@ jobs:
          run: |
           hatch run typing:test
           hatch run lint:style
-          pipx run 'validate-pyproject[all]' pyproject.toml
+          pipx run interrogate -v .
           pipx run doc8 --max-line-length=200
 
   docs:
-    runs-on: ubuntu-latest
+    runs-on: windows-latest
     steps:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,17 +5,17 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
-      - id: end-of-file-fixer
       - id: check-case-conflict
+      - id: check-ast
+      - id: check-docstring-first
       - id: check-executables-have-shebangs
-      - id: requirements-txt-fixer
       - id: check-added-large-files
       - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-json
       - id: check-toml
       - id: check-yaml
-      - id: debug-statements
-      - id: forbid-new-submodules
-      - id: check-builtin-literals
+      - id: end-of-file-fixer
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
@@ -36,7 +36,7 @@ repos:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.165
+    rev: v0.0.189
     hooks:
       - id: ruff
         args: ["--fix"]
diff --git a/jupyterlab_server/__main__.py b/jupyterlab_server/__main__.py
@@ -1,3 +1,4 @@
+"""CLI entry point for jupyterlab server."""
 import sys
 
 from jupyterlab_server.app import main
diff --git a/jupyterlab_server/app.py b/jupyterlab_server/app.py
@@ -98,10 +98,12 @@ def _deprecated_trait(self, change):
             setattr(self, new_attr, change.new)
 
     def initialize_templates(self):
+        """Initialize templates."""
         self.static_paths = [self.static_dir]
         self.template_paths = [self.templates_dir]
 
     def initialize_handlers(self):
+        """Initialize handlers."""
         add_handlers(self.handlers, self)
 
 
diff --git a/jupyterlab_server/handlers.py b/jupyterlab_server/handlers.py
@@ -157,8 +157,11 @@ def get(self, mode=None, workspace=None, tree=None):
 
 
 class NotFoundHandler(LabHandler):
+    """A handler for page not found."""
+
     @lru_cache()  # noqa
     def get_page_config(self):
+        """Get the page config."""
         page_config = super().get_page_config()
         page_config["notFoundUrl"] = self.request.path
         return page_config
diff --git a/jupyterlab_server/licenses_app.py b/jupyterlab_server/licenses_app.py
@@ -30,6 +30,8 @@ class MyApp(JupyterApp, LabConfig):
 
 
 class LicensesApp(JupyterApp, LabConfig):
+    """A license management app."""
+
     version = __version__
 
     description = """
@@ -71,15 +73,18 @@ class LicensesApp(JupyterApp, LabConfig):
     }
 
     def initialize(self, *args, **kwargs):
+        """Initialize the app."""
         super().initialize(*args, **kwargs)
         self.init_licenses_manager()
 
     def init_licenses_manager(self):
+        """Initialize the license manager."""
         self.licenses_manager = LicensesManager(
             parent=self,
         )
 
     def start(self):
+        """Start the app."""
         report = self.licenses_manager.report(
             report_format=self.report_format,
             full_text=self.full_text,
diff --git a/jupyterlab_server/licenses_handler.py b/jupyterlab_server/licenses_handler.py
@@ -234,6 +234,7 @@ class LicensesHandler(APIHandler):
     """A handler for serving licenses used by the application"""
 
     def initialize(self, manager: LicensesManager) -> None:
+        """Initialize the handler."""
         super().initialize()
         self.manager = manager
 
diff --git a/jupyterlab_server/process.py b/jupyterlab_server/process.py
@@ -27,6 +27,7 @@
 else:
 
     def list2cmdline(cmd_list):
+        """Shim for list2cmdline on posix."""
         import shlex
 
         return " ".join(map(shlex.quote, cmd_list))
@@ -179,6 +180,7 @@ def _cleanup(cls):
             proc.terminate()
 
     def get_log(self):
+        """Get our logger."""
         if hasattr(self, "logger") and self.logger:
             return self.logger
         # fallback logger
diff --git a/jupyterlab_server/process_app.py b/jupyterlab_server/process_app.py
@@ -27,6 +27,7 @@ def initialize_settings(self):
         IOLoop.current().add_callback(self._run_command)
 
     def initialize_handlers(self):
+        """Initialize the handlers."""
         add_handlers(self.handlers, self)
 
     def _run_command(self):
diff --git a/jupyterlab_server/pytest_plugin.py b/jupyterlab_server/pytest_plugin.py
@@ -1,3 +1,4 @@
+"""pytest fixtures."""
 import json
 import os
 import os.path as osp
@@ -12,6 +13,7 @@
 
 
 def mkdir(tmp_path, *parts):
+    """Util for making a directory."""
     path = tmp_path.joinpath(*parts)
     if not path.exists():
         path.mkdir(parents=True)
@@ -37,8 +39,10 @@ def make_labserver_extension_app(
     workspaces_dir,
     labextensions_dir,
 ):
-    def _make_labserver_extension_app(**kwargs):
+    """Return a factory function for a labserver extension app."""
 
+    def _make_labserver_extension_app(**kwargs):
+        """Factory function for lab server extension apps."""
         return LabServerApp(
             static_dir=str(jp_root_dir),
             templates_dir=str(jp_template_dir),
@@ -127,6 +131,7 @@ def _make_labserver_extension_app(**kwargs):
 
 @pytest.fixture
 def labserverapp(jp_serverapp, make_labserver_extension_app):
+    """A lab server app."""
     app = make_labserver_extension_app()
     app._link_jupyter_server_extension(jp_serverapp)
     app.initialize()
diff --git a/jupyterlab_server/server.py b/jupyterlab_server/server.py
@@ -1,3 +1,4 @@
+"""Server api."""
 from jupyter_server import _tz as tz  # noqa
 from jupyter_server.base.handlers import (
     APIHandler,
diff --git a/jupyterlab_server/settings_handler.py b/jupyterlab_server/settings_handler.py
@@ -13,9 +13,12 @@
 
 
 class SettingsHandler(ExtensionHandlerMixin, ExtensionHandlerJinjaMixin, SchemaHandler):
+    """A settings API handler."""
+
     def initialize(
         self, name, app_settings_dir, schemas_dir, settings_dir, labextensions_path, **kwargs
     ):
+        """Initialize the handler."""
         SchemaHandler.initialize(
             self, app_settings_dir, schemas_dir, settings_dir, labextensions_path
         )
diff --git a/jupyterlab_server/settings_utils.py b/jupyterlab_server/settings_utils.py
@@ -419,6 +419,7 @@ class SchemaHandler(APIHandler):
     """Base handler for handler requiring access to settings."""
 
     def initialize(self, app_settings_dir, schemas_dir, settings_dir, labextensions_path, **kwargs):
+        """Initialize the handler."""
         super().initialize(**kwargs)
         self.overrides, error = _get_overrides(app_settings_dir)
         self.app_settings_dir = app_settings_dir
diff --git a/jupyterlab_server/spec.py b/jupyterlab_server/spec.py
@@ -1,3 +1,4 @@
+"""OpenAPI spec utils."""
 import os
 from pathlib import Path
 
diff --git a/jupyterlab_server/test_utils.py b/jupyterlab_server/test_utils.py
@@ -1,3 +1,4 @@
+"""Testing utils."""
 import json
 import os
 import sys
diff --git a/jupyterlab_server/themes_handler.py b/jupyterlab_server/themes_handler.py
@@ -25,7 +25,7 @@ def initialize(
         labextensions_path=None,
         **kwargs,
     ):
-
+        """Initialize the handler."""
         # Get all of the available theme paths in order
         labextensions_path = labextensions_path or []
         ext_paths = []
diff --git a/jupyterlab_server/translation_utils.py b/jupyterlab_server/translation_utils.py
@@ -411,6 +411,7 @@ class TranslationBundle:
     """
 
     def __init__(self, domain: str, locale: str):
+        """Initialize the bundle."""
         self._domain = domain
         self._locale = locale
 
diff --git a/jupyterlab_server/translations_handler.py b/jupyterlab_server/translations_handler.py
@@ -1,9 +1,8 @@
-# Copyright (c) Jupyter Development Team.
-# Distributed under the terms of the Modified BSD License.
-
 """
 Translation handler.
 """
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import json
 import traceback
@@ -16,6 +15,8 @@
 
 
 class TranslationsHandler(SchemaHandler):
+    """Translation handler."""
+
     @gen.coroutine
     @tornado.web.authenticated
     def get(self, locale=""):
diff --git a/jupyterlab_server/workspaces_app.py b/jupyterlab_server/workspaces_app.py
@@ -17,6 +17,8 @@
 
 
 class WorkspaceListApp(JupyterApp, LabConfig):
+    """An app to list workspaces."""
+
     version = __version__
     description = """
     Print all the workspaces available
@@ -54,10 +56,12 @@ class WorkspaceListApp(JupyterApp, LabConfig):
     )
 
     def initialize(self, *args, **kwargs):
+        """Initialize the app."""
         super().initialize(*args, **kwargs)
         self.manager = WorkspacesManager(self.workspaces_dir)
 
     def start(self):
+        """Start the app."""
         workspaces = self.manager.list_workspaces()
         if self.jsonlines:
             for workspace in workspaces:
@@ -70,6 +74,8 @@ def start(self):
 
 
 class WorkspaceExportApp(JupyterApp, LabConfig):
+    """A workspace export app."""
+
     version = __version__
     description = """
     Export a JupyterLab workspace
@@ -81,10 +87,12 @@ class WorkspaceExportApp(JupyterApp, LabConfig):
     """
 
     def initialize(self, *args, **kwargs):
+        """Initialize the app."""
         super().initialize(*args, **kwargs)
         self.manager = WorkspacesManager(self.workspaces_dir)
 
     def start(self):
+        """Start the app."""
         if len(self.extra_args) > 1:  # pragma: no cover
             warnings.warn("Too many arguments were provided for workspace export.")
             self.exit(1)
@@ -98,6 +106,8 @@ def start(self):
 
 
 class WorkspaceImportApp(JupyterApp, LabConfig):
+    """A workspace import app."""
+
     version = __version__
     description = """
     Import a JupyterLab workspace
@@ -119,11 +129,12 @@ class WorkspaceImportApp(JupyterApp, LabConfig):
     aliases = {"name": "WorkspaceImportApp.workspace_name"}
 
     def initialize(self, *args, **kwargs):
+        """Initialize the app."""
         super().initialize(*args, **kwargs)
         self.manager = WorkspacesManager(self.workspaces_dir)
 
     def start(self):
-
+        """Start the app."""
         if len(self.extra_args) != 1:  # pragma: no cover
             self.log.info("One argument is required for workspace import.")
             self.exit(1)
diff --git a/jupyterlab_server/workspaces_handler.py b/jupyterlab_server/workspaces_handler.py
@@ -164,7 +164,10 @@ def save(self, space_name: str, raw: str) -> Path:
 
 
 class WorkspacesHandler(ExtensionHandlerMixin, ExtensionHandlerJinjaMixin, APIHandler):
+    """A workspaces API handler."""
+
     def initialize(self, name, manager: WorkspacesManager, **kwargs) -> None:  # type:ignore
+        """Initialize the handler."""
         super().initialize(name)
         self.manager = manager
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,7 @@ test = [
   # openapi_core 0.15.0 alpha is not working
   "openapi_core~=0.14.2",
   "openapi-spec-validator<0.6",
+  "sphinxcontrib_spelling",
   "requests_mock",
   "pytest>=7.0",
   "pytest-console-scripts",
@@ -81,13 +82,6 @@ test = [
   "ruamel.yaml",
   "strict-rfc3339"
 ]
-lint = [
-  "black[jupyter]>=22.6.0",
-  "mdformat>0.7",
-  "mdformat-gfm>=0.3.5",
-  "ruff>=0.0.156"
-]
-typing = ["mypy>=0.990"]
 
 [tool.hatch.version]
 path = "jupyterlab_server/_version.py"
@@ -112,12 +106,19 @@ test = "python -m pytest -vv --cov jupyterlab_server --cov-branch --cov-report t
 nowarn = "test -W default {args}"
 
 [tool.hatch.envs.typing]
-features = ["typing", "test"]
+features = ["test"]
+dependencies = ["mypy>=0.990"]
 [tool.hatch.envs.typing.scripts]
 test = "mypy --install-types --non-interactive {args:jupyterlab_server tests}"
 
 [tool.hatch.envs.lint]
-features = ["lint"]
+dependencies = [
+  "black[jupyter]==22.6.0",
+  "mdformat>0.7",
+  "mdformat-gfm>=0.3.5",
+  "ruff==0.0.189"
+]
+detatched = true
 [tool.hatch.envs.lint.scripts]
 style = [
   "ruff {args:.}",
@@ -215,3 +216,13 @@ ignore = [
 "tests/*" = ["S101", "A001", "F841"]
 # F401 `foo` imported but unused
 "jupyterlab_server/server.py" = ["F401"]
+
+[tool.interrogate]
+ignore-init-module=true
+ignore-private=true
+ignore-semiprivate=true
+ignore-property-decorators=true
+ignore-nested-functions=true
+ignore-nested-classes=true
+fail-under=100
+exclude = ["tests", "docs"]

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""CLI entry point for jupyterlab server."""`
`1`	`2`	`import sys`
`2`	`3`
`3`	`4`	`from jupyterlab_server.app import main`