Merge pull request #206 from basnijholt/pre-commit

Add pre-commit with various linters and static code checkers

Author: akhmerov

.github/workflows/pre-commit.yml

@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - uses: pre-commit/[email protected]

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
         include:
           - os: windows-latest
             python-version: 3.7
-    
+
     runs-on: ${{ matrix.os }}
 
     steps:

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: "https://gitlab.com/pycqa/flake8/"
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+  - repo: "https://github.com/ambv/black"
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: "https://github.com/PyCQA/isort"
+    rev: 5.10.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.34.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py36-plus"]

doc/Makefile

@@ -23,4 +23,4 @@ html-strict:
 	@$(SPHINXBUILD) -b html -nW --keep-going "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
 
 clean:
-	rm -r $(BUILDDIR)
+	rm -r $(BUILDDIR)

doc/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -11,7 +10,7 @@
 
 sys.path.insert(0, os.path.abspath("../.."))
 
-import jupyter_sphinx
+import jupyter_sphinx  # noqa: E402
 
 project = "Jupyter Sphinx"
 copyright = "2019, Jupyter Development Team"
@@ -35,4 +34,4 @@
 
 jupyter_sphinx_thebelab_config = {"binderOptions": {"repo": "jupyter/jupyter-sphinx"}}
 
-latex_engine = 'xelatex'
+latex_engine = "xelatex"

doc/source/index.rst

@@ -325,7 +325,7 @@ When showing code samples that are computationally expensive, access restricted
       def slow_print(str):
           time.sleep(4000)    # Simulate an expensive process
           print(str)
-    
+
       slow_print("hello, world!")
 
   .. jupyter-output::
@@ -373,7 +373,7 @@ Downloading the code as a script
 
 Jupyter Sphinx includes 2 roles that can be used to download the code embedded in a document:
 ``:jupyter-download:script:`` (for a raw script file) and ``:jupyter-download:notebook:`` or ``:jupyter-download:nb:`` (for
-a Jupyter notebook). 
+a Jupyter notebook).
 
 These roles are equivalent to the standard sphinx `download role <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-download>`__, **except** the extension of the file should not be given.
 For example, to download all the code from this document as a script we

jupyter_sphinx/__init__.py

@@ -1,31 +1,31 @@
 """Simple sphinx extension that executes code in jupyter and inserts output."""
 
-from ._version import version_info, __version__
-from sphinx.util import logging
+from pathlib import Path
+
 import docutils
 import ipywidgets
-import os
-from sphinx.util.fileutil import copy_asset
+from IPython.lib.lexers import IPython3Lexer, IPythonTracebackLexer
 from sphinx.errors import ExtensionError
-from IPython.lib.lexers import IPythonTracebackLexer, IPython3Lexer
-from pathlib import Path
+from sphinx.util import logging
+from sphinx.util.fileutil import copy_asset
 
+from ._version import __version__
 from .ast import (
-    JupyterCell,
-    JupyterCellNode,
+    WIDGET_VIEW_MIMETYPE,
     CellInput,
     CellInputNode,
     CellOutput,
     CellOutputNode,
-    MimeBundleNode,
+    CombineCellInputOutput,
+    JupyterCell,
+    JupyterCellNode,
+    JupyterDownloadRole,
     JupyterKernelNode,
-    JupyterWidgetViewNode,
     JupyterWidgetStateNode,
-    WIDGET_VIEW_MIMETYPE,
-    JupyterDownloadRole,
-    CombineCellInputOutput,
+    JupyterWidgetViewNode,
+    MimeBundleNode,
 )
