summaryrefslogtreecommitdiffstats
path: root/Lib/test/support
diff options
context:
space:
mode:
authorMartin Panter <vadmium+py@gmail.com>2015-11-21 10:57:15 (GMT)
committerMartin Panter <vadmium+py@gmail.com>2015-11-21 10:57:15 (GMT)
commit36befa5b4c37b34de9c7f59eba26575b255114cf (patch)
treed87a8cd77c6bbdfeb0e15a8320740da4051ab786 /Lib/test/support
parent266b276f34db5cc106d100f63b631af1f1f8e0e2 (diff)
parente99e97762cc75ad94056275ddcae9c84d63a3412 (diff)
downloadcpython-36befa5b4c37b34de9c7f59eba26575b255114cf.zip
cpython-36befa5b4c37b34de9c7f59eba26575b255114cf.tar.gz
cpython-36befa5b4c37b34de9c7f59eba26575b255114cf.tar.bz2
Issue #25626: Merge zlib fix from 3.5
Diffstat (limited to 'Lib/test/support')
-rw-r--r--Lib/test/support/__init__.py15
1 files changed, 9 insertions, 6 deletions
diff --git a/Lib/test/support/__init__.py b/Lib/test/support/__init__.py
index 728b459..2969b36 100644
--- a/Lib/test/support/__init__.py
+++ b/Lib/test/support/__init__.py
@@ -1610,12 +1610,15 @@ class _MemoryWatchdog:
def bigmemtest(size, memuse, dry_run=True):
"""Decorator for bigmem tests.
- 'minsize' is the minimum useful size for the test (in arbitrary,
- test-interpreted units.) 'memuse' is the number of 'bytes per size' for
- the test, or a good estimate of it.
-
- if 'dry_run' is False, it means the test doesn't support dummy runs
- when -M is not specified.
+ 'size' is a requested size for the test (in arbitrary, test-interpreted
+ units.) 'memuse' is the number of bytes per unit for the test, or a good
+ estimate of it. For example, a test that needs two byte buffers, of 4 GiB
+ each, could be decorated with @bigmemtest(size=_4G, memuse=2).
+
+ The 'size' argument is normally passed to the decorated test method as an
+ extra argument. If 'dry_run' is true, the value passed to the test method
+ may be less than the requested value. If 'dry_run' is false, it means the
+ test doesn't support dummy runs when -M is not specified.
"""
def decorator(f):
def wrapper(self):