neulab/docprompting-conala huggingface dataset:
class test.support.DirsOnSysPath(*paths)  
A context manager to temporarily add directories to sys.path. This makes a copy of sys.path, appends any directories given as positional arguments, then reverts sys.path to the copied settings when the context ends. Note that all sys.path modifications in the body of the context manager, including replacement of the object, will be reverted at the end of the block.
test.support.disable_faulthandler()  
A context manager that replaces sys.stderr with sys.__stderr__.
test.support.disable_gc()  
A context manager that disables the garbage collector upon entry and reenables it upon exit.
class test.support.EnvironmentVarGuard  
Class used to temporarily set or unset environment variables. Instances can be used as a context manager and have a complete dictionary interface for querying/modifying the underlying os.environ. After exit from the context manager all changes to environment variables done through this instance will be rolled back.  Changed in version 3.1: Added dictionary interface.
EnvironmentVarGuard.set(envvar, value)  
Temporarily set the environment variable envvar to the value of value.
EnvironmentVarGuard.unset(envvar)  
Temporarily unset the environment variable envvar.
class test.support.FakePath(path)  
Simple path-like object. It implements the __fspath__() method which just returns the path argument. If path is an exception, it will be raised in __fspath__().
test.support.findfile(filename, subdir=None)  
Return the path to the file named filename. If no match is found filename is returned. This does not equal a failure since it could be the path to the file. Setting subdir indicates a relative path to use to find the file rather than looking directly in the path directories.
test.support.forget(module_name)  
Remove the module named module_name from sys.modules and delete any byte-compiled files of the module.
test.support.fs_is_case_insensitive(directory)  
Return True if the file system for directory is case-insensitive.
test.support.FS_NONASCII  
A non-ASCII character encodable by os.fsencode().
test.support.gc_collect()  
Force as many objects as possible to be collected. This is needed because timely deallocation is not guaranteed by the garbage collector. This means that __del__ methods may be called later than expected and weakrefs may remain alive for longer than expected.
test.support.get_attribute(obj, name)  
Get an attribute, raising unittest.SkipTest if AttributeError is raised.
test.support.get_original_stdout()  
Return the original stdout set by record_original_stdout() or sys.stdout if it’s not set.
test.support.HAVE_DOCSTRINGS  
Check for presence of docstrings.
@test.support.impl_detail(msg=None, **guards)  
Decorator for invoking check_impl_detail() on guards. If that returns False, then uses msg as the reason for skipping the test.
test.support.import_fresh_module(name, fresh=(), blocked=(), deprecated=False)  
This function imports and returns a fresh copy of the named Python module by removing the named module from sys.modules before doing the import. Note that unlike reload(), the original module is not affected by this operation. fresh is an iterable of additional module names that are also removed from the sys.modules cache before doing the import. blocked is an iterable of module names that are replaced with None in the module cache during the import to ensure that attempts to import them raise ImportError. The named module and any modules named in the fresh and blocked parameters are saved before starting the import and then reinserted into sys.modules when the fresh import is complete. Module and package deprecation messages are suppressed during this import if deprecated is True. This function will raise ImportError if the named module cannot be imported. Example use: # Get copies of the warnings module for testing without affecting the
# version being used by the rest of the test suite. One copy uses the
# C implementation, the other is forced to use the pure Python fallback
# implementation
py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
c_warnings = import_fresh_module('warnings', fresh=['_warnings'])
  New in version 3.1.
test.support.import_module(name, deprecated=False, *, required_on())  
This function imports and returns the named module. Unlike a normal import, this function raises unittest.SkipTest if the module cannot be imported. Module and package deprecation messages are suppressed during this import if deprecated is True. If a module is required on a platform but optional for others, set required_on to an iterable of platform prefixes which will be compared against sys.platform.  New in version 3.1.
test.support.INTERNET_TIMEOUT  
Timeout in seconds for network requests going to the Internet. The timeout is short enough to prevent a test to wait for too long if the Internet request is blocked for whatever reason. Usually, a timeout using INTERNET_TIMEOUT should not mark a test as failed, but skip the test instead: see transient_internet(). Its default value is 1 minute. See also LOOPBACK_TIMEOUT.
test.support.is_resource_enabled(resource)  
Return True if resource is enabled and available. The list of available resources is only set when test.regrtest is executing the tests.
test.support.join_thread(thread, timeout=30.0)  
Join a thread within timeout. Raise an AssertionError if thread is still alive after timeout seconds.
test.support.LARGEST  
Object that is greater than anything (except itself). Used to test mixed type comparison.
test.support.load_package_tests(pkg_dir, loader, standard_tests, pattern)  
Generic implementation of the unittest load_tests protocol for use in test packages. pkg_dir is the root directory of the package; loader, standard_tests, and pattern are the arguments expected by load_tests. In simple cases, the test package’s __init__.py can be the following: import os
from test.support import load_package_tests

