neulab/docprompting-conala huggingface dataset:
__class__  
Normally the __class__ attribute of an object will return its type. For a mock object with a spec, __class__ returns the spec class instead. This allows mock objects to pass isinstance() tests for the object they are replacing / masquerading as: >>> mock = Mock(spec=3)
>>> isinstance(mock, int)
True
 __class__ is assignable to, this allows a mock to pass an isinstance() check without forcing you to use a spec: >>> mock = Mock()
>>> mock.__class__ = dict
>>> isinstance(mock, dict)
True
__dir__()  
Mock objects limit the results of dir(some_mock) to useful results. For mocks with a spec this includes all the permitted attributes for the mock. See FILTER_DIR for what this filtering does, and how to switch it off.
unittest.mock.mock_open(mock=None, read_data=None)  
A helper function to create a mock to replace the use of open(). It works for open() called directly or used as a context manager. The mock argument is the mock object to configure. If None (the default) then a MagicMock will be created for you, with the API limited to methods or attributes available on standard file handles. read_data is a string for the read(), readline(), and readlines() methods of the file handle to return. Calls to those methods will take data from read_data until it is depleted. The mock of these methods is pretty simplistic: every time the mock is called, the read_data is rewound to the start. If you need more control over the data that you are feeding to the tested code you will need to customize this mock for yourself. When that is insufficient, one of the in-memory filesystem packages on PyPI can offer a realistic filesystem for testing.  Changed in version 3.4: Added readline() and readlines() support. The mock of read() changed to consume read_data rather than returning it on each call.   Changed in version 3.5: read_data is now reset on each call to the mock.   Changed in version 3.8: Added __iter__() to implementation so that iteration (such as in for loops) correctly consumes read_data.
class unittest.mock.NonCallableMagicMock(*args, **kw)  
A non-callable version of MagicMock. The constructor parameters have the same meaning as for MagicMock, with the exception of return_value and side_effect which have no meaning on a non-callable mock.
class unittest.mock.NonCallableMock(spec=None, wraps=None, name=None, spec_set=None, **kwargs)  
A non-callable version of Mock. The constructor parameters have the same meaning of Mock, with the exception of return_value and side_effect which have no meaning on a non-callable mock.
patch.dict(in_dict, values=(), clear=False, **kwargs)  
Patch a dictionary, or dictionary like object, and restore the dictionary to its original state after the test. in_dict can be a dictionary or a mapping like container. If it is a mapping then it must at least support getting, setting and deleting items plus iterating over keys. in_dict can also be a string specifying the name of the dictionary, which will then be fetched by importing it. values can be a dictionary of values to set in the dictionary. values can also be an iterable of (key, value) pairs. If clear is true then the dictionary will be cleared before the new values are set. patch.dict() can also be called with arbitrary keyword arguments to set values in the dictionary.  Changed in version 3.8: patch.dict() now returns the patched dictionary when used as a context manager.
patch.multiple(target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)  
Perform multiple patches in a single call. It takes the object to be patched (either as an object or a string to fetch the object by importing) and keyword arguments for the patches: with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...
 Use DEFAULT as the value if you want patch.multiple() to create mocks for you. In this case the created mocks are passed into a decorated function by keyword, and a dictionary is returned when patch.multiple() is used as a context manager. patch.multiple() can be used as a decorator, class decorator or a context manager. The arguments spec, spec_set, create, autospec and new_callable have the same meaning as for patch(). These arguments will be applied to all patches done by patch.multiple(). When used as a class decorator patch.multiple() honours patch.TEST_PREFIX for choosing which methods to wrap.
patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)  
patch the named member (attribute) on an object (target) with a mock object. patch.object() can be used as a decorator, class decorator or a context manager. Arguments new, spec, create, spec_set, autospec and new_callable have the same meaning as for patch(). Like patch(), patch.object() takes arbitrary keyword arguments for configuring the mock object it creates. When used as a class decorator patch.object() honours patch.TEST_PREFIX for choosing which methods to wrap.
class unittest.mock.PropertyMock(*args, **kwargs)  
A mock intended to be used as a property, or other descriptor, on a class. PropertyMock provides __get__() and __set__() methods so you can specify a return value when it is fetched. Fetching a PropertyMock instance from an object calls the mock, with no args. Setting it calls the mock with the value being set. >>> class Foo:
...     @property
...     def foo(self):
...         return 'something'
...     @foo.setter
...     def foo(self, value):
...         pass
...
>>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo:
...     mock_foo.return_value = 'mockity-mock'
...     this_foo = Foo()
...     print(this_foo.foo)
...     this_foo.foo = 6
...
mockity-mock
>>> mock_foo.mock_calls
[call(), call(6)]
unittest.mock.seal(mock)  
Seal will disable the automatic creation of mocks when accessing an attribute of the mock being sealed or any of its attributes that are already mocks recursively. If a mock instance with a name or a spec is assigned to an attribute it won’t be considered in the sealing chain. This allows one to prevent seal from fixing part of the mock object. >>> mock = Mock()
>>> mock.submock.attribute1 = 2
>>> mock.not_submock = mock.Mock(name="sample_name")
>>> seal(mock)
>>> mock.new_attribute  # This will raise AttributeError.
>>> mock.submock.attribute2  # This will raise AttributeError.
>>> mock.not_submock.attribute2  # This won't raise.
  New in version 3.7.
unittest.mock.sentinel  
The sentinel object provides a convenient way of providing unique objects for your tests. Attributes are created on demand when you access them by name. Accessing the same attribute will always return the same object. The objects returned have a sensible repr so that test failure messages are readable.  Changed in version 3.7: The sentinel attributes now preserve their identity when they are copied or pickled.
unittest.registerResult(result)  
Register a TestResult object for control-c handling. Registering a result stores a weak reference to it, so it doesn’t prevent the result from being garbage collected. Registering a TestResult object has no side-effects if control-c handling is not enabled, so test frameworks can unconditionally register all results they create independently of whether or not handling is enabled.
unittest.removeHandler(function=None)  
When called without arguments this function removes the control-c handler if it has been installed. This function can also be used as a test decorator to temporarily remove the handler while the test is being executed: @unittest.removeHandler
def test_signal_handling(self):
    ...
