From 4a398db99d88dd17dabc408fb2b58c610792bc1e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 15 Oct 2024 22:30:44 +0200 Subject: Adding upstream version 1.1.0. Signed-off-by: Daniel Baumann --- asynceapi/aio_portcheck.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'asynceapi/aio_portcheck.py') diff --git a/asynceapi/aio_portcheck.py b/asynceapi/aio_portcheck.py index 79f4562..0cab94c 100644 --- a/asynceapi/aio_portcheck.py +++ b/asynceapi/aio_portcheck.py @@ -37,12 +37,17 @@ async def port_check_url(url: URL, timeout: int = 5) -> bool: """ Open the port designated by the URL given the timeout in seconds. - If the port is available then return True; False otherwise. - Parameters ---------- - url: The URL that provides the target system - timeout: Time to await for the port to open in seconds + url + The URL that provides the target system. + timeout + Time to await for the port to open in seconds. + + Returns + ------- + bool + If the port is available then return True; False otherwise. """ port = url.port or socket.getservbyname(url.scheme) -- cgit v1.2.3