added remote data directive

more descriptive comments in skip_some.rst

Update tests/test_doctestplus.py

Co-authored-by: Brigitta Sipőcz <[email protected]>

added pytest-remotedata as a requirement to be installed by tox

added version to pytest-remotedata

composite directive test fails

latest commit

removed test for ignore warning directive

test cleanup

removed extra marker

updated README and added changelog entry

review corrections

added vscode setting to .gitignore

removed .vscode

splitted test functions

review corrections

Author: tinuademargaret

.gitignore

@@ -59,5 +59,8 @@ venv
 # PyCharm
 .idea
 
+# VS code
+.vscode
+
 pytest_doctestplus/version.py
 pip-wheel-metadata/

.vscode/settings.json

@@ -7,6 +7,9 @@
 0.9.0 (2021-01-14)
 ==================
 
+- Added ``..doctest-remote-data::`` directive to control remote data 
+  access for a chunk of code [#137]
+
 - Declare ``setuptools`` runtime dependency [#93]
 
 - Add ``SHOW_WARNINGS`` flag to show warnings. [#136]

CHANGES.rst

@@ -273,7 +273,17 @@ marked:
 
 The ``+REMOTE_DATA`` directive indicates that the marked statement should only
 be executed if the ``--remote-data`` option is given. By default, all
-statements marked with ``--remote-data`` will be skipped.
+statements marked with the remote data directive will be skipped.
+
+Whole code example blocks can also be marked to control access to data from the internet
+this way:
+
+.. code-block:: python
+
+    .. doctest-remote-data::
+
+        >>> import requests
+        >>> r = requests.get('https://www.astropy.org')
 
 .. _pytest-remotedata: https://github.com/astropy/pytest-remotedata
 __ pytest-remotedata_

README.rst

@@ -89,9 +89,9 @@ def pytest_addoption(parser):
 
     parser.addoption("--text-file-format", action="store",
                      help=(
-                        "Text file format for narrative documentation. "
-                        "Options accepted are 'txt', 'tex', and 'rst'. "
-                        "This is no longer recommended, use --doctest-glob instead."
+                         "Text file format for narrative documentation. "
+                         "Options accepted are 'txt', 'tex', and 'rst'. "
+                         "This is no longer recommended, use --doctest-glob instead."
                      ))
 
     # Defaults to `atol` parameter from `numpy.allclose`.
@@ -139,8 +139,8 @@ def pytest_addoption(parser):
                   default=[])
 
     parser.addini("doctest_subpackage_requires",
-                  "A list of paths to skip if requirements are not satisfied. Each item in the list "
-                  "should have the syntax path=req1;req2",
+                  "A list of paths to skip if requirements are not satisfied."
+                  "Each item in the list should have the syntax path=req1;req2",
                   type='linelist',
                   default=[])
 
@@ -156,7 +156,8 @@ def get_optionflags(parent):
 def pytest_configure(config):
     doctest_plugin = config.pluginmanager.getplugin('doctest')
     run_regular_doctest = config.option.doctestmodules and not config.option.doctest_plus
-    use_doctest_plus = config.getini('doctest_plus') or config.option.doctest_plus or config.option.doctest_only
+    use_doctest_plus = config.getini(
+        'doctest_plus') or config.option.doctest_plus or config.option.doctest_only
     if doctest_plugin is None or run_regular_doctest or not use_doctest_plus:
         return
 
@@ -301,7 +302,8 @@ class DocTestParserPlus(doctest.DocTestParser):
 
            - ``.. doctest-skip-all``: Skip all subsequent doctests.
 
-           - ``.. doctest-remote-data::``: Skip the next doctest chunk if --remote-data is not passed.
+           - ``.. doctest-remote-data::``: Skip the next doctest chunk if
+             --remote-data is not passed.
         """
 
         def parse(self, s, name=None):
@@ -333,7 +335,8 @@ def parse(self, s, name=None):
                     required = []
                     skip_next = False
                     lines = entry.strip().splitlines()
-                    if any([re.match('{} doctest-skip-all'.format(comment_char), x.strip()) for x in lines]):
+                    if any([re.match(
+                            '{} doctest-skip-all'.format(comment_char), x.strip()) for x in lines]):
                         skip_all = True
                         continue
 
@@ -361,9 +364,8 @@ def parse(self, s, name=None):
                             continue
 
                     if config.getoption('remote_data', 'none') != 'any':
-                        print(config.getoption('remote_data', 'none') != 'any')
                         matches = [re.match(
-                            r'{}\s+doctest-remote-data\s*::(\s+.*)?'.format(comment_char),
+                            r'{}\s+doctest-remote-data\s*::'.format(comment_char),
                             last_line) for last_line in last_lines]
 
                         if len(matches) > 1:
@@ -372,12 +374,8 @@ def parse(self, s, name=None):
                             match = matches[0]
 
                         if match:
-                            marker = match.group(1)
-                            if (marker is None or
-                                    (marker.strip() == 'win32' and
-                                    sys.platform == 'win32')):
-                                skip_next = True
-                                continue
+                            skip_next = True
+                            continue
 
                     matches = [re.match(
                         r'{}\s+doctest-requires\s*::\s+(.*)'.format(comment_char),

pytest_doctestplus/plugin.py

@@ -35,6 +35,10 @@ install_requires =
     setuptools>=30.3.0
     packaging>=17.0
 
+[options.extras_require]
+test = 
+    pytest-remotedata>=0.3.2
+
 [options.entry_points]
 pytest11 =
     pytest_doctestplus = pytest_doctestplus.plugin

setup.cfg

@@ -80,3 +80,77 @@ Code in doctest should run only if version condition is satisfied:
 .. doctest-requires:: pytest>=1.0 pytest>=2.0
 
     >>> import pytest
+
+
+Remote data block code sandwiched in block codes
+================================================
+
+This code block should work just fine::
+
+    >>> 1 + 1
+    2
+
+This should be skipped when remote data is not requested
+otherwise the test should fail::
+
+.. doctest-remote-data::
+
+    >>> 1 + 3
+    2
+
+This code block should work just fine::
+
+    >>> 1 + 1
+    2
+
+
+Remote data followed by plain block code
+========================================
+
+This one should be skipped when remote data is not requested
+otherwise the test should fail::
+
+.. doctest-remote-data::
+
+    >>> 1 + 3
+    2
+
+This code block should work just fine::
+
+    >>> 1 + 1
+    2
+
+
+Several blocks of Remote data
+=============================
+
+The three block codes should be skipped when remote data
+is not requested otherwise the tests should fail:
+
+.. doctest-remote-data::
+
+    >>> 1 + 3
+    2
+
+.. doctest-remote-data::
+
+    >>> 1 + 4
+    2
+
+.. doctest-remote-data::
+
+    >>> 1 + 5
+    2
+
+composite directive with remote data
+====================================
+
+This should be skipped otherwise the test should fail::
+
+.. doctest-remote-data::
+
+    >>> 1 + 1
+    3
+    >>> import warnings
+    >>> warnings.warn('A warning occurred', UserWarning)  # doctest: +IGNORE_WARNINGS
+    

tests/docs/skip_some.rst

@@ -777,32 +777,154 @@ def test_doctest_skip(testdir):
     testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
 
 
-def test_remote_data(testdir):
+def test_remote_data_on(testdir):
     testdir.makeini(
         """
         [pytest]
         doctestplus = enabled
     """)
 
-    # should be ignored
     p = testdir.makefile(
         '.rst',
         """
+        # This test should pass
         .. doctest-remote-data::
+
             >>> 1 + 1
             2
         """
     )
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst',
+                       '--remote-data').assertoutcome(passed=1)
+
+
+def test_remote_data_off(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctestplus = enabled
+    """)
+
+    p = testdir.makefile(
+        '.rst',
+        """
+        # This test should fail, but we skip it, thus the test should be skipped.
+        .. doctest-remote-data::
+
+            >>> from contextlib import closing
+            >>> from urllib.request import urlopen
+            >>> with closing(urlopen('https://www.astropy.org')) as remote:
+            ...     remote.read()    # doctest: +IGNORE_OUTPUT
+        """
+    )
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
+
+
+def test_remote_data_float_cmp(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctestplus = enabled
+    """)
+
+    p = testdir.makefile(
+        '.rst',
+        """
+        #This test is skipped when remote data is not requested, and should
+        #fails when remote data is requested
+        .. doctest-remote-data::
+
+            >>> x = 1/3.
+            >>> x    # doctest: +FLOAT_CMP
+            0.333333
+        """
+    )
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
+
+
+def test_remote_data_ignore_whitespace(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctest_optionflags = NORMALIZE_WHITESPACE
+        doctestplus = enabled
+    """)
+
+    p = testdir.makefile(
+        '.rst',
+        """
+        #This test should be skipped when remote data is not requested, and should
+        #pass when remote data is requested
+        .. doctest-remote-data::
+
+            >>> a = "foo         "
+            >>> print(a)
+            foo
+        """
+    )
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
+
+
+def test_remote_data_ellipsis(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctest_optionflags = ELLIPSIS
+        doctestplus = enabled
+    """)
+
+    p = testdir.makefile(
+        '.rst',
+        """
+        #This test should be skipped when remote data is not requested, and should
+        #pass when remote data is requested
+        .. doctest-remote-data::
+
+            >>> a = "freedom at last"
+            >>> print(a)
+            freedom ...
+        """
+    )
     testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
 
-    # should run
+
+def test_remote_data_requires(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctestplus = enabled
+    """)
+
     p = testdir.makefile(
         '.rst',
         """
+        #This test should be skipped even if remote data is requested because
+        #the module required does not exist
         .. doctest-remote-data::
+        .. doctest-requires:: does-not-exist
+
             >>> 1 + 1
-            2
+            3
         """
     )
-    testdir.inline_run(p, '--doctest-plus', '--doctest-rst',
-                       '--remote-data').assertoutcome(passed=1)
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)
+
+
+def test_remote_data_ignore_warnings(testdir):
+    testdir.makeini(
+        """
+        [pytest]
+        doctestplus = enabled
+    """)
+
+    p = testdir.makefile(
+        '.rst',
+        """
+        #This test should be skipped if remote data is not requested.
+        .. doctest-remote-data::
+
+            >>> import warnings
+            >>> warnings.warn('A warning occurred', UserWarning)  # doctest: +IGNORE_WARNINGS
+        """
+    )
+    testdir.inline_run(p, '--doctest-plus', '--doctest-rst').assertoutcome(skipped=1)

tests/test_doctestplus.py

@@ -20,6 +20,9 @@ deps =
     pytest61: pytest==6.1.*
     pytestdev: git+https://github.com/pytest-dev/pytest#egg=pytest
 
+extras =
+    test
+
 commands =
     pip freeze
     pytest {toxinidir}/tests {posargs}