foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-10 10:52:31 -05:00
Code Issues Activity

test: convert docs into type annotations in test_framework/util.py

Browse source
This commit is contained in:
fanquake 2021-05-28 13:15:04 +08:00
parent 6fe012c6bd
commit b043ca8e8b
No known key found for this signature in database
GPG key ID: 2EEB9F5CC09526C1
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
test/functional/test_framework/util.py
View file

@ -20,6 +20,7 @@ import unittest
from . import coverage from . import coverage
from .authproxy import AuthServiceProxy, JSONRPCException from .authproxy import AuthServiceProxy, JSONRPCException
from io import BytesIO from io import BytesIO
from typing import Callable, Optional
logger = logging.getLogger("TestFramework.utils") logger = logging.getLogger("TestFramework.utils")
@ -80,7 +81,7 @@ def assert_raises_message(exc, message, fun, *args, **kwds):
raise AssertionError("No exception raised") raise AssertionError("No exception raised")
def assert_raises_process_error(returncode, output, fun, *args, **kwds): def assert_raises_process_error(returncode: int, output: str, fun: Callable, *args, **kwds):
"""Execute a process and asserts the process return code and output. """Execute a process and asserts the process return code and output.
Calls function `fun` with arguments `args` and `kwds`. Catches a CalledProcessError Calls function `fun` with arguments `args` and `kwds`. Catches a CalledProcessError
@ -88,9 +89,9 @@ def assert_raises_process_error(returncode, output, fun, *args, **kwds):
no CalledProcessError was raised or if the return code and output are not as expected. no CalledProcessError was raised or if the return code and output are not as expected.
Args: Args:
returncode (int): the process return code. returncode: the process return code.
output (string): [a substring of] the process output. output: [a substring of] the process output.
fun (function): the function to call. This should execute a process. fun: the function to call. This should execute a process.
args*: positional arguments for the function. args*: positional arguments for the function.
kwds**: named arguments for the function. kwds**: named arguments for the function.
""" """
@ -105,7 +106,7 @@ def assert_raises_process_error(returncode, output, fun, *args, **kwds):
raise AssertionError("No exception raised") raise AssertionError("No exception raised")
def assert_raises_rpc_error(code, message, fun, *args, **kwds): def assert_raises_rpc_error(code: Optional[int], message: Optional[str], fun: Callable, *args, **kwds):
"""Run an RPC and verify that a specific JSONRPC exception code and message is raised. """Run an RPC and verify that a specific JSONRPC exception code and message is raised.
Calls function `fun` with arguments `args` and `kwds`. Catches a JSONRPCException Calls function `fun` with arguments `args` and `kwds`. Catches a JSONRPCException
@ -113,11 +114,11 @@ def assert_raises_rpc_error(code, message, fun, *args, **kwds):
no JSONRPCException was raised or if the error code/message are not as expected. no JSONRPCException was raised or if the error code/message are not as expected.
Args: Args:
code (int), optional: the error code returned by the RPC call (defined code: the error code returned by the RPC call (defined in src/rpc/protocol.h).
in src/rpc/protocol.h). Set to None if checking the error code is not required. Set to None if checking the error code is not required.
message (string), optional: [a substring of] the error string returned by the message: [a substring of] the error string returned by the RPC call.
RPC call. Set to None if checking the error string is not required. Set to None if checking the error string is not required.
fun (function): the function to call. This should be the name of an RPC. fun: the function to call. This should be the name of an RPC.
args*: positional arguments for the function. args*: positional arguments for the function.
kwds**: named arguments for the function. kwds**: named arguments for the function.
""" """