CIDR networks (Effect's IpNetwork): the standard library's
ipaddress.IPv4Network / IPv6Network, always canonical (no host
bits).
make rejects an address with host bits; from_address clears them.
from_string parses strict CIDR text. first_address,
last_address, address_count, contains, contains_network and
overlaps compare only networks of one family; across families they are
False.
Re-exports#
Types#
| Type | Definition | Description |
|---|---|---|
IpNetwork | type IpNetwork = IPv4Network | IPv6Network | |
IpNetworkParts | type IpNetworkParts[A = IpAddressInput] = IpInterfaceParts[A] | |
IpNetworkInput | type IpNetworkInput = IpNetwork | str | IpInterfaceParts[IpAddressInput] | |
Ipv4NetworkInput | type Ipv4NetworkInput = IPv4Network | str | IpInterfaceParts[Ipv4AddressInput] | |
Ipv6NetworkInput | type Ipv6NetworkInput = IPv6Network | str | IpInterfaceParts[Ipv6AddressInput] |
Functions#
make#
make(address: IPv4Address, prefix_length: int) -> Result[IPv4Network, NetAddressError]
make(address: IPv6Address, prefix_length: int) -> Result[IPv6Network, NetAddressError]
make(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]The network address/prefix_length; an address with host bits set
is rejected.
| Parameter | Type | Description |
|---|---|---|
address | ||
prefix_length |
@overload
def make(address: IPv4Address, prefix_length: int) -> Result[IPv4Network, NetAddressError]: ...
@overload
def make(address: IPv6Address, prefix_length: int) -> Result[IPv6Network, NetAddressError]: ...
@overload
def make(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]: ...
def make(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]:
"""The network ``address/prefix_length``; an address with host bits set
is rejected."""
def check(value: IpInterface) -> Result[IpNetwork, NetAddressError]:
network = _network(address, value.network.prefixlen)
if network.network_address != address:
return address_error(address, "address has non-zero host bits")
return Ok(network)
return ip_interface.make(address, prefix_length).flat_map(check)make_unsafe#
make_unsafe(address: IPv4Address, prefix_length: int) -> IPv4Network
make_unsafe(address: IPv6Address, prefix_length: int) -> IPv6Network
make_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork| Parameter | Type | Description |
|---|---|---|
address | ||
prefix_length |
@overload
def make_unsafe(address: IPv4Address, prefix_length: int) -> IPv4Network: ...
@overload
def make_unsafe(address: IPv6Address, prefix_length: int) -> IPv6Network: ...
@overload
def make_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork: ...
def make_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork:
return make(address, prefix_length).get_or_raise()from_address#
from_address(address: IPv4Address, prefix_length: int) -> Result[IPv4Network, NetAddressError]
from_address(address: IPv6Address, prefix_length: int) -> Result[IPv6Network, NetAddressError]
from_address(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]The network containing address with prefix_length: host bits
cleared.
| Parameter | Type | Description |
|---|---|---|
address | ||
prefix_length |
@overload
def from_address(
address: IPv4Address, prefix_length: int
) -> Result[IPv4Network, NetAddressError]: ...
@overload
def from_address(
address: IPv6Address, prefix_length: int
) -> Result[IPv6Network, NetAddressError]: ...
@overload
def from_address(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]: ...
def from_address(address: IpAddress, prefix_length: int) -> Result[IpNetwork, NetAddressError]:
"""The network containing ``address`` with ``prefix_length``: host bits
cleared."""
return ip_interface.make(address, prefix_length).map(
lambda value: _network(address, value.network.prefixlen)
)from_address_unsafe#
from_address_unsafe(address: IPv4Address, prefix_length: int) -> IPv4Network
from_address_unsafe(address: IPv6Address, prefix_length: int) -> IPv6Network
from_address_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork| Parameter | Type | Description |
|---|---|---|
address | ||
prefix_length |
@overload
def from_address_unsafe(address: IPv4Address, prefix_length: int) -> IPv4Network: ...
@overload
def from_address_unsafe(address: IPv6Address, prefix_length: int) -> IPv6Network: ...
@overload
def from_address_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork: ...
def from_address_unsafe(address: IpAddress, prefix_length: int) -> IpNetwork:
return from_address(address, prefix_length).get_or_raise()from_interface#
from_interface(interface) -> IpNetworkThe canonical network an interface address is on.
| Parameter | Type | Description |
|---|---|---|
interface | IpInterface |
Returns IpNetwork
def from_interface(interface: IpInterface) -> IpNetwork:
"""The canonical network an interface address is on."""
return interface.networkipv4_from_string#
ipv4_from_string(text) -> Result[IPv4Network, NetAddressError]| Parameter | Type | Description |
|---|---|---|
text | str |
Returns Result[IPv4Network, NetAddressError]
def ipv4_from_string(text: str) -> Result[IPv4Network, NetAddressError]:
return _parse(text, parse_ipv4).flat_map(lambda p: make(p[0], p[1]))ipv6_from_string#
ipv6_from_string(text) -> Result[IPv6Network, NetAddressError]| Parameter | Type | Description |
|---|---|---|
text | str |
Returns Result[IPv6Network, NetAddressError]
def ipv6_from_string(text: str) -> Result[IPv6Network, NetAddressError]:
return _parse(text, parse_ipv6).flat_map(lambda p: make(p[0], p[1]))from_string#
from_string(text) -> Result[IpNetwork, NetAddressError]Strict CIDR: address/prefix with no host bits.
| Parameter | Type | Description |
|---|---|---|
text | str |
Returns Result[IpNetwork, NetAddressError]
def from_string(text: str) -> Result[IpNetwork, NetAddressError]:
"""Strict CIDR: ``address/prefix`` with no host bits."""
return _parse(text, ip_from_string).flat_map(lambda p: make(p[0], p[1]))from_string_unsafe#
from_string_unsafe(text) -> IpNetwork| Parameter | Type | Description |
|---|---|---|
text | str |
Returns IpNetwork
def from_string_unsafe(text: str) -> IpNetwork:
return from_string(text).get_or_raise()from_input#
from_input(value) -> Result[IpNetwork, NetAddressError]| Parameter | Type | Description |
|---|---|---|
value | IpNetworkInput |
Returns Result[IpNetwork, NetAddressError]
def from_input(value: IpNetworkInput) -> Result[IpNetwork, NetAddressError]:
match value:
case IPv4Network() | IPv6Network():
return Ok(value)
case str():
return from_string(value)
case _:
return _parts(value, ip_from_input).flat_map(lambda p: make(p[0], p[1]))from_input_unsafe#
from_input_unsafe(value) -> IpNetwork| Parameter | Type | Description |
|---|---|---|
value | IpNetworkInput |
Returns IpNetwork
def from_input_unsafe(value: IpNetworkInput) -> IpNetwork:
return from_input(value).get_or_raise()ipv4_from_input#
ipv4_from_input(value) -> Result[IPv4Network, NetAddressError]| Parameter | Type | Description |
|---|---|---|
value | Ipv4NetworkInput |
Returns Result[IPv4Network, NetAddressError]
def ipv4_from_input(value: Ipv4NetworkInput) -> Result[IPv4Network, NetAddressError]:
match value:
case IPv4Network():
return Ok(value)
case str():
return ipv4_from_string(value)
case _:
return _parts(value, ipv4_address_from_input).flat_map(lambda p: make(p[0], p[1]))ipv6_from_input#
ipv6_from_input(value) -> Result[IPv6Network, NetAddressError]| Parameter | Type | Description |
|---|---|---|
value | Ipv6NetworkInput |
Returns Result[IPv6Network, NetAddressError]
def ipv6_from_input(value: Ipv6NetworkInput) -> Result[IPv6Network, NetAddressError]:
match value:
case IPv6Network():
return Ok(value)
case str():
return ipv6_from_string(value)
case _:
return _parts(value, ipv6_address_from_input).flat_map(lambda p: make(p[0], p[1]))format#
format(network) -> straddress/prefix with the canonical address text.
| Parameter | Type | Description |
|---|---|---|
network | IpNetwork |
Returns str
def format(network: IpNetwork) -> str:
"""``address/prefix`` with the canonical address text."""
return f"{format_ip(network.network_address)}/{network.prefixlen}"first_address#
first_address(network: IPv4Network) -> IPv4Address
first_address(network: IPv6Network) -> IPv6Address| Parameter | Type | Description |
|---|---|---|
network |
@overload
def first_address(network: IPv4Network) -> IPv4Address: ...
@overload
def first_address(network: IPv6Network) -> IPv6Address: ...
def first_address(network: IpNetwork) -> IpAddress:
return network.network_addresslast_address#
last_address(network: IPv4Network) -> IPv4Address
last_address(network: IPv6Network) -> IPv6Address| Parameter | Type | Description |
|---|---|---|
network |
@overload
def last_address(network: IPv4Network) -> IPv4Address: ...
@overload
def last_address(network: IPv6Network) -> IPv6Address: ...
def last_address(network: IpNetwork) -> IpAddress:
return network.broadcast_addressaddress_count#
address_count(network) -> int| Parameter | Type | Description |
|---|---|---|
network | IpNetwork |
Returns int
def address_count(network: IpNetwork) -> int:
return network.num_addressescontains#
contains(network, address) -> boolWhether address is in network (never across families).
| Parameter | Type | Description |
|---|---|---|
network | IpNetwork | |
address | IpAddress |
Returns bool
def contains(network: IpNetwork, address: IpAddress) -> bool:
"""Whether ``address`` is in ``network`` (never across families)."""
return network.version == address.version and address in networkcontains_network#
contains_network(network, other) -> boolWhether every address of other is in network.
| Parameter | Type | Description |
|---|---|---|
network | IpNetwork | |
other | IpNetwork |
Returns bool
def contains_network(network: IpNetwork, other: IpNetwork) -> bool:
"""Whether every address of ``other`` is in ``network``."""
return network.prefixlen <= other.prefixlen and contains(network, other.network_address)overlaps#
overlaps(network, other) -> boolWhether the two networks share an address.
| Parameter | Type | Description |
|---|---|---|
network | IpNetwork | |
other | IpNetwork |
Returns bool
def overlaps(network: IpNetwork, other: IpNetwork) -> bool:
"""Whether the two networks share an address."""
if network.prefixlen <= other.prefixlen:
return contains(network, other.network_address)
return contains(other, network.network_address)