Merge branch 'master' into some_option_renaming

Author: ceball

.travis.yml

@@ -6,8 +6,6 @@ python:
   - "3.8"
   - "3.7"
   - "3.6"
-  - "3.5"
-  - "2.7"
 
 matrix:
   allow_failures:
@@ -17,15 +15,9 @@ install:
   # We do this conditionally because it saves us some downloading if the
   # version is the same.
   - unset VIRTUAL_ENV
-  # Python 3.4 and 2.7 need six installed before running setup.py
-  - pip install six
   # Travis needs to update pip/setuptools
   - pip install --upgrade setuptools pip
   - pip install .
-  - |
-    if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
-      pip install doit==0.29.0
-    fi
   - pip install doit
   - doit install_test_deps
 

README.md

@@ -72,6 +72,12 @@ Specify `-p no:python` if you would like to execute notebooks only. Alternativel
 
     py.test --nbval my_notebook.ipynb
 
+By default, each `.ipynb` file will be executed using the kernel
+specified in its metadata. You can override this behavior by passing
+either `--nbval-kernel-name mykernel` to run all the notebooks using
+`mykernel`, or `--current-env` to use a kernel in the same environment
+in which pytest itself was launched.
+
 If the output lines are going to be sanitized, an extra flag, `--nbval-sanitize-with`
 together with the path to a confguration file with regex expressions, must be passed,
 i.e.
@@ -115,8 +121,8 @@ notebook are run on the same kernel.
 ## Help
 The `py.test` system help can be obtained with `py.test -h`, which will
 show all the flags that can be passed to the command, such as the
-verbose `-v` option. The IPython notebook plugin can be found under the
-`general` section.
+verbose `-v` option. Nbval's options can be found under the
+`Jupyter Notebook validation` section.
 
 
 ## Acknowledgements

appveyor.yml

@@ -6,7 +6,6 @@ image: Visual Studio 2019
 # environment variables
 environment:
   matrix:
-    - PYTHON: "C:\\Python35-x64"
     - PYTHON: "C:\\Python36-x64"
     - PYTHON: "C:\\Python37-x64"
     - PYTHON: "C:\\Python38-x64"

docs/environment.yml

@@ -2,7 +2,7 @@ name: nbval_docs
 channels:
   - conda-forge
 dependencies:
-- python=3.5
+- python=3.8
 - numpy
 - matplotlib
 - sphinx

docs/source/index.ipynb

@@ -588,7 +588,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.1"
+   "version": "3.8.6"
   }
  },
  "nbformat": 4,

issues/27/latex-example.ipynb

@@ -11,9 +11,7 @@
   {
    "cell_type": "code",
    "execution_count": 18,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "import sympy\n",
@@ -33,9 +31,7 @@
   {
    "cell_type": "code",
    "execution_count": 19,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -79,9 +75,7 @@
   {
    "cell_type": "code",
    "execution_count": 21,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -106,9 +100,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda root]",
+   "display_name": "Python 3",
    "language": "python",
-   "name": "conda-root-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -120,7 +114,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.2"
+   "version": "3.8.6"
   }
  },
  "nbformat": 4,

issues/7/tutorial_lib.ipynb