def load_tests(*args):
    return load_package_tests(os.path.dirname(__file__), *args)
test.support.LONG_TIMEOUT  
Timeout in seconds to detect when a test hangs. It is long enough to reduce the risk of test failure on the slowest Python buildbots. It should not be used to mark a test as failed if the test takes “too long”. The timeout value depends on the regrtest --timeout command line option. Its default value is 5 minutes. See also LOOPBACK_TIMEOUT, INTERNET_TIMEOUT and SHORT_TIMEOUT.
test.support.LOOPBACK_TIMEOUT  
Timeout in seconds for tests using a network server listening on the network local loopback interface like 127.0.0.1. The timeout is long enough to prevent test failure: it takes into account that the client and the server can run in different threads or even different processes. The timeout should be long enough for connect(), recv() and send() methods of socket.socket. Its default value is 5 seconds. See also INTERNET_TIMEOUT.
test.support.make_bad_fd()  
Create an invalid file descriptor by opening and closing a temporary file, and returning its descriptor.
test.support.make_legacy_pyc(source)  
Move a PEP 3147/PEP 488 pyc file to its legacy pyc location and return the file system path to the legacy pyc file. The source value is the file system path to the source file. It does not need to exist, however the PEP 3147/488 pyc file must exist.
class test.support.Matcher  
 
matches(self, d, **kwargs)  
Try to match a single dict with the supplied arguments. 
  
match_value(self, k, dv, v)  
Try to match a single stored value (dv) with a supplied value (v).
matches(self, d, **kwargs)  
Try to match a single dict with the supplied arguments.
match_value(self, k, dv, v)  
Try to match a single stored value (dv) with a supplied value (v).
test.support.match_test(test)  
Match test to patterns set in set_match_tests().
test.support.max_memuse  
Set by set_memlimit() as the memory limit for big memory tests. Limited by MAX_Py_ssize_t.
test.support.MAX_Py_ssize_t  
Set to sys.maxsize for big memory tests.
test.support.missing_compiler_executable(cmd_names=[])  
Check for the existence of the compiler executables whose names are listed in cmd_names or all the compiler executables when cmd_names is empty and return the first missing executable or None when none is found missing.
test.support.MISSING_C_DOCSTRINGS  
Return True if running on CPython, not on Windows, and configuration not set with WITH_DOC_STRINGS.
test.support.modules_cleanup(oldmodules)  
Remove modules except for oldmodules and encodings in order to preserve internal cache.
test.support.NEVER_EQ  
Object that is not equal to anything (even to ALWAYS_EQ). Used to test mixed type comparison.
@test.support.no_tracing(func)  
Decorator to temporarily turn off tracing for the duration of the test.
test.support.open_urlresource(url, *args, **kw)  
Open url. If open fails, raises TestFailed.
test.support.optim_args_from_interpreter_flags()  
Return a list of command line arguments reproducing the current optimization settings in sys.flags.
test.support.patch(test_instance, object_to_patch, attr_name, new_value)  
Override object_to_patch.attr_name with new_value. Also add cleanup procedure to test_instance to restore object_to_patch for attr_name. The attr_name should be a valid attribute for object_to_patch.
test.support.PGO  
Set when tests can be skipped when they are not useful for PGO.
test.support.PIPE_MAX_SIZE  
A constant that is likely larger than the underlying OS pipe buffer size, to make writes blocking.
test.support.print_warning(msg)  
Print a warning into sys.__stderr__. Format the message as: f"Warning -- {msg}". If msg is made of multiple lines, add "Warning -- " prefix to each line.  New in version 3.9.
test.support.python_is_optimized()  
Return True if Python was not built with -O0 or -Og.
test.support.real_max_memuse  
Set by set_memlimit() as the memory limit for big memory tests. Not limited by MAX_Py_ssize_t.
test.support.reap_children()  
Use this at the end of test_main whenever sub-processes are started. This will help ensure that no extra children (zombies) stick around to hog resources and create problems when looking for refleaks.
@test.support.reap_threads(func)  
Decorator to ensure the threads are cleaned up even if the test fails.
test.support.record_original_stdout(stdout)  
Store the value from stdout. It is meant to hold the stdout at the time the regrtest began.
@test.support.refcount_test(test)  
Decorator for tests which involve reference counting. The decorator does not run the test if it is not run by CPython. Any trace function is unset for the duration of the test to prevent unexpected refcounts caused by the trace function.
test.support.requires(resource, msg=None)  
Raise ResourceDenied if resource is not available. msg is the argument to ResourceDenied if it is raised. Always returns True if called by a function whose __name__ is '__main__'. Used when tests are executed by test.regrtest.
@test.support.requires_bz2  
Decorator for skipping tests if bz2 doesn’t exist.
@test.support.requires_docstrings  
Decorator for only running the test if HAVE_DOCSTRINGS.
@test.support.requires_freebsd_version(*min_version)  
Decorator for the minimum version when running test on FreeBSD. If the FreeBSD version is less than the minimum, raise unittest.SkipTest.
@test.support.requires_gzip  
Decorator for skipping tests if gzip doesn’t exist.
@test.support.requires_IEEE_754  
Decorator for skipping tests on non-IEEE 754 platforms.
@test.support.requires_linux_version(*min_version)  
Decorator for the minimum version when running test on Linux. If the Linux version is less than the minimum, raise unittest.SkipTest.
@test.support.requires_lzma  
Decorator for skipping tests if lzma doesn’t exist.
@test.support.requires_mac_version(*min_version)  
Decorator for the minimum version when running test on Mac OS X. If the MAC OS X version is less than the minimum, raise unittest.SkipTest.
@test.support.requires_resource(resource)  
Decorator for skipping tests if resource is not available.
@test.support.requires_zlib  
Decorator for skipping tests if zlib doesn’t exist.
exception test.support.ResourceDenied  
Subclass of unittest.SkipTest. Raised when a resource (such as a network connection) is not available. Raised by the requires() function.
test.support.rmdir(filename)  
Call os.rmdir() on filename. On Windows platforms, this is wrapped with a wait loop that checks for the existence of the file.
test.support.rmtree(path)  
Call shutil.rmtree() on path or call os.lstat() and os.rmdir() to remove a path and its contents. On Windows platforms, this is wrapped with a wait loop that checks for the existence of the files.
test.support.run_doctest(module, verbosity=None, optionflags=0)  
Run doctest.testmod() on the given module. Return (failure_count, test_count). If verbosity is None, doctest.testmod() is run with verbosity set to verbose. Otherwise, it is run with verbosity set to None. optionflags is passed as optionflags to doctest.testmod().
test.support.run_in_subinterp(code)  
Run code in subinterpreter. Raise unittest.SkipTest if tracemalloc is enabled.
test.support.run_unittest(*classes)  
Execute unittest.TestCase subclasses passed to the function. The function scans the classes for methods starting with the prefix test_ and executes the tests individually. It is also legal to pass strings as parameters; these should be keys in sys.modules. Each associated module will be scanned by unittest.TestLoader.loadTestsFromModule(). This is usually seen in the following test_main() function: def test_main():
    support.run_unittest(__name__)
 This will run all tests defined in the named module.
