Merge pull request #8 from blink1073/pre-commit

Author: blink1073

.pre-commit-config.yaml

@@ -1,21 +1,69 @@
+ci:
+  skip: [check-jsonschema]
+
 repos:
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
     hooks:
-      - id: reorder-python-imports
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: forbid-new-submodules
+      - id: check-builtin-literals
+      - id: trailing-whitespace
+
   - repo: https://github.com/psf/black
     rev: 22.3.0
     hooks:
       - id: black
         args: ["--line-length", "100"]
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: "3.9.2"
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        files: \.py$
+        args: [--profile=black]
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.6.1
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.11.0
+    hooks:
+      - id: doc8
+        args: [--max-line-length=200]
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
     hooks:
       - id: flake8
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+        additional_dependencies:
+          [
+            "flake8-bugbear==20.1.4",
+            "flake8-logging-format==0.6.0",
+            "flake8-implicit-str-concat==0.2.0",
+          ]
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.14.1
     hooks:
-      - id: end-of-file-fixer
-      - id: check-case-conflict
-      - id: check-executables-have-shebangs
-      - id: requirements-txt-fixer
+      - id: check-jsonschema
+        name: "Check GitHub Workflows"
+        files: ^\.github/workflows/
+        types: [yaml]
+        args: ["--schemafile", "https://json.schemastore.org/github-workflow"]

docs/source/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # Jupyter Server documentation build configuration file, created by
 # sphinx-quickstart on Mon Apr 13 09:51:11 2015.
@@ -269,16 +268,7 @@
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
-    # Latex figure (float) alignment
-    #'figure_align': 'htbp',
-}
+latex_elements = {}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
@@ -328,7 +318,7 @@
 
 # -- Options for link checks ----------------------------------------------
 
-linkcheck_ignore = ["http://127\.0\.0\.1/*"]
+linkcheck_ignore = [r"http://127\.0\.0\.1/*"]
 
 
 # -- Options for Texinfo output -------------------------------------------

jupyter-config/jupyter_server_terminals.json

