ran blacken-docs

Author: boris

doc/en/assert.rst

@@ -238,7 +238,10 @@ file which provides an alternative explanation for ``Foo`` objects:
 
    def pytest_assertrepr_compare(op, left, right):
        if isinstance(left, Foo) and isinstance(right, Foo) and op == "==":
-           return ["Comparing Foo instances:", "   vals: {} != {}".format(left.val, right.val)]
+           return [
+               "Comparing Foo instances:",
+               "   vals: {} != {}".format(left.val, right.val),
+           ]
 
 now, given this test module:
 

doc/en/builtin.rst

@@ -167,4 +167,5 @@ You can also interactively ask for help, e.g. by typing on the Python interactiv
 .. code-block:: python
 
     import pytest
+
     help(pytest)

doc/en/cache.rst

@@ -40,10 +40,11 @@ First, let's create 50 test invocation of which only 2 fail::
     # content of test_50.py
     import pytest
 
+
     @pytest.mark.parametrize("i", range(50))
     def test_num(i):
         if i in (17, 25):
-           pytest.fail("bad luck")
+            pytest.fail("bad luck")
 
 If you run this for the first time you will see two failures:
 
@@ -193,9 +194,11 @@ across pytest invocations::
     import pytest
     import time
 
+
     def expensive_computation():
         print("running expensive computation...")
 
+
     @pytest.fixture
     def mydata(request):
         val = request.config.cache.get("example/value", None)
@@ -205,6 +208,7 @@ across pytest invocations::
             request.config.cache.set("example/value", val)
         return val
 
+
     def test_function(mydata):
         assert mydata == 23
 

doc/en/capture.rst

@@ -55,12 +55,15 @@ is that you can use print statements for debugging::
 
     # content of test_module.py
 
+
     def setup_function(function):
         print("setting up %s" % function)
 
+
     def test_func1():
         assert True
 
+
     def test_func2():
         assert False
 

doc/en/doctest.rst

@@ -197,9 +197,11 @@ place the objects you want to appear in the doctest namespace::
 
     # content of conftest.py
     import numpy
+
+
     @pytest.fixture(autouse=True)
     def add_np(doctest_namespace):
-        doctest_namespace['np'] = numpy
+        doctest_namespace["np"] = numpy
 
 which can then be used in your doctests directly::
 

doc/en/example/parametrize.rst

@@ -25,6 +25,7 @@ line argument.  Let's first write a simple (do-nothing) computation test::
 
     # content of test_compute.py
 
+
     def test_compute(param1):
         assert param1 < 4
 
@@ -34,13 +35,14 @@ Now we add a test configuration like this::
 
     # content of conftest.py
 
+
     def pytest_addoption(parser):
-        parser.addoption("--all", action="store_true",
-            help="run all combinations")
+        parser.addoption("--all", action="store_true", help="run all combinations")
+
 
     def pytest_generate_tests(metafunc):
-        if 'param1' in metafunc.fixturenames:
-            if metafunc.config.getoption('all'):
+        if "param1" in metafunc.fixturenames:
+            if metafunc.config.getoption("all"):
                 end = 5
             else:
                 end = 2
@@ -118,20 +120,26 @@ the argument name::
     def idfn(val):
         if isinstance(val, (datetime,)):
             # note this wouldn't show any hours/minutes/seconds
-            return val.strftime('%Y%m%d')
+            return val.strftime("%Y%m%d")
 
 
     @pytest.mark.parametrize("a,b,expected", testdata, ids=idfn)
     def test_timedistance_v2(a, b, expected):
         diff = a - b
         assert diff == expected
 
-    @pytest.mark.parametrize("a,b,expected", [
-        pytest.param(datetime(2001, 12, 12), datetime(2001, 12, 11),
-                     timedelta(1), id='forward'),
-        pytest.param(datetime(2001, 12, 11), datetime(2001, 12, 12),
-                     timedelta(-1), id='backward'),
-    ])
+
+    @pytest.mark.parametrize(
+        "a,b,expected",
+        [
+            pytest.param(
+                datetime(2001, 12, 12), datetime(2001, 12, 11), timedelta(1), id="forward"
+            ),
+            pytest.param(
+                datetime(2001, 12, 11), datetime(2001, 12, 12), timedelta(-1), id="backward"
+            ),
+        ],
+    )
     def test_timedistance_v3(a, b, expected):
         diff = a - b
         assert diff == expected
@@ -183,6 +191,7 @@ only have to work a bit to construct the correct arguments for pytest's
 
     # content of test_scenarios.py
 
+
     def pytest_generate_tests(metafunc):
         idlist = []
         argvalues = []
@@ -193,8 +202,10 @@ only have to work a bit to construct the correct arguments for pytest's
             argvalues.append([x[1] for x in items])
         metafunc.parametrize(argnames, argvalues, ids=idlist, scope="class")
 
-    scenario1 = ('basic', {'attribute': 'value'})
-    scenario2 = ('advanced', {'attribute': 'value2'})
+
+    scenario1 = ("basic", {"attribute": "value"})
+    scenario2 = ("advanced", {"attribute": "value2"})
+
 
     class TestSampleWithScenarios:
         scenarios = [scenario1, scenario2]
@@ -259,6 +270,8 @@ the actual test requiring a ``db`` object::
     # content of test_backends.py
 
     import pytest
+
+
     def test_db_initialized(db):
         # a dummy test
         if db.__class__.__name__ == "DB2":