@test.support.run_with_locale(catstr, *locales)  
A decorator for running a function in a different locale, correctly resetting it after it has finished. catstr is the locale category as a string (for example "LC_ALL"). The locales passed will be tried sequentially, and the first valid locale will be used.
@test.support.run_with_tz(tz)  
A decorator for running a function in a specific timezone, correctly resetting it after it has finished.
class test.support.SaveSignals  
Class to save and restore signal handlers registered by the Python signal handler.
test.support.script_helper.assert_python_failure(*args, **env_vars)  
Assert that running the interpreter with args and optional environment variables env_vars fails (rc != 0) and return a (return code,
stdout, stderr) tuple. See assert_python_ok() for more options.  Changed in version 3.9: The function no longer strips whitespaces from stderr.
test.support.script_helper.assert_python_ok(*args, **env_vars)  
Assert that running the interpreter with args and optional environment variables env_vars succeeds (rc == 0) and return a (return code,
stdout, stderr) tuple. If the __cleanenv keyword is set, env_vars is used as a fresh environment. Python is started in isolated mode (command line option -I), except if the __isolated keyword is set to False.  Changed in version 3.9: The function no longer strips whitespaces from stderr.
test.support.script_helper.interpreter_requires_environment()  
Return True if sys.executable interpreter requires environment variables in order to be able to run at all. This is designed to be used with @unittest.skipIf() to annotate tests that need to use an assert_python*() function to launch an isolated mode (-I) or no environment mode (-E) sub-interpreter process. A normal build & test does not run into this situation but it can happen when trying to run the standard library test suite from an interpreter that doesn’t have an obvious home with Python’s current home finding logic. Setting PYTHONHOME is one way to get most of the testsuite to run in that situation. PYTHONPATH or PYTHONUSERSITE are other common environment variables that might impact whether or not the interpreter can start.
test.support.script_helper.kill_python(p)  
Run the given subprocess.Popen process until completion and return stdout.
test.support.script_helper.make_pkg(pkg_dir, init_source='')  
Create a directory named pkg_dir containing an __init__ file with init_source as its contents.
test.support.script_helper.make_script(script_dir, script_basename, source, omit_suffix=False)  
Create script containing source in path script_dir and script_basename. If omit_suffix is False, append .py to the name. Return the full script path.
test.support.script_helper.make_zip_pkg(zip_dir, zip_basename, pkg_name, script_basename, source, depth=1, compiled=False)  
Create a zip package directory with a path of zip_dir and zip_basename containing an empty __init__ file and a file script_basename containing the source. If compiled is True, both source files will be compiled and added to the zip package. Return a tuple of the full zip path and the archive name for the zip file.
test.support.script_helper.make_zip_script(zip_dir, zip_basename, script_name, name_in_zip=None)  
Create zip file at zip_dir and zip_basename with extension zip which contains the files in script_name. name_in_zip is the archive name. Return a tuple containing (full path, full path of archive name).
test.support.script_helper.run_python_until_end(*args, **env_vars)  
Set up the environment based on env_vars for running the interpreter in a subprocess. The values can include __isolated, __cleanenv, __cwd, and TERM.  Changed in version 3.9: The function no longer strips whitespaces from stderr.
test.support.script_helper.spawn_python(*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)  
Run a Python subprocess with the given arguments. kw is extra keyword args to pass to subprocess.Popen(). Returns a subprocess.Popen object.
test.support.setswitchinterval(interval)  
Set the sys.setswitchinterval() to the given interval. Defines a minimum interval for Android systems to prevent the system from hanging.
test.support.set_match_tests(patterns)  
Define match test with regular expression patterns.
test.support.set_memlimit(limit)  
Set the values for max_memuse and real_max_memuse for big memory tests.
test.support.SHORT_TIMEOUT  
Timeout in seconds to mark a test as failed if the test takes “too long”. The timeout value depends on the regrtest --timeout command line option. If a test using SHORT_TIMEOUT starts to fail randomly on slow buildbots, use LONG_TIMEOUT instead. Its default value is 30 seconds.
@test.support.skip_unless_symlink  
A decorator for running tests that require support for symbolic links.
@test.support.skip_unless_xattr  
A decorator for running tests that require support for xattr.
test.support.SMALLEST  
Object that is less than anything (except itself). Used to test mixed type comparison.
test.support.socket_helper.bind_port(sock, host=HOST)  
Bind the socket to a free port and return the port number. Relies on ephemeral ports in order to ensure we are using an unbound port. This is important as many tests may be running simultaneously, especially in a buildbot environment. This method raises an exception if the sock.family is AF_INET and sock.type is SOCK_STREAM, and the socket has SO_REUSEADDR or SO_REUSEPORT set on it. Tests should never set these socket options for TCP/IP sockets. The only case for setting these options is testing multicasting via multiple UDP sockets. Additionally, if the SO_EXCLUSIVEADDRUSE socket option is available (i.e. on Windows), it will be set on the socket. This will prevent anyone else from binding to our host/port for the duration of the test.
test.support.socket_helper.bind_unix_socket(sock, addr)  
Bind a unix socket, raising unittest.SkipTest if PermissionError is raised.
test.support.socket_helper.find_unused_port(family=socket.AF_INET, socktype=socket.SOCK_STREAM)  
Returns an unused port that should be suitable for binding. This is achieved by creating a temporary socket with the same family and type as the sock parameter (default is AF_INET, SOCK_STREAM), and binding it to the specified host address (defaults to 0.0.0.0) with the port set to 0, eliciting an unused ephemeral port from the OS. The temporary socket is then closed and deleted, and the ephemeral port is returned. Either this method or bind_port() should be used for any tests where a server socket needs to be bound to a particular port for the duration of the test. Which one to use depends on whether the calling code is creating a Python socket, or if an unused port needs to be provided in a constructor or passed to an external program (i.e. the -accept argument to openssl’s s_server mode). Always prefer bind_port() over find_unused_port() where possible. Using a hard coded port is discouraged since it can make multiple instances of the test impossible to run simultaneously, which is a problem for buildbots.
test.support.socket_helper.IPV6_ENABLED  
Set to True if IPv6 is enabled on this host, False otherwise.
@test.support.socket_helper.skip_unless_bind_unix_socket  
A decorator for running tests that require a functional bind() for Unix sockets.
test.support.socket_helper.transient_internet(resource_name, *, timeout=30.0, errnos=())  
A context manager that raises ResourceDenied when various issues with the internet connection manifest themselves as exceptions.
test.support.SOCK_MAX_SIZE  
A constant that is likely larger than the underlying OS socket buffer size, to make writes blocking.
test.support.start_threads(threads, unlock=None)  
Context manager to start threads. It attempts to join the threads upon exit.
class test.support.SuppressCrashReport  
A context manager used to try to prevent crash dialog popups on tests that are expected to crash a subprocess. On Windows, it disables Windows Error Reporting dialogs using SetErrorMode. On UNIX, resource.setrlimit() is used to set resource.RLIMIT_CORE’s soft limit to 0 to prevent coredump file creation. On both platforms, the old value is restored by __exit__().
test.support.swap_attr(obj, attr, new_val)  
Context manager to swap out an attribute with a new object. Usage: with swap_attr(obj, "attr", 5):
    ...
 This will set obj.attr to 5 for the duration of the with block, restoring the old value at the end of the block. If attr doesn’t exist on obj, it will be created and then deleted at the end of the block. The old value (or None if it doesn’t exist) will be assigned to the target of the “as” clause, if there is one.