unittest.removeResult(result)  
Remove a registered result. Once a result has been removed then stop() will no longer be called on that result object in response to a control-c.
@unittest.skip(reason)  
Unconditionally skip the decorated test. reason should describe why the test is being skipped.
@unittest.skipIf(condition, reason)  
Skip the decorated test if condition is true.
exception unittest.SkipTest(reason)  
This exception is raised to skip a test. Usually you can use TestCase.skipTest() or one of the skipping decorators instead of raising this directly.
@unittest.skipUnless(condition, reason)  
Skip the decorated test unless condition is true.
classmethod addClassCleanup(function, /, *args, **kwargs)  
Add a function to be called after tearDownClass() to cleanup resources used during the test class. Functions will be called in reverse order to the order they are added (LIFO). They are called with any arguments and keyword arguments passed into addClassCleanup() when they are added. If setUpClass() fails, meaning that tearDownClass() is not called, then any cleanup functions added will still be called.  New in version 3.8.
addCleanup(function, /, *args, **kwargs)  
Add a function to be called after tearDown() to cleanup resources used during the test. Functions will be called in reverse order to the order they are added (LIFO). They are called with any arguments and keyword arguments passed into addCleanup() when they are added. If setUp() fails, meaning that tearDown() is not called, then any cleanup functions added will still be called.  New in version 3.1.
addTypeEqualityFunc(typeobj, function)  
Registers a type-specific method called by assertEqual() to check if two objects of exactly the same typeobj (not subclasses) compare equal. function must take two positional arguments and a third msg=None keyword argument just as assertEqual() does. It must raise self.failureException(msg) when inequality between the first two parameters is detected – possibly providing useful information and explaining the inequalities in details in the error message.  New in version 3.1.
assertAlmostEqual(first, second, places=7, msg=None, delta=None)  
assertNotAlmostEqual(first, second, places=7, msg=None, delta=None)  
Test that first and second are approximately (or not approximately) equal by computing the difference, rounding to the given number of decimal places (default 7), and comparing to zero. Note that these methods round the values to the given number of decimal places (i.e. like the round() function) and not significant digits. If delta is supplied instead of places then the difference between first and second must be less or equal to (or greater than) delta. Supplying both delta and places raises a TypeError.  Changed in version 3.2: assertAlmostEqual() automatically considers almost equal objects that compare equal. assertNotAlmostEqual() automatically fails if the objects compare equal. Added the delta keyword argument.
assertCountEqual(first, second, msg=None)  
Test that sequence first contains the same elements as second, regardless of their order. When they don’t, an error message listing the differences between the sequences will be generated. Duplicate elements are not ignored when comparing first and second. It verifies whether each element has the same count in both sequences. Equivalent to: assertEqual(Counter(list(first)), Counter(list(second))) but works with sequences of unhashable objects as well.  New in version 3.2.
assertDictEqual(first, second, msg=None)  
Test that two dictionaries are equal. If not, an error message is constructed that shows the differences in the dictionaries. This method will be used by default to compare dictionaries in calls to assertEqual().  New in version 3.1.
assertEqual(first, second, msg=None)  
Test that first and second are equal. If the values do not compare equal, the test will fail. In addition, if first and second are the exact same type and one of list, tuple, dict, set, frozenset or str or any type that a subclass registers with addTypeEqualityFunc() the type-specific equality function will be called in order to generate a more useful default error message (see also the list of type-specific methods).  Changed in version 3.1: Added the automatic calling of type-specific equality function.   Changed in version 3.2: assertMultiLineEqual() added as the default type equality function for comparing strings.
assertTrue(expr, msg=None)  
assertFalse(expr, msg=None)  
Test that expr is true (or false). Note that this is equivalent to bool(expr) is True and not to expr
is True (use assertIs(expr, True) for the latter). This method should also be avoided when more specific methods are available (e.g. assertEqual(a, b) instead of assertTrue(a == b)), because they provide a better error message in case of failure.
assertGreater(first, second, msg=None)  
assertGreaterEqual(first, second, msg=None)  
assertLess(first, second, msg=None)  
assertLessEqual(first, second, msg=None)  
Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail: >>> self.assertGreaterEqual(3, 4)
AssertionError: "3" unexpectedly not greater than or equal to "4"
  New in version 3.1.
assertIn(member, container, msg=None)  
assertNotIn(member, container, msg=None)  
Test that member is (or is not) in container.  New in version 3.1.
assertIs(first, second, msg=None)  
assertIsNot(first, second, msg=None)  
Test that first and second are (or are not) the same object.  New in version 3.1.
assertIsInstance(obj, cls, msg=None)  
assertNotIsInstance(obj, cls, msg=None)  
Test that obj is (or is not) an instance of cls (which can be a class or a tuple of classes, as supported by isinstance()). To check for the exact type, use assertIs(type(obj), cls).  New in version 3.2.
assertIsNone(expr, msg=None)  
assertIsNotNone(expr, msg=None)  
Test that expr is (or is not) None.  New in version 3.1.
assertListEqual(first, second, msg=None)  
assertTupleEqual(first, second, msg=None)  
Tests that two lists or tuples are equal. If not, an error message is constructed that shows only the differences between the two. An error is also raised if either of the parameters are of the wrong type. These methods are used by default when comparing lists or tuples with assertEqual().  New in version 3.1.
assertLogs(logger=None, level=None)  
A context manager to test that at least one message is logged on the logger or one of its children, with at least the given level. If given, logger should be a logging.Logger object or a str giving the name of a logger. The default is the root logger, which will catch all messages that were not blocked by a non-propagating descendent logger. If given, level should be either a numeric logging level or its string equivalent (for example either "ERROR" or logging.ERROR). The default is logging.INFO. The test passes if at least one message emitted inside the with block matches the logger and level conditions, otherwise it fails. The object returned by the context manager is a recording helper which keeps tracks of the matching log messages. It has two attributes:  
records  
A list of logging.LogRecord objects of the matching log messages. 
  
