Merge pull request #3014 from nicoddemus/cap-named-tuple
Change capture docs to use namedtuple
This commit is contained in:
		
						commit
						964c29cb93
					
				| 
						 | 
					@ -92,14 +92,14 @@ an example test function that performs some output related checks:
 | 
				
			||||||
.. code-block:: python
 | 
					.. code-block:: python
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def test_myoutput(capsys): # or use "capfd" for fd-level
 | 
					    def test_myoutput(capsys): # or use "capfd" for fd-level
 | 
				
			||||||
        print ("hello")
 | 
					        print("hello")
 | 
				
			||||||
        sys.stderr.write("world\n")
 | 
					        sys.stderr.write("world\n")
 | 
				
			||||||
        out, err = capsys.readouterr()
 | 
					        captured = capsys.readouterr()
 | 
				
			||||||
        assert out == "hello\n"
 | 
					        assert captured.out == "hello\n"
 | 
				
			||||||
        assert err == "world\n"
 | 
					        assert captured.err == "world\n"
 | 
				
			||||||
        print ("next")
 | 
					        print("next")
 | 
				
			||||||
        out, err = capsys.readouterr()
 | 
					        captured = capsys.readouterr()
 | 
				
			||||||
        assert out == "next\n"
 | 
					        assert captured.out == "next\n"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The ``readouterr()`` call snapshots the output so far -
 | 
					The ``readouterr()`` call snapshots the output so far -
 | 
				
			||||||
and capturing will be continued.  After the test
 | 
					and capturing will be continued.  After the test
 | 
				
			||||||
| 
						 | 
					@ -117,6 +117,10 @@ system level output streams (FD1 and FD2).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.. versionadded:: 3.3
 | 
					.. versionadded:: 3.3
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The return value from ``readouterr`` changed to a ``namedtuple`` with two attributes, ``out`` and ``err``.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					.. versionadded:: 3.3
 | 
				
			||||||
 | 
					
 | 
				
			||||||
If the code under test writes non-textual data, you can capture this using
 | 
					If the code under test writes non-textual data, you can capture this using
 | 
				
			||||||
the ``capsysbinary`` fixture which instead returns ``bytes`` from
 | 
					the ``capsysbinary`` fixture which instead returns ``bytes`` from
 | 
				
			||||||
the ``readouterr`` method.  The ``capfsysbinary`` fixture is currently only
 | 
					the ``readouterr`` method.  The ``capfsysbinary`` fixture is currently only
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue