VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2025-12-20 02:41:16 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

stdlib: add argument default values (#9501)

Browse Source
This commit is contained in:
Jelle Zijlstra
2023-01-18 00:37:34 -08:00
committed by GitHub
parent 6cb934291f
commit ddfaca3200
272 changed files with 2529 additions and 2467 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
stdlib/unittest/case.pyi
View File

@@ -94,7 +94,7 @@ class TestCase:
_testMethodName: str
# undocumented
_testMethodDoc: str
def __init__(self, methodName: str = ...) -> None: ...
def __init__(self, methodName: str = "runTest") -> None: ...
def __eq__(self, other: object) -> bool: ...
def setUp(self) -> None: ...
def tearDown(self) -> None: ...
@@ -102,7 +102,7 @@ class TestCase:
def setUpClass(cls) -> None: ...
@classmethod
def tearDownClass(cls) -> None: ...
def run(self, result: unittest.result.TestResult | None = ...) -> unittest.result.TestResult | None: ...
def run(self, result: unittest.result.TestResult | None = None) -> unittest.result.TestResult | None: ...
def __call__(self, result: unittest.result.TestResult | None = ...) -> unittest.result.TestResult | None: ...
def skipTest(self, reason: Any) -> NoReturn: ...
def subTest(self, msg: Any = ..., **params: Any) -> AbstractContextManager[None]: ...
@@ -110,18 +110,18 @@ class TestCase:
if sys.version_info < (3, 11):
def _addSkip(self, result: unittest.result.TestResult, test_case: TestCase, reason: str) -> None: ...
def assertEqual(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertNotEqual(self, first: Any, second: Any, msg: Any = ...) -> None: ...
def assertTrue(self, expr: Any, msg: Any = ...) -> None: ...
def assertFalse(self, expr: Any, msg: Any = ...) -> None: ...
def assertIs(self, expr1: object, expr2: object, msg: Any = ...) -> None: ...
def assertIsNot(self, expr1: object, expr2: object, msg: Any = ...) -> None: ...
def assertIsNone(self, obj: object, msg: Any = ...) -> None: ...
def assertIsNotNone(self, obj: object, msg: Any = ...) -> None: ...
def assertIn(self, member: Any, container: Iterable[Any] | Container[Any], msg: Any = ...) -> None: ...
def assertNotIn(self, member: Any, container: Iterable[Any] | Container[Any], msg: Any = ...) -> None: ...
def assertIsInstance(self, obj: object, cls: _IsInstanceClassInfo, msg: Any = ...) -> None: ...
def assertNotIsInstance(self, obj: object, cls: _IsInstanceClassInfo, msg: Any = ...) -> None: ...
def assertEqual(self, first: Any, second: Any, msg: Any = None) -> None: ...
def assertNotEqual(self, first: Any, second: Any, msg: Any = None) -> None: ...
def assertTrue(self, expr: Any, msg: Any = None) -> None: ...
def assertFalse(self, expr: Any, msg: Any = None) -> None: ...
def assertIs(self, expr1: object, expr2: object, msg: Any = None) -> None: ...
def assertIsNot(self, expr1: object, expr2: object, msg: Any = None) -> None: ...
def assertIsNone(self, obj: object, msg: Any = None) -> None: ...
def assertIsNotNone(self, obj: object, msg: Any = None) -> None: ...
def assertIn(self, member: Any, container: Iterable[Any] | Container[Any], msg: Any = None) -> None: ...
def assertNotIn(self, member: Any, container: Iterable[Any] | Container[Any], msg: Any = None) -> None: ...
def assertIsInstance(self, obj: object, cls: _IsInstanceClassInfo, msg: Any = None) -> None: ...
def assertNotIsInstance(self, obj: object, cls: _IsInstanceClassInfo, msg: Any = None) -> None: ...
@overload
def assertGreater(self, a: SupportsDunderGT[_T], b: _T, msg: Any = ...) -> None: ...
@overload
@@ -192,11 +192,11 @@ class TestCase:
self, expected_warning: type[Warning] | tuple[type[Warning], ...], expected_regex: str | Pattern[str], *, msg: Any = ...
) -> _AssertWarnsContext: ...
def assertLogs(
self, logger: str | logging.Logger | None = ..., level: int | str | None = ...
self, logger: str | logging.Logger | None = None, level: int | str | None = None
) -> _AssertLogsContext[_LoggingWatcher]: ...
if sys.version_info >= (3, 10):
def assertNoLogs(
self, logger: str | logging.Logger | None = ..., level: int | str | None = ...
self, logger: str | logging.Logger | None = None, level: int | str | None = None
) -> _AssertLogsContext[None]: ...
@overload
@@ -247,19 +247,19 @@ class TestCase:
msg: Any = ...,
delta: None = ...,
) -> None: ...
def assertRegex(self, text: AnyStr, expected_regex: AnyStr | Pattern[AnyStr], msg: Any = ...) -> None: ...
def assertNotRegex(self, text: AnyStr, unexpected_regex: AnyStr | Pattern[AnyStr], msg: Any = ...) -> None: ...
def assertCountEqual(self, first: Iterable[Any], second: Iterable[Any], msg: Any = ...) -> None: ...
def assertRegex(self, text: AnyStr, expected_regex: AnyStr | Pattern[AnyStr], msg: Any = None) -> None: ...
def assertNotRegex(self, text: AnyStr, unexpected_regex: AnyStr | Pattern[AnyStr], msg: Any = None) -> None: ...
def assertCountEqual(self, first: Iterable[Any], second: Iterable[Any], msg: Any = None) -> None: ...
def addTypeEqualityFunc(self, typeobj: type[Any], function: Callable[..., None]) -> None: ...
def assertMultiLineEqual(self, first: str, second: str, msg: Any = ...) -> None: ...
def assertMultiLineEqual(self, first: str, second: str, msg: Any = None) -> None: ...
def assertSequenceEqual(
self, seq1: Sequence[Any], seq2: Sequence[Any], msg: Any = ..., seq_type: type[Sequence[Any]] | None = ...
self, seq1: Sequence[Any], seq2: Sequence[Any], msg: Any = None, seq_type: type[Sequence[Any]] | None = None
) -> None: ...
def assertListEqual(self, list1: list[Any], list2: list[Any], msg: Any = ...) -> None: ...
def assertTupleEqual(self, tuple1: tuple[Any, ...], tuple2: tuple[Any, ...], msg: Any = ...) -> None: ...
def assertSetEqual(self, set1: AbstractSet[object], set2: AbstractSet[object], msg: Any = ...) -> None: ...
def assertDictEqual(self, d1: Mapping[Any, object], d2: Mapping[Any, object], msg: Any = ...) -> None: ...
def fail(self, msg: Any = ...) -> NoReturn: ...
def assertListEqual(self, list1: list[Any], list2: list[Any], msg: Any = None) -> None: ...
def assertTupleEqual(self, tuple1: tuple[Any, ...], tuple2: tuple[Any, ...], msg: Any = None) -> None: ...
def assertSetEqual(self, set1: AbstractSet[object], set2: AbstractSet[object], msg: Any = None) -> None: ...
def assertDictEqual(self, d1: Mapping[Any, object], d2: Mapping[Any, object], msg: Any = None) -> None: ...
def fail(self, msg: Any = None) -> NoReturn: ...
def countTestCases(self) -> int: ...
def defaultTestResult(self) -> unittest.result.TestResult: ...
def id(self) -> str: ...
@@ -302,16 +302,16 @@ class TestCase:
assertNotRegexpMatches = assertNotRegex
assertRaisesRegexp = assertRaisesRegex
def assertDictContainsSubset(
self, subset: Mapping[Any, Any], dictionary: Mapping[Any, Any], msg: object = ...
self, subset: Mapping[Any, Any], dictionary: Mapping[Any, Any], msg: object = None
) -> None: ...
class FunctionTestCase(TestCase):
def __init__(
self,
testFunc: Callable[[], Any],
setUp: Callable[[], Any] | None = ...,
tearDown: Callable[[], Any] | None = ...,
description: str | None = ...,
setUp: Callable[[], Any] | None = None,
tearDown: Callable[[], Any] | None = None,
description: str | None = None,
) -> None: ...
def runTest(self) -> None: ...

