add pytest opts and pre-commit

Author: blink1073

.github/workflows/ci.yml

@@ -14,6 +14,30 @@ defaults:
     shell: bash
 
 jobs:
+  # Run "pre-commit run --all-files"
+  pre-commit:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 2
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      # ref: https://github.com/pre-commit/action
+      - uses: pre-commit/[email protected]
+      - name: Help message if pre-commit fail
+        if: ${{ failure() }}
+        run: |
+          echo "You can install pre-commit hooks to automatically run formatting"
+          echo "on each commit with:"
+          echo "    pre-commit install"
+          echo "or you can run by hand on staged files with"
+          echo "    pre-commit run"
+          echo "or after-the-fact on already committed files with"
+          echo "    pre-commit run --all-files"
+
   build:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -63,14 +87,14 @@ jobs:
       timeout-minutes: 15
       if: ${{ !startsWith( matrix.python-version, 'pypy' ) && !startsWith(matrix.os, 'windows') }}
       run: |
-        cmd="python -m pytest -vv -raXs --cov ipykernel --cov-branch --cov-report term-missing:skip-covered --durations 10 --color=yes"
+        cmd="python -m pytest -vv --cov ipykernel --cov-branch --cov-report term-missing:skip-covered"
         $cmd || $cmd --lf
 
     - name: Run the tests on pypy and windows
       timeout-minutes: 15
       if: ${{ startsWith( matrix.python-version, 'pypy' ) || startsWith(matrix.os, 'windows') }}
       run: |
-        cmd="python -m pytest -vv -raXs --durations 10 --color=yes"
+        cmd="python -m pytest -vv"
         $cmd || $cmd --lf
 
     - name: Coverage
@@ -135,7 +159,7 @@ jobs:
     - name: Run the tests
       timeout-minutes: 10
       run: |
-        cmd="python -m pytest -vv -raXxs --durations 10 --color=yes"
+        cmd="python -m pytest -vv -raXxs"
         $cmd || $cmd --lf
 
   test_miniumum_versions:
@@ -152,7 +176,7 @@ jobs:
         uses: jupyterlab/maintainer-tools/.github/actions/install-minimums@v1
       - name: Run the unit tests
         run: |
-          cmd="python -m pytest -vv -raXxs --durations 10 --color=yes"
+          cmd="python -m pytest -vv -raXxs"
           $cmd || $cmd --lf
 
   test_prereleases:
@@ -173,7 +197,7 @@ jobs:
           pip check
       - name: Run the tests
         run: |
-          cmd="python -m pytest -vv -raXs --durations 10 --color=yes"
+          cmd="python -m pytest -vv"
           $cmd || $cmd --lf
 
   make_sdist:
@@ -214,5 +238,5 @@ jobs:
       - name: Run Test
         run: |
           cd sdist/test
-          cmd="python -m pytest -vv -raXs --durations 10 --color=yes"
+          cmd="python -m pytest -vv"
           $cmd || $cmd --lf

CONTRIBUTING.md

@@ -17,6 +17,31 @@ cd ipykernel
 pip install -e .
 ```
 
+## Code Styling
+`ipykernel` 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,
+the pre-commit hook should take care of how it should look.
+To install `pre-commit`, run the following::
+
+    pip install pre-commit
+    pre-commit install
+
+
+You can invoke the pre-commit hook by hand at any time with::
+
+    pre-commit run
+
+which should run any autoformatting on your code
+and tell you about any errors it couldn't fix automatically.
+You may also install [black integration](https://github.com/psf/black#editor-integration)
+into your text editor to format code automatically.
+
+If you have already committed files before setting up the pre-commit
+hook with ``pre-commit install``, you can fix everything up using
+``pre-commit run --all-files``. You need to make the fixing commit
+yourself after that.
+
 ## Releasing ipykernel
 
 Releasing ipykernel is *almost* standard for a Python package:

pyproject.toml

@@ -28,3 +28,12 @@ tag_template = "v{new_version}"
 
 [[tool.tbump.file]]
 src = "ipykernel/_version.py"
+
+[tool.pytest.ini_options]
+addopts = "-raXs --durations 10 --color=yes --doctest-modules"
+testpaths = [
+    "tests/"
+]
+timeout = 300
+# Restore this setting to debug failures
+# timeout_method = "thread"

setup.py

@@ -77,6 +77,7 @@ def run(self):
             "pytest-cov",
             "flaky",
             "ipyparallel",
+            "pre-commit"
         ],
     },
     classifiers=[