Add spell checking and enforce docstrings (#484)

blink1073 · pre-commit-ci[bot] · web-flow · commit b7a909f4cd62 · 2022-12-23T04:41:50.000-06:00
Co-authored-by: pre-commit-ci[bot] &lt;66853113+pre-commit-ci[bot]@users.noreply.github.com&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -24,7 +24,7 @@ jobs:
          run: |
           hatch run typing:test
           hatch run lint:style
-          pipx run 'validate-pyproject[all]' pyproject.toml
+          pipx run interrogate -v jupyter_releaser
           pipx run doc8 --max-line-length=200
 
   check_links:
@@ -114,7 +114,7 @@ jobs:
           hatch run test:nowarn || hatch run test:nowarn --lf
 
   docs:
-    runs-on: ubuntu-20.04
+    runs-on: windows-latest
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v3
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,17 +5,18 @@ 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 +37,7 @@ repos:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.185
+    rev: v0.0.189
     hooks:
       - id: ruff
         args: ["--fix"]
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -41,6 +41,13 @@
     "sphinx_click",
 ]
 
+try:
+    import enchant  # type:ignore  # noqa
+
+    extensions += ["sphinxcontrib.spelling"]
+except ImportError:
+    pass
+
 myst_enable_extensions = ["html_image"]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/jupyter_releaser/__main__.py b/jupyter_releaser/__main__.py
@@ -1,3 +1,4 @@
+"""The main entry point for Jupyter Releaser."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 from jupyter_releaser.cli import main
diff --git a/jupyter_releaser/actions/common.py b/jupyter_releaser/actions/common.py
@@ -1,3 +1,4 @@
+"""Common functions for actions."""
 from contextlib import contextmanager
 
 from jupyter_releaser.util import prepare_environment
@@ -6,16 +7,19 @@
 
 @contextmanager
 def make_group(name):
+    """Make a collapsed group in the GitHub Actions log."""
     print(f"::group::{name}")
     yield
     print("::endgroup::")
 
 
 def setup(fetch_draft_release=True):
+    """Common setup tasks for actions."""
     with make_group("Prepare Environment"):
         return prepare_environment(fetch_draft_release=fetch_draft_release)
 
 
 def run_action(target, *args, **kwargs):
+    """Run an action."""
     with make_group(target):
         _run(target, *args, **kwargs)
diff --git a/jupyter_releaser/actions/finalize_release.py b/jupyter_releaser/actions/finalize_release.py
@@ -1,3 +1,4 @@
+"""Finalize a release."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import os
diff --git a/jupyter_releaser/actions/generate_changelog.py b/jupyter_releaser/actions/generate_changelog.py
@@ -1,3 +1,4 @@
+"""Generate a changelog."""
 import os
 from pathlib import Path
 
diff --git a/jupyter_releaser/actions/populate_release.py b/jupyter_releaser/actions/populate_release.py
@@ -1,3 +1,4 @@
+"""Populate a release."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
diff --git a/jupyter_releaser/actions/prep_release.py b/jupyter_releaser/actions/prep_release.py
@@ -1,3 +1,4 @@
+"""Prepare a release."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import os
diff --git a/jupyter_releaser/changelog.py b/jupyter_releaser/changelog.py
@@ -1,3 +1,4 @@
+"""Changelog utilities for Jupyter Releaser."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import re
@@ -177,6 +178,7 @@ def build_entry(
 
 
 def update_changelog(changelog_path, entry):
+    """Update a changelog with a new entry."""
     # Get the new version
     version = util.get_version()
 
diff --git a/jupyter_releaser/cli.py b/jupyter_releaser/cli.py
@@ -1,3 +1,4 @@
+"""CLI for Jupyter Releaser."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import os
@@ -371,6 +372,7 @@ def bump_version(version_spec, version_cmd, changelog_path, python_packages):
 @add_options(release_url_options)
 @use_checkout_dir()
 def extract_changelog(dry_run, auth, changelog_path, release_url):
+    """Extract the changelog entry."""
     lib.extract_changelog(dry_run, auth, changelog_path, release_url)
 
 
@@ -554,6 +556,7 @@ def populate_release(
     post_version_message,
     assets,
 ):
+    """Populate a release."""
     lib.populate_release(
         ref,
         branch,
@@ -670,6 +673,7 @@ def publish_release(auth, dry_run, release_url):
 )
 @use_checkout_dir()
 def ensure_sha(ref, branch, repo, dry_run, expected_sha):
+    """Ensure that a sha has not changed."""
     util.ensure_sha(dry_run, expected_sha, branch)
 
 
