Skip to content

Mac Address

netutils.mac

Functions for working with MAC addresses.

get_oui(mac)

Returns the company name for a given mac as defined by the IEEE.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required

Returns:

Type Description
str

The name of the company the mac is related to.

Examples:

>>> from netutils.mac import get_oui
>>> from netutils.data_files.oui_mappings import OUI_MAPPINGS
>>> get_oui("cc.79.d7.dd.ee.ff")
'Cisco Systems, Inc'
>>>
Source code in netutils/mac.py
@_valid_mac
def get_oui(mac: str) -> str:
    """Returns the company name for a given mac as defined by the IEEE.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.

    Returns:
        The name of the company the mac is related to.

    Examples:
        >>> from netutils.mac import get_oui
        >>> from netutils.data_files.oui_mappings import OUI_MAPPINGS
        >>> get_oui("cc.79.d7.dd.ee.ff")
        'Cisco Systems, Inc'
        >>>
    """
    from netutils.data_files.oui_mappings import OUI_MAPPINGS  # pylint: disable=import-outside-toplevel

    normalized_mac_prefix = mac_normalize(mac)[0:6]
    oui_company = OUI_MAPPINGS.get(normalized_mac_prefix)

    if not oui_company:
        raise ValueError(f"There was no matching entry in OUI_MAPPINGS for {normalized_mac_prefix}.")

    return oui_company

is_valid_mac(mac)

Verifies whether or not a string is a valid MAC address.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required

Returns:

Type Description
bool

The result as to whether or not the string is a valid MAC address.

Examples:

>>> from netutils.mac import is_valid_mac
>>> is_valid_mac("aa.bb.cc.dd.ee.ff")
True
>>> is_valid_mac("aa.bb.cc.dd.ee.gg")
False
>>>
Source code in netutils/mac.py
def is_valid_mac(mac: str) -> bool:
    """Verifies whether or not a string is a valid MAC address.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.

    Returns:
        The result as to whether or not the string is a valid MAC address.

    Examples:
        >>> from netutils.mac import is_valid_mac
        >>> is_valid_mac("aa.bb.cc.dd.ee.ff")
        True
        >>> is_valid_mac("aa.bb.cc.dd.ee.gg")
        False
        >>>
    """
    for pattern in list(MAC_REGEX.values()):
        if re.fullmatch(pattern, mac):
            return True
    return False

mac_normalize(mac)

Return the MAC address with only the address, and no special characters.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required

Returns:

Type Description
str

The MAC address with no special characters.

Examples:

>>> from netutils.mac import mac_normalize
>>> mac_normalize("aa.bb.cc.dd.ee.ff")
'aabbccddeeff'
>>>
Source code in netutils/mac.py
@_valid_mac
def mac_normalize(mac: str) -> str:
    """Return the MAC address with only the address, and no special characters.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.

    Returns:
        The MAC address with no special characters.

    Examples:
        >>> from netutils.mac import mac_normalize
        >>> mac_normalize("aa.bb.cc.dd.ee.ff")
        'aabbccddeeff'
        >>>
    """
    chars = ":-."
    for char in chars:
        if char in mac:
            mac = mac.replace(char, "")
    return mac

mac_to_format(mac, frmt='MAC_NO_SPECIAL')

Converts the MAC address to a specific format.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required
frmt str

A format in which the MAC address should be returned in.

'MAC_NO_SPECIAL'

Returns:

Type Description
str

A MAC address in the specified format.

Examples:

>>> from netutils.mac import mac_to_format
>>> mac_to_format("aa.bb.cc.dd.ee.ff", "MAC_DASH_FOUR")
'aabb-ccdd-eeff'
>>>
Source code in netutils/mac.py
@_valid_mac
def mac_to_format(mac: str, frmt: str = "MAC_NO_SPECIAL") -> str:
    """Converts the MAC address to a specific format.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.
        frmt: A format in which the MAC address should be returned in.

    Returns:
        A MAC address in the specified format.

    Examples:
        >>> from netutils.mac import mac_to_format
        >>> mac_to_format("aa.bb.cc.dd.ee.ff", "MAC_DASH_FOUR")
        'aabb-ccdd-eeff'
        >>>
    """
    if not MAC_CREATE.get(frmt):
        raise ValueError(f"An invalid mac format was provided in: `{frmt}`")
    mac = mac_normalize(mac)
    count = MAC_CREATE[frmt]["count"]
    char = MAC_CREATE[frmt]["char"]
    return char.join([mac[i : i + count] for i in range(0, len(mac), count)])  # type: ignore # noqa: E203

mac_to_int(mac)

Converts the MAC address to an integer.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required

Returns:

Type Description
int

The valid MAC address converted to an integer.

Examples:

>>> from netutils.mac import mac_to_int
>>> mac_to_int("aa.bb.cc.dd.ee.ff")
187723572702975
>>>
Source code in netutils/mac.py
@_valid_mac
def mac_to_int(mac: str) -> int:
    """Converts the MAC address to an integer.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.

    Returns:
        The valid MAC address converted to an integer.

    Examples:
        >>> from netutils.mac import mac_to_int
        >>> mac_to_int("aa.bb.cc.dd.ee.ff")
        187723572702975
        >>>
    """
    return int(mac_normalize(mac), 16)

mac_type(mac)

Retuns the "type" of MAC address, as defined by the regex pattern names.

Parameters:

Name Type Description Default
mac str

A MAC address in string format that matches one of the defined regex patterns.

required

Returns:

Type Description
t.Optional[str]

The regex pattern type of the MAC address.

Examples:

>>> from netutils.mac import mac_type
>>> mac_type("aa.bb.cc.dd.ee.ff")
'MAC_DOT_TWO'
>>> mac_type("aabb.ccdd.eeff")
'MAC_DOT_FOUR'
>>>
Source code in netutils/mac.py
@_valid_mac
def mac_type(mac: str) -> t.Optional[str]:
    """Retuns the "type" of MAC address, as defined by the regex pattern names.

    Args:
        mac: A MAC address in string format that matches one of the defined regex patterns.

    Returns:
        The regex pattern type of the MAC address.

    Examples:
        >>> from netutils.mac import mac_type
        >>> mac_type("aa.bb.cc.dd.ee.ff")
        'MAC_DOT_TWO'
        >>> mac_type("aabb.ccdd.eeff")
        'MAC_DOT_FOUR'
        >>>
    """
    for name, pattern in MAC_REGEX.items():
        if re.fullmatch(pattern, mac):
            return name
    return None