@@ -1,7 +1,7 @@
 {
-    "ServerApp": {
-        "jpserver_extensions": {
-            "jupyter_server_terminals": true
-        }
+  "ServerApp": {
+    "jpserver_extensions": {
+      "jupyter_server_terminals": true
     }
+  }
 }

jupyter_server_terminals/app.py

@@ -4,23 +4,13 @@
 
 from traitlets import Type
 
-from . import api_handlers
-from . import handlers
+from . import api_handlers, handlers
 from .terminalmanager import TerminalManager
 
 try:
     from jupyter_server.extension.application import ExtensionApp
-    from jupyter_server.utils import run_sync_in_loop
     from jupyter_server.transutils import trans
-
-    # Tolerate missing terminado package.
-    try:
-        from .terminalmanager import TerminalManager
-
-        terminado_available = True
-    except ImportError:
-        terminado_available = False
-
+    from jupyter_server.utils import run_sync_in_loop
 except ModuleNotFoundError:
     raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
 
@@ -44,9 +34,7 @@ class TerminalsExtensionApp(ExtensionApp):
 
     def initialize_settings(self):
         self.initialize_configurables()
-        self.settings.update(
-            dict(terminals_available=terminado_available, terminal_manager=self.terminal_manager)
-        )
+        self.settings.update(dict(terminals_available=True, terminal_manager=self.terminal_manager))
 
     def initialize_configurables(self):
         if os.name == "nt":

jupyter_server_terminals/handlers.py

@@ -1,4 +1,3 @@
-# encoding: utf-8
 """Tornado handlers for the terminal emulator."""
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
@@ -27,14 +26,14 @@ def get(self, *args, **kwargs):
             raise web.HTTPError(403)
         if not args[0] in self.term_manager.terminals:
             raise web.HTTPError(404)
-        return super(TermSocket, self).get(*args, **kwargs)
+        return super().get(*args, **kwargs)
 
     def on_message(self, message):
-        super(TermSocket, self).on_message(message)
+        super().on_message(message)
         self._update_activity()
 
     def write_message(self, message, binary=False):
-        super(TermSocket, self).write_message(message, binary=binary)
+        super().write_message(message, binary=binary)
         self._update_activity()
 
     def _update_activity(self):

jupyter_server_terminals/rest-api.yml

@@ -7,12 +7,12 @@ info:
     url: https://jupyter.org
   version: "1"
 servers:
-- url: /
+  - url: /
 paths:
   /api/terminals:
     get:
       tags:
-      - terminals
+        - terminals
       summary: Get available terminals
       responses:
         200:
@@ -22,7 +22,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/Terminal'
+                  $ref: "#/components/schemas/Terminal"
         403:
           description: Forbidden to access
           content: {}
@@ -31,15 +31,15 @@ paths:
           content: {}
     post:
       tags:
-      - terminals
+        - terminals
       summary: Create a new terminal
       responses:
         200:
           description: Succesfully created a new terminal
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Terminal'
+                $ref: "#/components/schemas/Terminal"
         403:
           description: Forbidden to access
           content: {}
@@ -49,22 +49,22 @@ paths:
   /api/terminals/{terminal_id}:
     get:
       tags:
-      - terminals
+        - terminals
       summary: Get a terminal session corresponding to an id.
       parameters:
-      - name: terminal_id
-        in: path
-        description: ID of terminal session
-        required: true
-        schema:
-          type: string
+        - name: terminal_id
+          in: path
+          description: ID of terminal session
+          required: true
+          schema:
+            type: string
       responses:
         200:
           description: Terminal session with given id
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Terminal'
+                $ref: "#/components/schemas/Terminal"
         403:
           description: Forbidden to access
           content: {}
@@ -73,15 +73,15 @@ paths:
           content: {}
     delete:
       tags:
-      - terminals
+        - terminals
       summary: Delete a terminal session corresponding to an id.
       parameters:
-      - name: terminal_id
-        in: path
-        description: ID of terminal session
-        required: true
-        schema:
-          type: string
+        - name: terminal_id
+          in: path
+          description: ID of terminal session
+          required: true
+          schema:
+            type: string
       responses:
         204:
           description: Succesfully deleted terminal session
@@ -96,7 +96,7 @@ components:
   schemas:
     Terminal:
       required:
-      - name
+        - name
       type: object
       properties:
         name:

jupyter_server_terminals/terminalmanager.py

@@ -8,14 +8,12 @@
 
 import terminado
 from tornado import web
-from tornado.ioloop import IOLoop
-from tornado.ioloop import PeriodicCallback
+from tornado.ioloop import IOLoop, PeriodicCallback
 from traitlets import Integer
 from traitlets.config import LoggingConfigurable
 
 try:
-    from jupyter_server._tz import isoformat
-    from jupyter_server._tz import utcnow
+    from jupyter_server._tz import isoformat, utcnow
     from jupyter_server.prometheus.metrics import TERMINAL_CURRENTLY_RUNNING_TOTAL
 except ModuleNotFoundError:
     raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
@@ -46,7 +44,7 @@ class TerminalManager(LoggingConfigurable, terminado.NamedTermManager):
     # Methods for managing terminals
     # -------------------------------------------------------------------------
     def __init__(self, *args, **kwargs):
-        super(TerminalManager, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     def create(self, **kwargs):
         """Create a new terminal."""
@@ -78,7 +76,7 @@ def list(self):
     async def terminate(self, name, force=False):
         """Terminate terminal 'name'."""
         self._check_terminal(name)
-        await super(TerminalManager, self).terminate(name, force=force)
+        await super().terminate(name, force=force)
 
         # Decrease the metric below by one
         # because a terminal has been shutdown
@@ -113,7 +111,7 @@ def _initialize_culler(self):
         """
         if not self._initialized_culler and self.cull_inactive_timeout > 0:
             if self._culler_callback is None:
-                loop = IOLoop.current()
+                _ = IOLoop.current()
                 if self.cull_interval <= 0:  # handle case where user set invalid value
                     self.log.warning(
                         "Invalid value for 'cull_interval' detected (%s) - using default value (%s).",

pyproject.toml

@@ -6,10 +6,19 @@ build-backend = "jupyter_packaging.build_api"
 ignore = [""]
 
 [tool.pytest.ini_options]
-addopts = "--doctest-modules"
+addopts = "-raXs --durations 10 --color=yes --doctest-modules"
 testpaths = [
     "tests/"
 ]
+timeout = 300
+# Restore this setting to debug failures
+# timeout_method = "thread"
+filterwarnings = [
+  "error",
+  # From tornado
+  "ignore:unclosed <socket.socket:ResourceWarning",
+  "ignore:There is no current event loop:DeprecationWarning",
+]
 
 [tool.jupyter-releaser]
 skip = ["check-links"]

setup.cfg

@@ -36,6 +36,7 @@ test =
     pytest>=6.0
     pytest_tornasync
     pytest-cov
+    pytest-timeout
     jupyter_server[test]>=1
 
 [options.packages.find]
@@ -46,10 +47,19 @@ etc/jupyter/jupyter_server_config.d =
     jupyter-config/jupyter_server_terminals.json
 
 [flake8]
-ignore = E, C, W, F403, F811, F841, E402, I100, I101, D400
+ignore = E501, W503, E402
 builtins = c, get_config
 exclude =
     .cache,
     .github,
     docs,
     setup.py
+enable-extensions = G
+extend-ignore =
+    G001, G002, G004, G200, G201, G202,
+    # black adds spaces around ':'
+    E203,
+per-file-ignores =
+    # B011: Do not call assert False since python -O removes these calls
+    # F841 local variable 'foo' is assigned to but never used
+    tests/*: B011, F841

tests/test_terminal.py

@@ -171,7 +171,7 @@ async def test_culling(jp_server_config, jp_fetch, jp_cleanup_subprocesses):
     last_activity = term["last_activity"]
 
     culled = False
-    for i in range(CULL_TIMEOUT + CULL_INTERVAL * 2):
+    for _ in range(CULL_TIMEOUT + CULL_INTERVAL * 2):
         try:
             resp = await jp_fetch(
                 "api",