diff --git a/jupyter_releaser/lib.py b/jupyter_releaser/lib.py
@@ -1,3 +1,4 @@
+"""Library functions for Jupyter Releaser."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import json
@@ -124,6 +125,7 @@ def draft_changelog(
 
 
 def make_changelog_pr(auth, branch, repo, title, commit_message, body, dry_run=False):
+    """Make a changelog PR."""
     repo = repo or util.get_repo()
     branch = branch or util.get_branch()
 
diff --git a/jupyter_releaser/mock_github.py b/jupyter_releaser/mock_github.py
@@ -1,3 +1,4 @@
+"""A mock GitHub API implementation."""
 import atexit
 import datetime
 import json
@@ -25,6 +26,7 @@
 
 
 def load_from_file(name, klass):
+    """Load data from a file to a model."""
     source_file = os.path.join(static_dir, name + ".json")
     if not os.path.exists(source_file):
         return {}
@@ -40,6 +42,7 @@ def load_from_file(name, klass):
 
 
 def write_to_file(name, data):
+    """Write model data to a file."""
     source_file = os.path.join(static_dir, name + ".json")
     result = {}
     for key in data:
@@ -52,6 +55,8 @@ def write_to_file(name, data):
 
 
 class Asset(BaseModel):
+    """An asset model."""
+
     id: int
     name: str
     content_type: str
@@ -68,6 +73,8 @@ class Asset(BaseModel):
 
 
 class Release(BaseModel):
+    """A release model."""
+
     assets_url: str = ""
     upload_url: str
     tarball_url: str = ""
@@ -89,22 +96,30 @@ class Release(BaseModel):
 
 
 class User(BaseModel):
+    """A user model."""
+
     login: str = "bar"
     html_url: str = "http://bar.com"
 
 
 class PullRequest(BaseModel):
+    """A pull request model."""
+
     number: int = 0
     html_url: str = "http://foo.com"
     title: str = "foo"
     user: User = User()
 
 
 class TagObject(BaseModel):
+    """A tab object model."""
+
     sha: str
 
 
 class Tag(BaseModel):
+    """A tag model."""
+
     ref: str
     object: TagObject
 
@@ -117,6 +132,7 @@ class Tag(BaseModel):
 
 @app.get("/")
 def read_root():
+    """Get the root handler."""
     return {"Hello": "World"}
 
 
diff --git a/jupyter_releaser/npm.py b/jupyter_releaser/npm.py
@@ -1,3 +1,4 @@
+"""npm-related utilities."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import json
diff --git a/jupyter_releaser/python.py b/jupyter_releaser/python.py
@@ -1,3 +1,4 @@
+"""Python-related utilities."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import atexit
diff --git a/jupyter_releaser/util.py b/jupyter_releaser/util.py
@@ -1,7 +1,6 @@
+"""Jupyter Releaser Utils."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-# Of the form:
-# https://github.com/{owner}/{repo}/releases/tag/{tag}
 import atexit
 import hashlib
 import json
@@ -534,6 +533,7 @@ def upload_assets(gh, assets, release, auth):
 
 
 def extract_metadata_from_release_url(gh, release_url, auth):
+    """Extract the metadata for a release given a url."""
     log(f"Extracting metadata for release: {release_url}")
     release = release_for_url(gh, release_url)
 
@@ -701,6 +701,7 @@ def get_remote_name(dry_run):
 
 
 def get_mock_github_url():
+    """Get the mock github url."""
     port = os.environ.get("MOCK_GITHUB_PORT", "8000")
     return f"http://127.0.0.1:{port}"
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,6 +49,7 @@ docs = [
   "pip",
   "myst-parser",
   "pydata_sphinx_theme",
+  "sphinxcontrib_spelling",
   "numpydoc",
   "sphinx-click",
 ]
@@ -99,7 +100,7 @@ dependencies = [
   "black==22.10.0",
   "mdformat>0.7",
   "mdformat-gfm>=0.3.5",
-  "ruff==0.0.185"
+  "ruff==0.0.189"
 ]
 detached = true
 [tool.hatch.envs.lint.scripts]
@@ -232,3 +233,13 @@ unfixable = [
 # B007 Loop control variable `i` not used within the loop body.
 # N802 Function name `assertIn` should be lowercase
 "jupyter_releaser/tests/*" = ["B011", "F841", "C408", "E402", "T201", "B007", "N802"]
+
+[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 = ["jupyter_releaser/tests"]

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""The main entry point for Jupyter Releaser."""`
`1`	`2`	`# Copyright (c) Jupyter Development Team.`
`2`	`3`	`# Distributed under the terms of the Modified BSD License.`
`3`	`4`	`from jupyter_releaser.cli import main`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""Finalize a release."""`
`1`	`2`	`# Copyright (c) Jupyter Development Team.`
`2`	`3`	`# Distributed under the terms of the Modified BSD License.`
`3`	`4`	`import os`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""Generate a changelog."""`
`1`	`2`	`import os`
`2`	`3`	`from pathlib import Path`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""Populate a release."""`
`1`	`2`	`# Copyright (c) Jupyter Development Team.`
`2`	`3`	`# Distributed under the terms of the Modified BSD License.`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""Prepare a release."""`
`1`	`2`	`# Copyright (c) Jupyter Development Team.`
`2`	`3`	`# Distributed under the terms of the Modified BSD License.`
`3`	`4`	`import os`