-from .execute import JupyterKernel, ExecuteJupyterCells
+from .execute import ExecuteJupyterCells, JupyterKernel
 from .thebelab import ThebeButton, ThebeButtonNode, ThebeOutputNode, ThebeSourceNode
 
 REQUIRE_URL_DEFAULT = (
@@ -35,21 +35,20 @@
 
 logger = logging.getLogger(__name__)
 
-##############################################################################
 # Constants and functions we'll use later
 
 # Used for nodes that do not need to be rendered
+
+
 def skip(self, node):
     raise docutils.nodes.SkipNode
 
 
 # Used for nodes that should be gone by rendering time (OutputMimeBundleNode)
 def halt(self, node):
     raise ExtensionError(
-        (
-            "Rendering encountered a node type that should "
-            "have been removed before rendering: %s" % type(node)
-        )
+        "Rendering encountered a node type that should "
+        "have been removed before rendering: %s" % type(node)
     )
 
 
@@ -59,6 +58,7 @@ def halt(self, node):
     lambda self, node: self.depart_container(node),
 )
 
+
 # Used to render the container and its children as HTML
 def visit_container_html(self, node):
     self.body.append(node.visit_html())
@@ -89,7 +89,7 @@ def visit_thebe_source(self, node):
     lambda self, node: self.depart_container(node),
 )
 
-##############################################################################
+
 # Sphinx callback functions
 def builder_inited(app):
     """

jupyter_sphinx/_version.py

@@ -2,7 +2,7 @@
 
 _specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
 
-__version__ = "%s.%s.%s%s" % (
+__version__ = "{}.{}.{}{}".format(
     version_info[0],
     version_info[1],
     version_info[2],

jupyter_sphinx/ast.py

@@ -1,25 +1,21 @@
 """Manipulating the Sphinx AST with Jupyter objects"""
 
-import os
 import json
-import contextlib
 from pathlib import Path
 
 import docutils
+import ipywidgets.embed
+import nbconvert
+from docutils.nodes import literal, math_block
 from docutils.parsers.rst import Directive, directives
-from docutils.nodes import math_block, image, literal
-from sphinx.util import parselinenos
-from sphinx.util.docutils import ReferenceRole
 from sphinx.addnodes import download_reference
-from sphinx.transforms import SphinxTransform
-from sphinx.environment.collectors.asset import ImageCollector
 from sphinx.errors import ExtensionError
+from sphinx.transforms import SphinxTransform
+from sphinx.util import parselinenos
+from sphinx.util.docutils import ReferenceRole
 
-import ipywidgets.embed
-import nbconvert
-
-from .utils import strip_latex_delimiters, sphinx_abs_dir
-from .thebelab import ThebeSourceNode, ThebeOutputNode
+from .thebelab import ThebeOutputNode, ThebeSourceNode
+from .utils import sphinx_abs_dir, strip_latex_delimiters
 
 WIDGET_VIEW_MIMETYPE = "application/vnd.jupyter.widget-view+json"
 WIDGET_STATE_MIMETYPE = "application/vnd.jupyter.widget-state+json"
@@ -45,8 +41,8 @@ def load_content(cell, location, logger):
         try:
             with Path(filename).open() as f:
                 content = [line.rstrip() for line in f.readlines()]
-        except (IOError, OSError):
-            raise IOError("File {} not found or reading it failed".format(filename))
+        except OSError:
+            raise OSError(f"File {filename} not found or reading it failed")
     else:
         cell.assert_has_content()
         content = cell.content
@@ -165,6 +161,7 @@ def run(self):
         cell_node += cell_input
         return [cell_node]
 
+
 class CellInput(Directive):
     """Define a code cell to be included verbatim but not executed.
 
@@ -182,7 +179,7 @@ class CellInput(Directive):
         specified line.
     emphasize-lines : comma separated list of line numbers
         If provided, the specified lines will be highlighted.
-    
+
     Content
     -------
     code : str
@@ -235,6 +232,7 @@ def run(self):
         cell_node += cell_input
         return [cell_node]
 