@@ -273,15 +286,20 @@ creates a database object for the actual test invocations::
     # content of conftest.py
     import pytest
 
+
     def pytest_generate_tests(metafunc):
-        if 'db' in metafunc.fixturenames:
-            metafunc.parametrize("db", ['d1', 'd2'], indirect=True)
+        if "db" in metafunc.fixturenames:
+            metafunc.parametrize("db", ["d1", "d2"], indirect=True)
+
 
     class DB1:
         "one database object"
+
+
     class DB2:
         "alternative database object"
 
+
     @pytest.fixture
     def db(request):
         if request.param == "d1":
@@ -346,18 +364,22 @@ will be passed to respective fixture function::
     # content of test_indirect_list.py
 
     import pytest
-    @pytest.fixture(scope='function')
+
+
+    @pytest.fixture(scope="function")
     def x(request):
         return request.param * 3
 
-    @pytest.fixture(scope='function')
+
+    @pytest.fixture(scope="function")
     def y(request):
         return request.param * 2
 
-    @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=['x'])
-    def test_indirect(x,y):
-        assert x == 'aaa'
-        assert y == 'b'
+
+    @pytest.mark.parametrize("x, y", [("a", "b")], indirect=["x"])
+    def test_indirect(x, y):
+        assert x == "aaa"
+        assert y == "b"
 
 The result of this test will be successful:
 
@@ -391,18 +413,21 @@ parametrizer`_ but in a lot less code::
     # content of ./test_parametrize.py
     import pytest
 
+
     def pytest_generate_tests(metafunc):
         # called once per each test function
         funcarglist = metafunc.cls.params[metafunc.function.__name__]
         argnames = sorted(funcarglist[0])
-        metafunc.parametrize(argnames, [[funcargs[name] for name in argnames]
-                for funcargs in funcarglist])
+        metafunc.parametrize(
+            argnames, [[funcargs[name] for name in argnames] for funcargs in funcarglist]
+        )
+
 
     class TestClass:
         # a map specifying multiple argument sets for a test method
         params = {
-            'test_equals': [dict(a=1, b=2), dict(a=3, b=3), ],
-            'test_zerodivision': [dict(a=1, b=0), ],
+            "test_equals": [dict(a=1, b=2), dict(a=3, b=3)],
+            "test_zerodivision": [dict(a=1, b=0)],
         }
 
         def test_equals(self, a, b):
@@ -471,10 +496,12 @@ need to provide similar results::
 
     import pytest
 
+
     @pytest.fixture(scope="session")
     def basemod(request):
         return pytest.importorskip("base")
 
+
     @pytest.fixture(scope="session", params=["opt1", "opt2"])
     def optmod(request):
         return pytest.importorskip(request.param)
@@ -501,6 +528,7 @@ And finally a little test module::
 
     # content of test_module.py
 
+
     def test_func1(basemod, optmod):
         assert round(basemod.func1(), 3) == round(optmod.func1(), 3)
 
@@ -610,17 +638,21 @@ as a complement to ``raises``. For example::
     from contextlib import contextmanager
     import pytest
 
+
     @contextmanager
     def does_not_raise():
         yield
 
 
-    @pytest.mark.parametrize('example_input,expectation', [
-        (3, does_not_raise()),
-        (2, does_not_raise()),
-        (1, does_not_raise()),
-        (0, pytest.raises(ZeroDivisionError)),
-    ])
+    @pytest.mark.parametrize(
+        "example_input,expectation",
+        [
+            (3, does_not_raise()),
+            (2, does_not_raise()),
+            (1, does_not_raise()),
+            (0, pytest.raises(ZeroDivisionError)),
+        ],
+    )
     def test_division(example_input, expectation):
         """Test how much I know division."""
         with expectation:

doc/en/example/pythoncollection.rst

@@ -139,6 +139,7 @@ that match ``*_check``. For example, if we have::
     class CheckMyApp:
         def simple_check(self):
             pass
+
         def complex_check(self):
             pass
 
@@ -267,7 +268,7 @@ and a ``setup.py`` dummy file like this::
 .. code-block:: python
 
     # content of setup.py
-    0/0  # will raise exception if imported
+    0 / 0  # will raise exception if imported
 
 If you run with a Python 2 interpreter then you will find the one test and will
 leave out the ``setup.py`` file:

doc/en/example/special.rst

@@ -13,6 +13,7 @@ calls it::
 
     import pytest
 
+
     @pytest.fixture(scope="session", autouse=True)
     def callattr_ahead_of_alltests(request):
         print("callattr_ahead_of_alltests called")
@@ -22,7 +23,7 @@ calls it::
             cls = item.getparent(pytest.Class)
             if cls not in seen:
                 if hasattr(cls.obj, "callme"):
-                   cls.obj.callme()
+                    cls.obj.callme()
                 seen.add(cls)
 
 test classes may now define a ``callme`` method which
@@ -32,6 +33,7 @@ will be called ahead of running any tests::
 
     # content of test_module.py
 
+
     class TestHello:
         @classmethod
         def callme(cls):
@@ -43,16 +45,20 @@ will be called ahead of running any tests::
         def test_method2(self):
             print("test_method1 called")
 
+
     class TestOther:
         @classmethod
         def callme(cls):
             print("callme other called")
+
         def test_other(self):
             print("test other")
 
+
     # works with unittest as well ...
     import unittest
 
+
     class SomeTest(unittest.TestCase):
         @classmethod
         def callme(self):