Skip to content

Route

netutils.route

Utilities to get best route from routing table.

NoRouteFound

Bases: BaseException

Custom Exception for No Route Found.

Source code in netutils/route.py
class NoRouteFound(BaseException):
    """Custom Exception for No Route Found."""

longest_prefix_match(ip_addr, routes)

From a list of networks and an IP address, find the most specific route.

Parameters:

Name Type Description Default
ip_addr str

String representation of an IP address.

required
routes t.List[t.Dict[str, str]]

list of dictionaries with network and mask as keys. Subnet can also be CIDR(number) notation.

required

Returns:

Type Description
str

Longest Match Route

Examples:

>>> from netutils.route import longest_prefix_match
>>> lookup = "10.1.1.245"
>>> routes = [{"network": "192.168.1.1", "mask": "255.255.255.255"},{"network": "10.1.1.0", "mask": "24"}]
>>> longest_prefix_match(lookup, routes)
'10.1.1.0/24'
Source code in netutils/route.py
def longest_prefix_match(ip_addr: str, routes: t.List[t.Dict[str, str]]) -> str:
    """From a list of networks and an IP address, find the most specific route.

    Args:
        ip_addr: String representation of an IP address.
        routes: list of dictionaries with network and mask as keys. Subnet can also be CIDR(number) notation.

    Returns:
        Longest Match Route

    Examples:
        >>> from netutils.route import longest_prefix_match
        >>> lookup = "10.1.1.245"
        >>> routes = [{"network": "192.168.1.1", "mask": "255.255.255.255"},{"network": "10.1.1.0", "mask": "24"}]
        >>> longest_prefix_match(lookup, routes)
        '10.1.1.0/24'
    """
    if not isinstance(routes, list):
        raise TypeError(f"'routing_table' should be a list, got {type(routes)}")
    if not len(routes) > 0:
        raise IndexError(f"'routing_table' should have more than zero indexes. Got {len(routes)}")
    if isinstance(ip_addr, str):
        ip_addr = ipaddress.ip_address(ip_addr)  # type: ignore
    else:
        if not isinstance(ip_addr, (ipaddress.IPv4Address, ipaddress.IPv6Address)):
            raise TypeError(f"'ip_addr' should be a str, got {type(ip_addr)}")

    networks = [
        ipaddress.IPv4Network(f'{route["network"]}/{route["mask"]}')
        for route in routes
        if ip_addr in ipaddress.IPv4Network(f'{route["network"]}/{route["mask"]}')  # type: ignore
    ]
    try:
        return str(sorted(networks)[-1])
    except IndexError as error:
        raise NoRouteFound("No Matching Route Found.") from error