Skip to content

check_port_is_in_range(port)

Check that port is a valid port number.

Parameters:

Name Type Description Default
port int

Port to check.

 required

Raises:

Type Description
PortTypeError

When port isn't an int.
PortOutOfRangeError

When port isn't a valid port number.

Examples:

check_port_is_in_range(8000)
# Pass

check_port_is_in_range(70000)
# PortOutOfRangeError
Source code in src/notwork/check_port_is_in_range.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
def check_port_is_in_range(port: int) -> None:
    """
    Check that `port` is a valid port number.

    Args:
        port: Port to check.

    Raises:
        PortTypeError: When `port` isn't an `int`.
        PortOutOfRangeError: When `port` isn't a valid port number.

    Examples:
        ```python
        check_port_is_in_range(8000)
        # Pass

        check_port_is_in_range(70000)
        # PortOutOfRangeError
        ```
    """
    if not is_int(port):
        raise PortTypeError(port)

    if not is_port_in_range(port):
        raise PortOutOfRangeError(port)