Source

pygame / test / README.TXT

Diff from to

test/README.TXT

 *** NOTE ***
 
 Be sure to import test_utils first at the top of your file, this will set the
-sys.path required for test.unittest to run, otherwise run_tests.py will work
+sys.path required for test.unittest to run, otherwise run_tests.py will not work
 properly
 
 import test_utils
 
 trunk/test/util/gen_stubs.py
 
-The gen_stubs.py utility will inspect pygame, and compile stubs of the each
+The gen_stubs.py utility will inspect pygame, and compile stubs of each of the
 module's callables (funcs, methods, getter/setters). It will include in the
 test's comment the __doc__ and the documentation found in the relevant xxxx.doc
 files. There is a naming convention in place that maps test names to callables
-in a one to one mapping. If there are no untested (or unstubbed) callables then
+in a one to one manner. If there are no untested (or unstubbed) callables then
 gen_stubs.py will output nothing.
 
 gen_stubs.py --help
 
     pygame.color.Color : color_test.ColorTypeTest
     pygame.color.Color : color_test.ColorTypeTestOtherAspect
-    
 
     *** NOTE *** 
-    
+
     Use the names of the instantiator helper functions:
-    
-        eg pygame.cdrom.CD and not pygame.cdrom.CDType    
 
-Each test should be name in the form,   test_$funcname__comment
+        eg pygame.cdrom.CD and not pygame.cdrom.CDType
+
+Each test should be named in the form, test_$funcname__$comment
 
     Surface.blit      : test_blit__raises_exception_if_locked
 
 There are three levels of tagging available, module level, TestCase level and
 individual test level.
 
-For class and module level tagging, assign a tag attribute __tags__ = []
+For class and module level tagging assign a tag attribute __tags__ = []
 
 Module Level Tags
 -----------------
 
+Include the module level tags in: 'some_module_tags.py'
+
+Where the module name is 'some_module' which has its tests in some_module_test.py
+
+This allows some modules to be excluded without loading some code in the first place.
+
+
+
 # some_module_test.py
 __tags__ = ['display', 'interactive']
 
 
     """
 
+
+
 *** NOTE *** 
 
 By default 'interactive' tags are not run
 
 run_tests.py --exclude display,slow for exclusion of tags
 
+However if you do python test/some_module_test.py all of the tests will run.
+
+See run_tests.py --help for more details.
+
+
+
 ================================================================================
 = test_utils.py =
 =================
 example_path(pth)
     Likewise but paths are relative to trunk\examples
 
-================================================================================
+================================================================================
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.