Allow doctests to be filtered out on circleci

Author: Erotemic

bin/run_tests.py

@@ -39,7 +39,15 @@
         "\n\n================================== DOC TESTS ==================================",
         flush=True,
     )
-    subprocess.run(doc_test_args, check=True)
+    result = subprocess.run(doc_test_args, check=False)
+    if result.returncode not in (0, 5):
+        # Allow case where no doctests are collected (returncode 5) because
+        # circleci sets an explicit "-k" filter that disables doctests. There
+        # isn't a pattern that will only select doctests. This can be removed
+        # and have check=True if the circleci PYTEST_ADDOPTS is removed.
+        raise subprocess.CalledProcessError(
+            result.returncode, result.args, output=result.stdout,
+            stderr=result.stderr)
 
     # unit tests
     unit_test_args = [sys.executable, "-m", "pytest", "unit_test"]

cibuildwheel/oci_container.py

@@ -174,14 +174,17 @@ class OCIContainer:
     back to cibuildwheel.
 
     Example:
+        >>> # xdoctest: +REQUIRES(LINUX)
         >>> from cibuildwheel.oci_container import *  # NOQA
         >>> from cibuildwheel.options import _get_pinned_container_images
-        >>> image = _get_pinned_container_images()['x86_64']['manylinux2014']
+        >>> import pytest
         >>> try:
-        >>>     oci_platform = OCIPlatform.native()
-        >>> except OSError as ex:
-        >>>     import pytest
-        >>>     pytest.skip(str(ex))
+        ...     oci_platform = OCIPlatform.native()
+        ... except OSError as ex:
+        ...     pytest.skip(str(ex))
+        >>> if oci_platform != OCIPlatform.AMD64:
+        ...     pytest.skip('only runs on amd64')
+        >>> image = _get_pinned_container_images()['x86_64']['manylinux2014']
         >>> # Test the default container
         >>> with OCIContainer(image=image, oci_platform=oci_platform) as self:
         ...     self.call(["echo", "hello world"])

pyproject.toml

@@ -104,7 +104,7 @@ dev = [
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config", "--xdoctest"]
+addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config", "--xdoctest", "--ignore-glob=*venv*"]
 junit_family = "xunit2"
 xfail_strict = true
 filterwarnings = ["error"]