p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixup funcargs docs 

--HG--
branch : trunk
This commit is contained in:
holger krekel 2009-12-29 16:57:56 +01:00
parent db21cac694
commit 7780e74016
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/test/funcargs.txt
View File

@ -1,19 +1,15 @@
============================================================== ==============================================================
**funcargs**: advanced test setup and parametrization **funcargs**: advanced test parametrization
============================================================== ==============================================================
.. contents:: .. contents::
:local: :local:
:depth: 2 :depth: 2
what are "funcargs" and what are they good for? what is a "funcarg"?
================================================= =================================================
Named parameters of a test function are called *funcargs* for short. A *funcarg* is the short name for "test function argument". Each python test function invocation may receive one or multiple function arguments. Function argument values can be created next to the test code or in separate test configuration files which allows test functions to remain ignorant of how its base test values are created. A test function can also be called multiple times with different sets of function arguments, allowing for arbitrary parametrization. A Funcarg parameter can be any value, a simple number or an application object.
A Funcarg can be a simple number of a complex object. To perform a
test function call each parameter is setup by a factory function.
To call a test function repeatedly with different funcargs sets
test parameters can be generated.
.. _`contact possibilities`: ../contact.html .. _`contact possibilities`: ../contact.html
.. _`parametrizing tests, generalized`: http://tetamap.wordpress.com/2009/05/13/parametrizing-python-tests-generalized/ .. _`parametrizing tests, generalized`: http://tetamap.wordpress.com/2009/05/13/parametrizing-python-tests-generalized/
@ -25,7 +21,7 @@ test parameters can be generated.
.. _`funcarg factory`: .. _`funcarg factory`:
.. _factory: .. _factory:
funcarg factories: setting up test function arguments funcarg factories: creating test function arguments
============================================================== ==============================================================
Test functions can specify one ore more arguments ("funcargs") Test functions can specify one ore more arguments ("funcargs")
@ -92,9 +88,7 @@ functions or access meta data about a test.
funcarg factory request objects funcarg factory request objects
------------------------------------------ ------------------------------------------
Request objects are passed to funcarg factories and allow Request objects represents a handle on a specific python test function call. A request object is passed to a funcarg factory and provides access to test configuration and context as well as some `useful caching and finalization helpers`_. Here is a list of attributes:
to access test configuration, test context and `useful caching
and finalization helpers`_. Here is a list of attributes:
``request.function``: python function object requesting the argument ``request.function``: python function object requesting the argument