output  
A list of str objects with the formatted output of matching messages. 
 Example: with self.assertLogs('foo', level='INFO') as cm:
   logging.getLogger('foo').info('first message')
   logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])
  New in version 3.4.
assertMultiLineEqual(first, second, msg=None)  
Test that the multiline string first is equal to the string second. When not equal a diff of the two strings highlighting the differences will be included in the error message. This method is used by default when comparing strings with assertEqual().  New in version 3.1.
assertNotEqual(first, second, msg=None)  
Test that first and second are not equal. If the values do compare equal, the test will fail.
assertRegex(text, regex, msg=None)  
assertNotRegex(text, regex, msg=None)  
Test that a regex search matches (or does not match) text. In case of failure, the error message will include the pattern and the text (or the pattern and the part of text that unexpectedly matched). regex may be a regular expression object or a string containing a regular expression suitable for use by re.search().  New in version 3.1: Added under the name assertRegexpMatches.   Changed in version 3.2: The method assertRegexpMatches() has been renamed to assertRegex().   New in version 3.2: assertNotRegex().   New in version 3.5: The name assertNotRegexpMatches is a deprecated alias for assertNotRegex().
assertRaises(exception, callable, *args, **kwds)  
assertRaises(exception, *, msg=None)  
Test that an exception is raised when callable is called with any positional or keyword arguments that are also passed to assertRaises(). The test passes if exception is raised, is an error if another exception is raised, or fails if no exception is raised. To catch any of a group of exceptions, a tuple containing the exception classes may be passed as exception. If only the exception and possibly the msg arguments are given, return a context manager so that the code under test can be written inline rather than as a function: with self.assertRaises(SomeException):
    do_something()
 When used as a context manager, assertRaises() accepts the additional keyword argument msg. The context manager will store the caught exception object in its exception attribute. This can be useful if the intention is to perform additional checks on the exception raised: with self.assertRaises(SomeException) as cm:
    do_something()

the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)
  Changed in version 3.1: Added the ability to use assertRaises() as a context manager.   Changed in version 3.2: Added the exception attribute.   Changed in version 3.3: Added the msg keyword argument when used as a context manager.
assertRaisesRegex(exception, regex, callable, *args, **kwds)  
assertRaisesRegex(exception, regex, *, msg=None)  
Like assertRaises() but also tests that regex matches on the string representation of the raised exception. regex may be a regular expression object or a string containing a regular expression suitable for use by re.search(). Examples: self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
                       int, 'XYZ')
 or: with self.assertRaisesRegex(ValueError, 'literal'):
   int('XYZ')
  New in version 3.1: Added under the name assertRaisesRegexp.   Changed in version 3.2: Renamed to assertRaisesRegex().   Changed in version 3.3: Added the msg keyword argument when used as a context manager.
assertSequenceEqual(first, second, msg=None, seq_type=None)  
Tests that two sequences are equal. If a seq_type is supplied, both first and second must be instances of seq_type or a failure will be raised. If the sequences are different an error message is constructed that shows the difference between the two. This method is not called directly by assertEqual(), but it’s used to implement assertListEqual() and assertTupleEqual().  New in version 3.1.
assertSetEqual(first, second, msg=None)  
Tests that two sets are equal. If not, an error message is constructed that lists the differences between the sets. This method is used by default when comparing sets or frozensets with assertEqual(). Fails if either of first or second does not have a set.difference() method.  New in version 3.1.
assertWarns(warning, callable, *args, **kwds)  
assertWarns(warning, *, msg=None)  
Test that a warning is triggered when callable is called with any positional or keyword arguments that are also passed to assertWarns(). The test passes if warning is triggered and fails if it isn’t. Any exception is an error. To catch any of a group of warnings, a tuple containing the warning classes may be passed as warnings. If only the warning and possibly the msg arguments are given, return a context manager so that the code under test can be written inline rather than as a function: with self.assertWarns(SomeWarning):
    do_something()
 When used as a context manager, assertWarns() accepts the additional keyword argument msg. The context manager will store the caught warning object in its warning attribute, and the source line which triggered the warnings in the filename and lineno attributes. This can be useful if the intention is to perform additional checks on the warning caught: with self.assertWarns(SomeWarning) as cm:
    do_something()

