RFC Add tox

.gitignore

@@ -1,15 +1,16 @@
 **/*.pyc
 **/__pycache__/
+**/node_modules
+**/package-lock.json
+*.vsix
 .*.sw?
 .coverage
 .coverage.*.*.*
 .mypy_cache/
+.tox/
 .vscode
 dist/
 docs/_build/
 htmlcov/
 MANIFEST
-TestSlide.egg-info/
-**/node_modules
-*.vsix
-**/package-lock.json
+TestSlide.egg-info/

.python-version

@@ -0,0 +1,3 @@
+3.6.12
+3.7.9
+3.8.6

.travis.yml

@@ -1,7 +1,10 @@
 language: python
+# FIXME use pyenv pinned versions from .python-version
 python:
   - 3.6
   - 3.7
   - 3.8
-script:
-  TESTSLIDE_FORMAT=progress UNITTEST_VERBOSE=0 make travis V=1
+install: pip install tox-travis
+script: tox
+env:
+  - TESTSLIDE_FORMAT=progress UNITTEST_VERBOSE=0 V=1

CONTRIBUTING.md

@@ -22,9 +22,24 @@ We actively welcome your pull requests.
 
 Generally speaking:
 
-- Install a supported Python version (see `.travis.yml`) (suggestion: use [pyenv](https://github.com/pyenv/pyenv)).
-- Install the dependencies: `make install_build_deps`.
-- Run the tests: `make` (or `make V=1` for verbose output).
+- Install supported Python versions (see `.python-version`).
+  - Using [pyenv](https://github.com/pyenv/pyenv) is highly advised!
+- Enable the Python version defined at `tox.ini` `basepython`.
+- Do `pip install tox` (and `tox-pyenv` if using pyenv).
+- Run all tests: `tox`.
+
+If you want more fine grained control over running tests you can:
+
+- Create a venv: `python -m venv venv/`.
+- Install deps: `pip install -e .`.
+- Run individual tests:
+  - `make tests/strict_mock_testslide.py`
+
+`make` has other goodies:
+
+- `V=1`: verbose output.
+- `TESTSLIDE_FORMAT`: set the formatter (progress, documentation etc).
+- `UNITTEST_VERBOSE=0`: disable verbose.
 
 Here's a quick cookbook on how to have a Python installation working using Docker:
 
@@ -41,8 +56,8 @@ eval "$(pyenv init -)"
 eval "$(pyenv virtualenv-init -)"
 ```
 - Do `exec bash -i`.
-- Install Python: `pyenv install 3.7.3`.
-- Enable the installed version `pyenv shell 3.7.3`.
+- Install Python: `pyenv install $SUPPORTED_PYTHON_VERSION`.
+- Enable the installed version `pyenv shell $SUPPORTED_PYTHON_VERSION`.
 
 ## Contributor License Agreement ("CLA")
 

Makefile

@@ -119,11 +119,7 @@ format_black:
 .PHONY: tests
 tests: \
 	unittest_tests \
-	testslide_tests \
-	mypy \
-	flake8 \
-	isort \
-	black
+	testslide_tests
 
 .PHONY: format
 format: \
@@ -148,6 +144,7 @@ coverage_combine: unittest_tests testslide_tests
 coverage_report: coverage_combine
 	@printf "${TERM_BRIGHT}COVERAGE REPORT\n${TERM_NONE}"
 	${Q} coverage report
+	${Q} bash -c '[ -n "$$COVERALLS_REPO_TOKEN" ] && { echo -e "${TERM_BRIGHT}COVERALLS\\n${TERM_NONE}" && coveralls ; } || true'
 
 .PHONY: coverage_html
 coverage_html: coverage_combine
@@ -159,20 +156,10 @@ coverage_html_clean:
 	@printf "${TERM_BRIGHT}COVERAGE HTML CLEAN\n${TERM_NONE}"
 	${Q} rm -rf htmlcov/
 
-.PHONY: coveralls
-coveralls: coverage_combine
-	@printf "${TERM_BRIGHT}COVERALLS\n${TERM_NONE}"
-	${Q} coveralls
-
 ##
 ## Build
 ##
 
-.PHONY: install_build_deps
-install_build_deps:
-	@printf "${TERM_BRIGHT}INSTALL BUILD DEPS\n${TERM_NONE}"
-	${Q} pip install -e .[test,build]
-
 .PHONY: sdist
 sdist:
 	@printf "${TERM_BRIGHT}SDIST\n${TERM_NONE}"
@@ -187,22 +174,6 @@ sdist_clean:
 twine: sdist
 	twine upload $(DIST_TAR_GZ)
 
-.PHONY: install_local
-install_local: sdist
-	@printf "${TERM_BRIGHT}INSTALL LOCAL\n${TERM_NONE}"
-	${Q} pip install $(DIST_TAR_GZ)
-	${Q} testslide --help
-
-.PHONY: travis
-travis: \
-	install_build_deps \
-	tests \
-	coverage_report \
-	coveralls \
-	docs \
-	sdist \
-	install_local
-
 ##
 ## Clean
 ##

docs/conf.py

@@ -3,7 +3,7 @@
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-import sys
+from typing import Dict, List
 
 # -*- coding: utf-8 -*-
 #
@@ -45,7 +45,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions: List[str] = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -122,7 +122,7 @@
 
 # -- Options for LaTeX output ------------------------------------------------
 
-latex_elements = {
+latex_elements: Dict[str, str] = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',

mypy.ini

@@ -4,9 +4,13 @@ ignore_missing_imports = True
 ignore_missing_imports = True
 [mypy-psutil.*]
 ignore_missing_imports = True
+[mypy-sphinx_kr_theme.*]
+ignore_missing_imports = True
+[mypy-setuptools.*]
+ignore_missing_imports = True
 [mypy-testslide.testslide]
 disallow_untyped_calls = True
 disallow_untyped_defs = True
 disallow_incomplete_defs = True
 check_untyped_defs = True
-disallow_untyped_decorators = True
+disallow_untyped_decorators = True

setup.py

@@ -25,21 +25,6 @@
         "typeguard>=2.9.1",
         'dataclasses==0.6; python_version < "3.7"',
     ],
-    extras_require={
-        "build": [
-            "black",
-            "coverage",
-            "coveralls",
-            "flake8",
-            "isort~=5.1",
-            "mypy==0.782",
-            "ipython",
-            "sphinx",
-            "sphinx-autobuild",
-            "sphinx-kr-theme",
-            "twine",
-        ]
-    },
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",

tests/dsl_unittest.py

@@ -1906,7 +1906,7 @@ async def example(self):
                     asyncio.sleep(0.1)
 
             with self.assertRaisesRegex(
-                RuntimeWarning, "coroutine '.+' was never awaited"
+                RuntimeError, "coroutine '.+' was never awaited"
             ):
                 self.run_first_context_first_example()
 

testslide/__init__.py

@@ -66,7 +66,7 @@ def asyncio_run(coro):
     asyncio_run = partial(asyncio.run, debug=True)
 
 
-if sys.version_info < (3, 8):
+if sys.version_info < (3, 7):
     get_all_tasks = asyncio.Task.all_tasks
 else:
     get_all_tasks = asyncio.all_tasks
@@ -401,10 +401,10 @@ def _raise_if_asyncio_warnings(self, context_data: _ContextData) -> Iterator[Non
             yield
             return
         original_showwarning = warnings.showwarning
-        caught_failures: List[Union[Exception, str]] = []
+        caught_failures: List[Exception] = []
 
         def showwarning(
-            message: str,
+            message: Union[Warning, str],
             category: Type[Warning],
             filename: str,
             lineno: int,
@@ -417,11 +417,11 @@ def showwarning(
             warning_class = type(message)
             pattern = failure_warning_messages.get(warning_class, None)
             if pattern and re.compile(pattern).match(str(message)):
-                caught_failures.append(message)
+                caught_failures.append(RuntimeError(message))
             else:
                 original_showwarning(message, category, filename, lineno, file, line)
 
-        warnings.showwarning = showwarning  # type: ignore
+        warnings.showwarning = showwarning
 
         original_logger_warning = asyncio.log.logger.warning
 
@@ -450,7 +450,7 @@ def logger_warning(msg: str, *args: Any, **kwargs: Any) -> None:
             asyncio.log.logger.warning = original_logger_warning  # type: ignore
             for failure in caught_failures:
                 with aggregated_exceptions.catch():
-                    raise failure  # type: ignore
+                    raise failure
             aggregated_exceptions.raise_correct_exception()
 
     def _async_run_all_hooks_and_example(self, context_data: _ContextData) -> None:

tox.ini

@@ -0,0 +1,53 @@
+# tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py36, py37, py38, mypy, flake8, isort, black, docs
+
+[testenv]
+deps = coverage
+allowlist_externals = /usr/bin/make
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+commands =
+	make coverage_report TESTSLIDE_FORMAT=progress UNITTEST_VERBOSE=0
+
+[testenv:mypy]
+basepython = python3.8
+allowlist_externals = /usr/bin/make
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+deps = mypy
+commands = make mypy
+
+[testenv:flake8]
+basepython = python3.8
+allowlist_externals = /usr/bin/make
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+deps = flake8
+commands = make flake8
+
+[testenv:isort]
+basepython = python3.8
+allowlist_externals = /usr/bin/make
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+deps = isort
+commands = make isort
+
+[testenv:black]
+basepython = python3.8
+allowlist_externals = /usr/bin/make
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+deps = black
+commands = make black
+
+[testenv:docs]
+basepython = python3.8
+passenv = TERM TESTSLIDE_FORMAT UNITTEST_VERBOSE V
+allowlist_externals = /usr/bin/make
+deps = 
+	ipython
+	sphinx
+	sphinx-autobuild
+	sphinx-kr-theme
+commands = make -C docs/ html