@@ -28,9 +28,7 @@
   {
    "cell_type": "code",
    "execution_count": 4,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -50,9 +48,7 @@
   {
    "cell_type": "code",
    "execution_count": 5,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -72,9 +68,7 @@
   {
    "cell_type": "code",
    "execution_count": 6,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -101,9 +95,7 @@
   {
    "cell_type": "code",
    "execution_count": 7,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -133,9 +125,7 @@
   {
    "cell_type": "code",
    "execution_count": 8,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -155,9 +145,7 @@
   {
    "cell_type": "code",
    "execution_count": 9,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -177,9 +165,7 @@
   {
    "cell_type": "code",
    "execution_count": 10,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -229,9 +215,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.4.4"
+   "version": "3.8.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 1
 }

nbval/plugin.py

@@ -16,13 +16,7 @@
 import warnings
 from collections import OrderedDict, defaultdict
 
-# for python 3 compatibility
-import six
-
-try:
-    from Queue import Empty
-except:
-    from queue import Empty
+from queue import Empty
 
 # for reading notebook files
 import nbformat
@@ -71,9 +65,10 @@ def pytest_addoption(parser):
 
     This is called by the pytest API
     """
-    group = parser.getgroup("general")
+    group = parser.getgroup("nbval", "Jupyter Notebook validation")
+
     group.addoption('--nbval', action='store_true',
-                    help="Validate Jupyter notebooks")
+                    help="Run Jupyter notebooks, validating all output")
 
     group.addoption('--nbval-lax', action='store_true',
                     help="Run Jupyter notebooks, only validating output on "
@@ -86,8 +81,16 @@ def pytest_addoption(parser):
 
     group.addoption('--nbval-current-env', action='store_true',
                     help='Force test execution to use a python kernel in '
-                         'the same enviornment that py.test was '
-                         'launched from.')
+                         'the same environment that py.test was '
+                         'launched from. Without this flag, the kernel stored '
+                         'in the notebook is used by default. '
+                         'See also: --nbval-kernel-name')
+
+    group.addoption('--nbval-kernel-name', action='store', default=None,
+                    help='Force test execution to use the named kernel. '
+                         'If a kernel is not named, the kernel stored in the '
+                         'notebook is used by default. '
+                         'See also: --current-env')
 
     group.addoption('--nbval-cell-timeout', action='store', default=2000,
                     type=float,
@@ -124,6 +127,11 @@ def pytest_configure(config):
         if config.option.nbval_current_env:
             raise ValueError("--current-env and --nbval-current-env were both supplied.")
         config.option.nbval_current_env = config.option.current_env
+    if config.option.nbval or config.option.nbval_lax:
+        if config.option.nbval_kernel_name and config.option.current_env:
+            raise ValueError("--current-env and --nbval-kernel-name are mutually exclusive.")
+
+
 
 
 def pytest_collect_file(path, parent):
@@ -248,9 +256,12 @@ def setup(self):
         Called by pytest to setup the collector cells in .
         Here we start a kernel and setup the sanitize patterns.
         """
-
+        # we've already checked that --nbval-current-env and
+        # --nbval-kernel-name were not both supplied
         if self.parent.config.option.nbval_current_env:
             kernel_name = CURRENT_ENV_KERNEL_NAME
+        elif self.parent.config.option.nbval_kernel_name:
+            kernel_name = self.parent.config.option.nbval_kernel_name
         else:
             kernel_name = self.nb.metadata.get(
                 'kernelspec', {}).get('name', 'python')
@@ -519,9 +530,9 @@ def compare_outputs(self, test, ref, skip_compare=None):
 
     def format_output_compare(self, key, left, right):
         """Format an output for printing"""
-        if isinstance(left, six.string_types):
+        if isinstance(left, str):
             left = _trim_base64(left)
-        if isinstance(right, six.string_types):
+        if isinstance(right, str):
             right = _trim_base64(right)
 
         cc = self.colors
@@ -815,7 +826,7 @@ def sanitize_outputs(self, outputs, skip_sanitize=('metadata',
     def sanitize(self, s):
         """sanitize a string for comparison.
         """
-        if not isinstance(s, six.string_types):
+        if not isinstance(s, str):
             return s
 
         """
@@ -824,7 +835,7 @@ def sanitize(self, s):
         is passed when py.test is called. Otherwise, the strings
         are not processed
         """
-        for regex, replace in six.iteritems(self.parent.sanitize_patterns):
+        for regex, replace in self.parent.sanitize_patterns.items():
             s = re.sub(regex, replace, s)
         return s
 
@@ -920,6 +931,6 @@ def _trim_base64(s):
 
 def _indent(s, indent='  '):
     """Intent each line with indent"""
-    if isinstance(s, six.string_types):
+    if isinstance(s, str):
         return '\n'.join(('%s%s' % (indent, line) for line in s.splitlines()))
     return s

readthedocs.yml

@@ -1,6 +1,6 @@
 type: sphinx
 python:
-  version: 3.5
+  version: 3.8
   pip_install: true
 conda:
   file: docs/environment.yml

setup.py

@@ -22,17 +22,16 @@
     },
     install_requires = [
         'pytest >= 2.8',
-        'six',
         'jupyter_client',
         'nbformat',
         'ipykernel',
         'coverage',
     ],
+    python_requires='>=3.6, <4',
     classifiers = [
         'Framework :: IPython',
         'Framework :: Pytest',
         'License :: OSI Approved :: BSD License',
-        'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 3',
         'Topic :: Software Development :: Testing',
     ]