Apply Autoformats (#257)

Author: blink1073

.github/workflows/tests.yml

@@ -2,7 +2,7 @@ name: Tests
 
 on:
   push:
-    branches: ['main']
+    branches: ["main"]
   pull_request:
   schedule:
     - cron: "0 8 * * *"

.pre-commit-config.yaml

@@ -16,31 +16,32 @@ repos:
       - id: debug-statements
       - id: forbid-new-submodules
       - id: check-builtin-literals
-      # - id: trailing-whitespace
+      - id: trailing-whitespace
 
-  # - repo: https://github.com/psf/black
-  #   rev: 22.3.0
-  #   hooks:
-  #     - id: black
-  #       args: ["--line-length", "100"]
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        args: ["--line-length", "100"]
 
-  # - repo: https://github.com/PyCQA/isort
-  #   rev: 5.10.1
-  #   hooks:
-  #     - id: isort
-  #       files: \.py$
-  #       args: [--profile=black]
+  - 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/pre-commit/mirrors-prettier
+    rev: v2.6.1
+    hooks:
+      - id: prettier
+        exclude: "jupyterlab_server/templates/.*.html"
 
-  # - repo: https://github.com/asottile/pyupgrade
-  #   rev: v2.31.1
-  #   hooks:
-  #     - id: pyupgrade
-  #       args: [--py37-plus]
+  - 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

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Contributing
 
 If you're reading this section, you're probably interested in contributing to
-Jupyter.  Welcome and thanks for your interest in contributing!
+Jupyter. Welcome and thanks for your interest in contributing!
 
 Please take a look at the Contributor documentation, familiarize yourself with
 using the Jupyter Server, and introduce yourself on the mailing list and
@@ -12,7 +12,7 @@ For general documentation about contributing to Jupyter projects, see the
 
 ## Development Install
 
-``` shell
+```shell
 git clone https://github.com/jupyterlab/jupyterlab_server.git
 cd jupyterlab_server
 pip install -e .
@@ -32,6 +32,7 @@ pytest --pyargs jupyterlab_server
 ```
 
 ## Code Styling
+
 `jupyterlab_server` has adopted automatic code formatting so you shouldn't
 need to worry too much about your code style.
 As long as your code is valid,
@@ -50,7 +51,7 @@ You can invoke the pre-commit hook by hand at any time with:
 
 ```shell
 pre-commit run
-````
+```
 
 which should run any autoformatting on your code
 and tell you about any errors it couldn't fix automatically.

CONTRIBUTING.md

@@ -7,7 +7,7 @@
 ## Motivation
 
 JupyterLab Server sits between JupyterLab and Jupyter Server, and provides a
-set of REST API handlers and utilities that are used by JupyterLab.  It is a separate project in order to
+set of REST API handlers and utilities that are used by JupyterLab. It is a separate project in order to
 accommodate creating JupyterLab-like applications from a more limited scope.
 
 ## Install

README.md

@@ -7,26 +7,30 @@ The recommended way to make a release is to use [`jupyter_releaser`](https://git
 ## Manual Release
 
 ### Set up
+
 ```
 pip install tbump twine build
 git pull origin $(git branch --show-current)
 git clean -dffx
 ```
 
 ### Update the version and apply the tag
+
 ```
 echo "Enter new version"
 read script_version
 tbump ${script_version}
 ```
 
 ### Build the artifacts
+
 ```
 rm -rf dist
 python -m build .
 ```
 
 ### Publish the artifacts to pypi
+
 ```
 twine check dist/*
 twine upload dist/*

RELEASE.md

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import os
+
 from jupyterlab_server import LabServerApp
 
 header = """\
@@ -37,11 +38,11 @@
 """
 # Handle local and RTD locations
 cwd = os.getcwd()
-if os.path.basename(cwd) == 'source':
-    destination = os.path.join(cwd, 'api/app-config.rst')
+if os.path.basename(cwd) == "source":
+    destination = os.path.join(cwd, "api/app-config.rst")
 else:
-    destination = os.path.join(cwd, 'source/api/app-config.rst')
+    destination = os.path.join(cwd, "source/api/app-config.rst")
 
-with open(destination, 'w') as f:
+with open(destination, "w") as f:
     f.write(header)
     f.write(LabServerApp().document_config_options())

docs/autogen_config.py

@@ -1,18 +1,17 @@
-
 name: jupyterlab_server_documentation
 channels:
   - conda-forge
 dependencies:
-- python=3.9
-- sphinx<4.0
-- sphinx-copybutton
-- pip
-- myst-parser
-- mistune<1
-- jinja2<3.1.0
-- pip:
-  - autodoc-traits
-  - pydata_sphinx_theme
-  - sphinxcontrib-openapi
-  - numpydoc
-  - ..
+  - python=3.9
+  - sphinx<4.0
+  - sphinx-copybutton
+  - pip
+  - myst-parser
+  - mistune<1
+  - jinja2<3.1.0
+  - pip:
+      - autodoc-traits
+      - pydata_sphinx_theme
+      - sphinxcontrib-openapi
+      - numpydoc
+      - ..

docs/environment.yml

@@ -20,43 +20,43 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'JupyterLab Server'
-copyright = '2021, Project Jupyter'
-author = 'Project Jupyter'
+project = "JupyterLab Server"
+copyright = "2021, Project Jupyter"
+author = "Project Jupyter"
 
 # The full version, including alpha/beta/rc tags
-_version_py = osp.join(HERE, '..', '..', 'jupyterlab_server', '_version.py')
+_version_py = osp.join(HERE, "..", "..", "jupyterlab_server", "_version.py")
 version_ns = {}
 
-with open(_version_py, mode='r') as version_file:
+with open(_version_py) as version_file:
     exec(version_file.read(), version_ns)
 
 # The short X.Y version.
-version = '%i.%i' % version_ns['version_info'][:2]
+version = "%i.%i" % version_ns["version_info"][:2]
 # The full version, including alpha/beta/rc tags.
-release = version_ns['__version__']
+release = version_ns["__version__"]
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'myst_parser',
-    'numpydoc',
-    'autodoc_traits',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinxcontrib.openapi',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.mathjax',
-    'sphinx_copybutton'
+    "myst_parser",
+    "numpydoc",
+    "autodoc_traits",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinxcontrib.openapi",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx_copybutton",
 ]
 
 myst_enable_extensions = ["html_image"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -89,8 +89,9 @@
 # so disable
 numpydoc_show_class_members = False
 
+
 def setup(app):
-    dest = osp.join(HERE, 'changelog.md')
-    shutil.copy(osp.join(HERE, '..', '..', 'CHANGELOG.md'), dest)
-    with open(osp.join(HERE, '../autogen_config.py')) as f:
-        exec(compile(f.read(), '../autogen_config.py', 'exec'), {})
+    dest = osp.join(HERE, "changelog.md")
+    shutil.copy(osp.join(HERE, "..", "..", "CHANGELOG.md"), dest)
+    with open(osp.join(HERE, "../autogen_config.py")) as f:
+        exec(compile(f.read(), "../autogen_config.py", "exec"), {})

docs/source/conf.py

@@ -1,35 +1,31 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from ._version import __version__
 from .app import LabServerApp
+from .handlers import LabConfig, LabHandler, add_handlers
 from .licenses_app import LicensesApp
-from .handlers import add_handlers, LabHandler, LabConfig
 from .spec import get_openapi_spec, get_openapi_spec_dict
 from .translation_utils import translator
 from .workspaces_app import WorkspaceExportApp, WorkspaceImportApp, WorkspaceListApp
-from .workspaces_handler import slugify, WORKSPACE_EXTENSION
-from ._version import __version__
+from .workspaces_handler import WORKSPACE_EXTENSION, slugify
 
 __all__ = [
-    '__version__',
-    'add_handlers',
-    'LabConfig',
-    'LabHandler',
-    'LabServerApp',
-    'LicensesApp',
-    'SETTINGS_EXTENSION',
-    'slugify',
-    'translator',
-    'WORKSPACE_EXTENSION',
-    'WorkspaceExportApp',
-    'WorkspaceImportApp',
-    'WorkspaceListApp'
+    "__version__",
+    "add_handlers",
+    "LabConfig",
+    "LabHandler",
+    "LabServerApp",
+    "LicensesApp",
+    "SETTINGS_EXTENSION",
+    "slugify",
+    "translator",
+    "WORKSPACE_EXTENSION",
+    "WorkspaceExportApp",
+    "WorkspaceImportApp",
+    "WorkspaceListApp",
 ]
 
+
 def _jupyter_server_extension_points():
-    return [
-        {
-            'module': 'jupyterlab_server',
-            'app': LabServerApp
-        }
-    ]
+    return [{"module": "jupyterlab_server", "app": LabServerApp}]