Fix coverage report issue; add --doctest-modules

Author: Apkawa

pytest.ini

@@ -1,13 +1,5 @@
 [pytest]
 python_files=tests.py test_*.py
-addopts = --ignore=node_modules --ignore=static -r fesxXR
-
-python_paths = ./
-
-flake8-max-line-length = 99
-flake8-ignore =
-    *.py E402 W503
-    */migrations/* ALL
-    */tests/* ALL
-    */deploy/* ALL
-    */docs/* ALL
+addopts =
+    -r fesxXR
+    --doctest-modules

pytest_image_diff/helpers.py

@@ -12,6 +12,14 @@
 def build_filename(
     name: str, suffix: str = "", prefix: str = "", max_length: int = 128
 ) -> str:
+    """
+    >>> build_filename("name")
+    'name'
+    >>> build_filename("name", "suffix", "prefix")
+    'prefix-name-suffix'
+    >>> build_filename("loooooooong_nameeeeee", "suffix", max_length=20)
+    'loooooooo-suffix'
+    """
     return "-".join(
         filter(
             None, [prefix, name[: max_length - len(suffix) - len(prefix) - 5], suffix]
@@ -32,9 +40,9 @@ def get_test_info(
         request: FixtureRequest, suffix: str = "", prefix: str = ""
     ) -> "TestInfo":
         try:
-            names = junitxml.mangle_testnames(
+            names = junitxml.mangle_testnames(  # type: ignore
                 request.node.nodeid.split("::")
-            )  # type: ignore
+            )  #
         except AttributeError:
             # pytest>=2.9.0
             names = junitxml.mangle_test_address(request.node.nodeid)

pytest_image_diff/plugin.py

@@ -12,7 +12,7 @@
 from .image_diff import _diff
 
 try:
-    from .splinter import *  # noqa
+    from .splinter import screenshot_regression  # noqa
 except ImportError:
     pass
 

pytest_image_diff/splinter.py

@@ -8,52 +8,50 @@
     # Check pytest-splinter
     from pytest_splinter.plugin import Browser
 except ImportError:
-    raise
-
-from ._types import ImageRegressionCallableType
-
-
-class ScreenshotRegressionCallableType(Protocol):
-    def __call__(
-        self,
-        browser: Optional[Browser] = None,
-        threshold: Optional[float] = None,
-        suffix: Optional[str] = None,
-    ) -> bool:
-        pass
-
-
-__all__ = ["screenshot_regression"]
-
-
-@pytest.fixture(scope="function")
-def screenshot_regression(
-    browser: Browser,
-    image_regression: ImageRegressionCallableType,
-    image_diff_threshold: float,
-) -> Generator[ScreenshotRegressionCallableType, None, None]:
-    """
-    Check regression browser screenshot
-
-    :param browser: optional, by default from `browser` fixture
-    :param threshold: float, by default from `image_diff_threshold`
-    :param suffix: str, need for multiple checks  by one test
-    """
-    default_browser = browser
-
-    def _factory(
-        browser: Optional[Browser] = None,
-        threshold: Optional[float] = None,
-        suffix: Optional[str] = "",
-    ) -> bool:
-        if browser is None:
-            browser = default_browser
-
-        if threshold is None:
-            threshold = image_diff_threshold
-        tf = NamedTemporaryFile(suffix=".png")
-        image = tf.name
-        browser.driver.save_screenshot(image)
-        return image_regression(image, threshold, suffix)
-
-    yield _factory
+    Browser = None
+
+if Browser:
+    from ._types import ImageRegressionCallableType
+
+    class ScreenshotRegressionCallableType(Protocol):
+        def __call__(
+            self,
+            browser: Optional[Browser] = None,
+            threshold: Optional[float] = None,
+            suffix: Optional[str] = None,
+        ) -> bool:
+            pass
+
+    __all__ = ["screenshot_regression"]
+
+    @pytest.fixture(scope="function")
+    def screenshot_regression(
+        browser: Browser,
+        image_regression: ImageRegressionCallableType,
+        image_diff_threshold: float,
+    ) -> Generator[ScreenshotRegressionCallableType, None, None]:
+        """
+        Check regression browser screenshot
+
+        :param browser: optional, by default from `browser` fixture
+        :param threshold: float, by default from `image_diff_threshold`
+        :param suffix: str, need for multiple checks  by one test
+        """
+        default_browser = browser
+
+        def _factory(
+            browser: Optional[Browser] = None,
+            threshold: Optional[float] = None,
+            suffix: Optional[str] = "",
+        ) -> bool:
+            if browser is None:
+                browser = default_browser
+
+            if threshold is None:
+                threshold = image_diff_threshold
+            tf = NamedTemporaryFile(suffix=".png")
+            image = tf.name
+            browser.driver.save_screenshot(image)
+            return image_regression(image, threshold, suffix)
+
+        yield _factory

setup.cfg

@@ -20,7 +20,7 @@ universal = 1
 
 [flake8]
 ignore = D203
-exclude = 
+exclude =
 	.git/,
 	.tox/,
 	docs/,

tox.ini

@@ -9,14 +9,17 @@ changedir = {toxinidir}
 deps =
     -r{toxinidir}/requirements-dev.txt
     splinter: -e .[splinter]
-
+setenv =
+    PYTHONPATH = {toxinidir}
 passenv =
     CI
     TRAVIS
     TRAVIS_*
 
 commands =
-    py.test  --basetemp={envtmpdir} -v --cov --cov-report term-missing {posargs}
+    py.test  --basetemp={envtmpdir} -v \
+        --cov pytest_image_diff \
+        --cov-report term-missing {posargs}
 
 [testenv:qa]
 description = Lint