16
stdlib/unittest/loader.pyi
View File

@@ -18,11 +18,13 @@ class TestLoader:
testNamePatterns: list[str] | None
suiteClass: _SuiteClass
def loadTestsFromTestCase(self, testCaseClass: type[unittest.case.TestCase]) -> unittest.suite.TestSuite: ...
def loadTestsFromModule(self, module: ModuleType, *args: Any, pattern: Any = ...) -> unittest.suite.TestSuite: ...
def loadTestsFromName(self, name: str, module: ModuleType | None = ...) -> unittest.suite.TestSuite: ...
def loadTestsFromNames(self, names: Sequence[str], module: ModuleType | None = ...) -> unittest.suite.TestSuite: ...
def loadTestsFromModule(self, module: ModuleType, *args: Any, pattern: Any = None) -> unittest.suite.TestSuite: ...
def loadTestsFromName(self, name: str, module: ModuleType | None = None) -> unittest.suite.TestSuite: ...
def loadTestsFromNames(self, names: Sequence[str], module: ModuleType | None = None) -> unittest.suite.TestSuite: ...
def getTestCaseNames(self, testCaseClass: type[unittest.case.TestCase]) -> Sequence[str]: ...
def discover(self, start_dir: str, pattern: str = ..., top_level_dir: str | None = ...) -> unittest.suite.TestSuite: ...
def discover(
self, start_dir: str, pattern: str = "test*.py", top_level_dir: str | None = None
) -> unittest.suite.TestSuite: ...
def _match_path(self, path: str, full_path: str, pattern: str) -> bool: ...
defaultTestLoader: TestLoader
@@ -31,14 +33,14 @@ def getTestCaseNames(
testCaseClass: type[unittest.case.TestCase],
prefix: str,
sortUsing: _SortComparisonMethod = ...,
testNamePatterns: list[str] | None = ...,
testNamePatterns: list[str] | None = None,
) -> Sequence[str]: ...
def makeSuite(
testCaseClass: type[unittest.case.TestCase],
prefix: str = ...,
prefix: str = "test",
sortUsing: _SortComparisonMethod = ...,
suiteClass: _SuiteClass = ...,
) -> unittest.suite.TestSuite: ...
def findTestCases(
module: ModuleType, prefix: str = ..., sortUsing: _SortComparisonMethod = ..., suiteClass: _SuiteClass = ...
module: ModuleType, prefix: str = "test", sortUsing: _SortComparisonMethod = ..., suiteClass: _SuiteClass = ...
) -> unittest.suite.TestSuite: ...