test.support.swap_item(obj, attr, new_val)  
Context manager to swap out an item with a new object. Usage: with swap_item(obj, "item", 5):
    ...
 This will set obj["item"] to 5 for the duration of the with block, restoring the old value at the end of the block. If item doesn’t exist on obj, it will be created and then deleted at the end of the block. The old value (or None if it doesn’t exist) will be assigned to the target of the “as” clause, if there is one.
test.support.system_must_validate_cert(f)  
Raise unittest.SkipTest on TLS certification validation failures.
test.support.temp_cwd(name='tempcwd', quiet=False)  
A context manager that temporarily creates a new directory and changes the current working directory (CWD). The context manager creates a temporary directory in the current directory with name name before temporarily changing the current working directory. If name is None, the temporary directory is created using tempfile.mkdtemp(). If quiet is False and it is not possible to create or change the CWD, an error is raised. Otherwise, only a warning is raised and the original CWD is used.
test.support.temp_dir(path=None, quiet=False)  
A context manager that creates a temporary directory at path and yields the directory. If path is None, the temporary directory is created using tempfile.mkdtemp(). If quiet is False, the context manager raises an exception on error. Otherwise, if path is specified and cannot be created, only a warning is issued.
test.support.temp_umask(umask)  
A context manager that temporarily sets the process umask.
exception test.support.TestFailed  
Exception to be raised when a test fails. This is deprecated in favor of unittest-based tests and unittest.TestCase’s assertion methods.
test.support.TESTFN  
Set to a name that is safe to use as the name of a temporary file. Any temporary file that is created should be closed and unlinked (removed).
test.support.TESTFN_ENCODING  
Set to sys.getfilesystemencoding().
test.support.TESTFN_NONASCII  
Set to a filename containing the FS_NONASCII character.