self.assertIn('myfile.py', cm.filename)
self.assertEqual(320, cm.lineno)
 This method works regardless of the warning filters in place when it is called.  New in version 3.2.   Changed in version 3.3: Added the msg keyword argument when used as a context manager.
assertWarnsRegex(warning, regex, callable, *args, **kwds)  
assertWarnsRegex(warning, regex, *, msg=None)  
Like assertWarns() but also tests that regex matches on the message of the triggered warning. regex may be a regular expression object or a string containing a regular expression suitable for use by re.search(). Example: self.assertWarnsRegex(DeprecationWarning,
                      r'legacy_function\(\) is deprecated',
                      legacy_function, 'XYZ')
 or: with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    frobnicate('/etc/passwd')
  New in version 3.2.   Changed in version 3.3: Added the msg keyword argument when used as a context manager.
countTestCases()  
Return the number of tests represented by this test object. For TestCase instances, this will always be 1.
debug()  
Run the test without collecting the result. This allows exceptions raised by the test to be propagated to the caller, and can be used to support running tests under a debugger.
defaultTestResult()  
Return an instance of the test result class that should be used for this test case class (if no other result instance is provided to the run() method). For TestCase instances, this will always be an instance of TestResult; subclasses of TestCase should override this as necessary.
classmethod doClassCleanups()  
This method is called unconditionally after tearDownClass(), or after setUpClass() if setUpClass() raises an exception. It is responsible for calling all the cleanup functions added by addClassCleanup(). If you need cleanup functions to be called prior to tearDownClass() then you can call doClassCleanups() yourself. doClassCleanups() pops methods off the stack of cleanup functions one at a time, so it can be called at any time.  New in version 3.8.
doCleanups()  
This method is called unconditionally after tearDown(), or after setUp() if setUp() raises an exception. It is responsible for calling all the cleanup functions added by addCleanup(). If you need cleanup functions to be called prior to tearDown() then you can call doCleanups() yourself. doCleanups() pops methods off the stack of cleanup functions one at a time, so it can be called at any time.  New in version 3.1.
fail(msg=None)  
Signals a test failure unconditionally, with msg or None for the error message.
failureException  
This class attribute gives the exception raised by the test method. If a test framework needs to use a specialized exception, possibly to carry additional information, it must subclass this exception in order to “play fair” with the framework. The initial value of this attribute is AssertionError.
id()  
Return a string identifying the specific test case. This is usually the full name of the test method, including the module and class name.
longMessage  
This class attribute determines what happens when a custom failure message is passed as the msg argument to an assertXYY call that fails. True is the default value. In this case, the custom message is appended to the end of the standard failure message. When set to False, the custom message replaces the standard message. The class setting can be overridden in individual test methods by assigning an instance attribute, self.longMessage, to True or False before calling the assert methods. The class setting gets reset before each test call.  New in version 3.1.
maxDiff  
This attribute controls the maximum length of diffs output by assert methods that report diffs on failure. It defaults to 80*8 characters. Assert methods affected by this attribute are assertSequenceEqual() (including all the sequence comparison methods that delegate to it), assertDictEqual() and assertMultiLineEqual(). Setting maxDiff to None means that there is no maximum length of diffs.  New in version 3.2.