26
stdlib/unittest/main.pyi
View File

@@ -25,23 +25,23 @@ class TestProgram:
testNamePatterns: list[str] | None
def __init__(
self,
module: None | str | ModuleType = ...,
defaultTest: str | Iterable[str] | None = ...,
argv: list[str] | None = ...,
testRunner: type[_TestRunner] | _TestRunner | None = ...,
module: None | str | ModuleType = "__main__",
defaultTest: str | Iterable[str] | None = None,
argv: list[str] | None = None,
testRunner: type[_TestRunner] | _TestRunner | None = None,
testLoader: unittest.loader.TestLoader = ...,
exit: bool = ...,
verbosity: int = ...,
failfast: bool | None = ...,
catchbreak: bool | None = ...,
buffer: bool | None = ...,
warnings: str | None = ...,
exit: bool = True,
verbosity: int = 1,
failfast: bool | None = None,
catchbreak: bool | None = None,
buffer: bool | None = None,
warnings: str | None = None,
*,
tb_locals: bool = ...,
tb_locals: bool = False,
) -> None: ...
def usageExit(self, msg: Any = ...) -> None: ...
def usageExit(self, msg: Any = None) -> None: ...
def parseArgs(self, argv: list[str]) -> None: ...
def createTests(self, from_discovery: bool = ..., Loader: unittest.loader.TestLoader | None = ...) -> None: ...
def createTests(self, from_discovery: bool = False, Loader: unittest.loader.TestLoader | None = None) -> None: ...
def runTests(self) -> None: ... # undocumented
main = TestProgram