+
 class CellOutput(Directive):
     """Define an output cell to be included verbatim.
 
@@ -328,14 +326,14 @@ def render_as(self, visitor):
         try:
             # Or should we go to config via the node?
             priority = visitor.builder.env.app.config[
-                'render_priority_' + visitor.builder.format
+                "render_priority_" + visitor.builder.format
             ]
         except (AttributeError, KeyError):
             # Not sure what do to, act as a container and show everything just in case.
             return super()
         for mimetype in priority:
             try:
-                return self.children[self.attributes['mimetypes'].index(mimetype)]
+                return self.children[self.attributes["mimetypes"].index(mimetype)]
             except ValueError:
                 pass
         # Same
@@ -388,19 +386,19 @@ def __init__(self, rawsource="", *children, **attributes):
         super().__init__("", state=attributes["state"])
 
     def html(self):
-        
-        # escape </script> to avoid early closing of the tag in the html page 
+
+        # escape </script> to avoid early closing of the tag in the html page
         json_data = json.dumps(self["state"]).replace("</script>", r"<\/script>")
-        
+
         # TODO: render into a separate file if 'html-manager' starts fully
         #       parsing script tags, and not just grabbing their innerHTML
         # https://github.com/jupyter-widgets/ipywidgets/blob/master/packages/html-manager/src/libembed.ts#L36
         return ipywidgets.embed.snippet_template.format(
             load="", widget_views="", json_data=json_data
         )
 
-def cell_output_to_nodes(outputs, write_stderr, out_dir,
-                         thebe_config, inline=False):
+
+def cell_output_to_nodes(outputs, write_stderr, out_dir, thebe_config, inline=False):
     """Convert a jupyter cell with outputs and filenames to doctree nodes.
 
     Parameters
@@ -476,11 +474,8 @@ def cell_output_to_nodes(outputs, write_stderr, out_dir,
             )
         elif output_type in ("display_data", "execute_result"):
             children_by_mimetype = {
-                mime_type: output2sphinx(
-                    data, mime_type, output["metadata"], out_dir
-                )
+                mime_type: output2sphinx(data, mime_type, output["metadata"], out_dir)
                 for mime_type, data in output["data"].items()
-
             }
             # Filter out unknown mimetypes
             # TODO: rewrite this using walrus once we depend on Python 3.8
@@ -489,11 +484,13 @@ def cell_output_to_nodes(outputs, write_stderr, out_dir,
                 for mime_type, node in children_by_mimetype.items()
                 if node is not None
             }
-            to_add.append(MimeBundleNode(
-                "",
-                *list(children_by_mimetype.values()),
-                mimetypes=list(children_by_mimetype.keys())
-            ))
+            to_add.append(
+                MimeBundleNode(
+                    "",
+                    *list(children_by_mimetype.values()),
+                    mimetypes=list(children_by_mimetype.keys()),
+                )
+            )
 
     return to_add
 
@@ -552,7 +549,7 @@ def output2sphinx(data, mime_type, metadata, out_dir, inline=False):
         uri = (out_dir / filename).as_posix()
         return docutils.nodes.image(uri=uri)
     else:
-        logger.debug(f'Unknown mime type in cell output: {mime_type}')
+        logger.debug(f"Unknown mime type in cell output: {mime_type}")
 
 
 def apply_styling(node, thebe_config):
@@ -621,14 +618,14 @@ def apply(self):
         moved_outputs = set()
 
         for cell_node in self.document.traverse(JupyterCellNode):
-            if cell_node.attributes["execute"] == False:
-                if cell_node.attributes["hide_code"] == False:
+            if not cell_node.attributes["execute"]:
+                if not cell_node.attributes["hide_code"]:
                     # Cell came from jupyter-input
                     sibling = cell_node.next_node(descend=False, siblings=True)
                     if (
                         isinstance(sibling, JupyterCellNode)
-                        and sibling.attributes["execute"] == False
-                        and sibling.attributes["hide_code"] == True
+                        and not sibling.attributes["execute"]
+                        and sibling.attributes["hide_code"]
                     ):
                         # Sibling came from jupyter-output, so we merge
                         cell_node += sibling.children[1]