Skip to content

♻️ refactor mac_address validation logic #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2025
Merged

♻️ refactor mac_address validation logic #338

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed98a6a
Clean up mac_address.py validation logic
Stormageddon37 Sep 28, 2025
35a21e2
Reformat via Ruff
Stormageddon37 Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 36 additions & 28 deletions pydantic_extra_types/mac_address.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
from pydantic import GetCoreSchemaHandler
from pydantic_core import PydanticCustomError, core_schema

MINIMUM_LENGTH: int = 14
ALLOWED_CHUNK_COUNTS: tuple[int, int, int] = (6, 8, 20)


class MacAddress(str):
"""Represents a MAC address and provides methods for conversion, validation, and serialization.
Expand Down Expand Up @@ -63,36 +66,41 @@ def _validate(cls, __input_value: str, _: Any) -> str:
@staticmethod
def validate_mac_address(value: bytes) -> str:
"""Validate a MAC Address from the provided byte value."""
string = value.decode()
if len(string) < 14:
raw = value.decode()
if len(raw) < MINIMUM_LENGTH:
raise PydanticCustomError(
'mac_address_len',
'Length for a {mac_address} MAC address must be {required_length}',
{'mac_address': string, 'required_length': 14},
{'mac_address': raw, 'required_length': MINIMUM_LENGTH},
)
for sep, partbytes in ((':', 2), ('-', 2), ('.', 4)):
if sep in string:
parts = string.split(sep)
if any(len(part) != partbytes for part in parts):
raise PydanticCustomError(
'mac_address_format',
f'Must have the format xx{sep}xx{sep}xx{sep}xx{sep}xx{sep}xx',
)
if len(parts) * partbytes // 2 not in (6, 8, 20):
raise PydanticCustomError(
'mac_address_format',
'Length for a {mac_address} MAC address must be {required_length}',
{'mac_address': string, 'required_length': (6, 8, 20)},
)
mac_address = []

for seperator, chunk_len in ((':', 2), ('-', 2), ('.', 4)):
if seperator not in raw:
continue

parts = raw.split(seperator)
if any(len(p) != chunk_len for p in parts):
raise PydanticCustomError(
'mac_address_format',
f'Must have the format xx{seperator}xx{seperator}xx{seperator}xx{seperator}xx{seperator}xx',
)

total_bytes = (len(parts) * chunk_len) // 2
if total_bytes not in ALLOWED_CHUNK_COUNTS:
raise PydanticCustomError(
'mac_address_format',
'Length for a {mac_address} MAC address must be {required_length}',
{'mac_address': raw, 'required_length': ALLOWED_CHUNK_COUNTS},
)

try:
mac_bytes: list[int] = []
for part in parts:
for idx in range(0, partbytes, 2):
try:
byte_value = int(part[idx : idx + 2], 16)
except ValueError as exc:
raise PydanticCustomError('mac_address_format', 'Unrecognized format') from exc
else:
mac_address.append(byte_value)
return ':'.join(f'{b:02x}' for b in mac_address)
else:
raise PydanticCustomError('mac_address_format', 'Unrecognized format')
for i in range(0, chunk_len, 2):
mac_bytes.append(int(part[i : i + 2], base=16))
except ValueError as exc:
raise PydanticCustomError('mac_address_format', 'Unrecognized format') from exc

return ':'.join(f'{b:02x}' for b in mac_bytes)

raise PydanticCustomError('mac_address_format', 'Unrecognized format')