99
stdlib/unittest/mock.pyi
View File

@@ -70,16 +70,21 @@ class _Call(tuple[Any, ...]):
def __new__(
cls: type[Self],
value: _CallValue = ...,
name: str | None = ...,
parent: Any | None = ...,
two: bool = ...,
from_kall: bool = ...,
name: str | None = "",
parent: Any | None = None,
two: bool = False,
from_kall: bool = True,
) -> Self: ...
name: Any
parent: Any
from_kall: Any
def __init__(
self, value: _CallValue = ..., name: str | None = ..., parent: Any | None = ..., two: bool = ..., from_kall: bool = ...
self,
value: _CallValue = ...,
name: str | None = None,
parent: Any | None = None,
two: bool = False,
from_kall: bool = True,
) -> None: ...
def __eq__(self, other: object) -> bool: ...
def __ne__(self, __other: object) -> bool: ...
@@ -106,17 +111,17 @@ class NonCallableMock(Base, Any):
def __new__(__cls: type[Self], *args: Any, **kw: Any) -> Self: ...
def __init__(
self,
spec: list[str] | object | type[object] | None = ...,
wraps: Any | None = ...,
name: str | None = ...,
spec_set: list[str] | object | type[object] | None = ...,
parent: NonCallableMock | None = ...,
_spec_state: Any | None = ...,
_new_name: str = ...,
_new_parent: NonCallableMock | None = ...,
_spec_as_instance: bool = ...,
_eat_self: bool | None = ...,
unsafe: bool = ...,
spec: list[str] | object | type[object] | None = None,
wraps: Any | None = None,
name: str | None = None,
spec_set: list[str] | object | type[object] | None = None,
parent: NonCallableMock | None = None,
_spec_state: Any | None = None,
_new_name: str = "",
_new_parent: NonCallableMock | None = None,
_spec_as_instance: bool = False,
_eat_self: bool | None = None,
unsafe: bool = False,
**kwargs: Any,
) -> None: ...
def __getattr__(self, name: str) -> Any: ...
@@ -124,11 +129,11 @@ class NonCallableMock(Base, Any):
def __setattr__(self, name: str, value: Any) -> None: ...
def __dir__(self) -> list[str]: ...
if sys.version_info >= (3, 8):
def _calls_repr(self, prefix: str = ...) -> str: ...
def _calls_repr(self, prefix: str = "Calls") -> str: ...
def assert_called_with(self, *args: Any, **kwargs: Any) -> None: ...
def assert_not_called(self) -> None: ...
def assert_called_once_with(self, *args: Any, **kwargs: Any) -> None: ...
def _format_mock_failure_message(self, args: Any, kwargs: Any, action: str = ...) -> str: ...
def _format_mock_failure_message(self, args: Any, kwargs: Any, action: str = "call") -> str: ...
else:
def assert_called_with(_mock_self, *args: Any, **kwargs: Any) -> None: ...
def assert_not_called(_mock_self) -> None: ...
@@ -141,13 +146,13 @@ class NonCallableMock(Base, Any):
def assert_called(_mock_self) -> None: ...
def assert_called_once(_mock_self) -> None: ...
def reset_mock(self, visited: Any = ..., *, return_value: bool = ..., side_effect: bool = ...) -> None: ...
def reset_mock(self, visited: Any = None, *, return_value: bool = False, side_effect: bool = False) -> None: ...
def _extract_mock_name(self) -> str: ...
def _get_call_signature_from_name(self, name: str) -> Any: ...
def assert_any_call(self, *args: Any, **kwargs: Any) -> None: ...
def assert_has_calls(self, calls: Sequence[_Call], any_order: bool = ...) -> None: ...
def mock_add_spec(self, spec: Any, spec_set: bool = ...) -> None: ...
def _mock_add_spec(self, spec: Any, spec_set: bool, _spec_as_instance: bool = ..., _eat_self: bool = ...) -> None: ...
def assert_has_calls(self, calls: Sequence[_Call], any_order: bool = False) -> None: ...
def mock_add_spec(self, spec: Any, spec_set: bool = False) -> None: ...
def _mock_add_spec(self, spec: Any, spec_set: bool, _spec_as_instance: bool = False, _eat_self: bool = False) -> None: ...
def attach_mock(self, mock: NonCallableMock, attribute: str) -> None: ...
def configure_mock(self, **kwargs: Any) -> None: ...
return_value: Any
@@ -165,16 +170,16 @@ class CallableMixin(Base):
side_effect: Any
def __init__(
self,
spec: Any | None = ...,
side_effect: Any | None = ...,
spec: Any | None = None,
side_effect: Any | None = None,
return_value: Any = ...,
wraps: Any | None = ...,
name: Any | None = ...,
spec_set: Any | None = ...,
parent: Any | None = ...,
_spec_state: Any | None = ...,
_new_name: Any = ...,
_new_parent: Any | None = ...,
wraps: Any | None = None,
name: Any | None = None,
spec_set: Any | None = None,
parent: Any | None = None,
_spec_state: Any | None = None,
_new_name: Any = "",
_new_parent: Any | None = None,
**kwargs: Any,
) -> None: ...
if sys.version_info >= (3, 8):
@@ -212,7 +217,7 @@ class _patch(Generic[_T]):
new_callable: Any | None,
kwargs: Mapping[str, Any],
*,
unsafe: bool = ...,
unsafe: bool = False,
) -> None: ...
else:
def __init__(
@@ -258,7 +263,7 @@ class _patch_dict:
in_dict: Any
values: Any
clear: Any
def __init__(self, in_dict: Any, values: Any = ..., clear: Any = ..., **kwargs: Any) -> None: ...
def __init__(self, in_dict: Any, values: Any = ..., clear: Any = False, **kwargs: Any) -> None: ...
def __call__(self, f: Any) -> Any: ...
if sys.version_info >= (3, 10):
def decorate_callable(self, f: _F) -> _F: ...
@@ -361,7 +366,7 @@ if sys.version_info >= (3, 8):
def assert_awaited_with(self, *args: Any, **kwargs: Any) -> None: ...
def assert_awaited_once_with(self, *args: Any, **kwargs: Any) -> None: ...
def assert_any_await(self, *args: Any, **kwargs: Any) -> None: ...
def assert_has_awaits(self, calls: Iterable[_Call], any_order: bool = ...) -> None: ...
def assert_has_awaits(self, calls: Iterable[_Call], any_order: bool = False) -> None: ...
def assert_not_awaited(self) -> None: ...
def reset_mock(self, *args: Any, **kwargs: Any) -> None: ...
await_count: int
@@ -381,7 +386,7 @@ class MagicProxy:
def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
def create_mock(self) -> Any: ...
def __get__(self, obj: Any, _type: Any | None = ...) -> Any: ...
def __get__(self, obj: Any, _type: Any | None = None) -> Any: ...
class _ANY:
def __eq__(self, other: object) -> Literal[True]: ...
@@ -392,12 +397,12 @@ ANY: Any
if sys.version_info >= (3, 10):
def create_autospec(
spec: Any,
spec_set: Any = ...,
instance: Any = ...,
_parent: Any | None = ...,
_name: Any | None = ...,
spec_set: Any = False,
instance: Any = False,
_parent: Any | None = None,
_name: Any | None = None,
*,
unsafe: bool = ...,
unsafe: bool = False,
**kwargs: Any,
) -> Any: ...
@@ -416,18 +421,18 @@ class _SpecState:
def __init__(
self,
spec: Any,
spec_set: Any = ...,
parent: Any | None = ...,
name: Any | None = ...,
ids: Any | None = ...,
instance: Any = ...,
spec_set: Any = False,
parent: Any | None = None,
name: Any | None = None,
ids: Any | None = None,
instance: Any = False,
) -> None: ...
def mock_open(mock: Any | None = ..., read_data: Any = ...) -> Any: ...
def mock_open(mock: Any | None = None, read_data: Any = "") -> Any: ...
class PropertyMock(Mock):
if sys.version_info >= (3, 8):
def __get__(self: Self, obj: _T, obj_type: type[_T] | None = ...) -> Self: ...
def __get__(self: Self, obj: _T, obj_type: type[_T] | None = None) -> Self: ...
else:
def __get__(self: Self, obj: _T, obj_type: type[_T] | None) -> Self: ...

2
stdlib/unittest/result.pyi
View File

@@ -22,7 +22,7 @@ class TestResult:
buffer: bool
failfast: bool
tb_locals: bool
def __init__(self, stream: TextIO | None = ..., descriptions: bool | None = ..., verbosity: int | None = ...) -> None: ...
def __init__(self, stream: TextIO | None = None, descriptions: bool | None = None, verbosity: int | None = None) -> None: ...
def printErrors(self) -> None: ...
def wasSuccessful(self) -> bool: ...
def stop(self) -> None: ...

16
stdlib/unittest/runner.pyi
View File

@@ -22,15 +22,15 @@ class TextTestRunner:
resultclass: _ResultClassType
def __init__(
self,
stream: TextIO | None = ...,
descriptions: bool = ...,
verbosity: int = ...,
failfast: bool = ...,
buffer: bool = ...,
resultclass: _ResultClassType | None = ...,
warnings: type[Warning] | None = ...,
stream: TextIO | None = None,
descriptions: bool = True,
verbosity: int = 1,
failfast: bool = False,
buffer: bool = False,
resultclass: _ResultClassType | None = None,
warnings: type[Warning] | None = None,
*,
tb_locals: bool = ...,
tb_locals: bool = False,
) -> None: ...
def _makeResult(self) -> unittest.result.TestResult: ...
def run(self, test: unittest.suite.TestSuite | unittest.case.TestCase) -> unittest.result.TestResult: ...

2
stdlib/unittest/suite.pyi
View File

@@ -19,4 +19,4 @@ class BaseTestSuite(Iterable[_TestType]):
def __eq__(self, other: object) -> bool: ...
class TestSuite(BaseTestSuite):
def run(self, result: unittest.result.TestResult, debug: bool = ...) -> unittest.result.TestResult: ...
def run(self, result: unittest.result.TestResult, debug: bool = False) -> unittest.result.TestResult: ...

2
stdlib/unittest/util.pyi
View File

@@ -14,7 +14,7 @@ _MIN_DIFF_LEN: int
def _shorten(s: str, prefixlen: int, suffixlen: int) -> str: ...
def _common_shorten_repr(*args: str) -> tuple[str, ...]: ...
def safe_repr(obj: object, short: bool = ...) -> str: ...
def safe_repr(obj: object, short: bool = False) -> str: ...
def strclass(cls: type) -> str: ...
def sorted_list_difference(expected: Sequence[_T], actual: Sequence[_T]) -> tuple[list[_T], list[_T]]: ...
def unorderable_list_difference(expected: Sequence[_T], actual: Sequence[_T]) -> tuple[list[_T], list[_T]]: ...