Skip to main content

netimps

Version Python versions License: MIT Docs CI

The network utilities every tool ends up rewriting — interface discovery, "which is my IP", reachability checks, CIDR maths, host:port parsing, DNS, ping, scanning and multicast — as one typed, flat-import library.

Built on the standard library, with no hard runtime dependencies. resolve() tries dnspython, the OS resolver and nslookup, in that order, using whichever is available (pip install netimps[dns] for dnspython itself, the fullest of the three: structured records, every record type, explicit nameserver/search-list control). Interface enumeration, routing and multicast are ctypes bindings to the platform's own APIs, so there is nothing to compile and no wheel to miss for your platform.

Features

  • Interface discovery, no dependenciesget_interfaces() gives adapter names, MACs, MTU and real prefix lengths on Linux, macOS/BSD and Windows, via getifaddrs(3) / GetAdaptersAddresses. No ifaddr required.
  • One parsing entry pointparse(value, type) with non-raising try_parse and boolean is_valid siblings. Type-form overloads preserve the parsed result, including v4/v6 union aliases and caller-supplied defaults.
  • MACAddress — colon/hyphen/dot/bare plus int/bytes, hashable and ordered, with .oui, .is_multicast, .is_local and case-selectable rendering.
  • The socket helpers everyone rewritesget_source_ip, get_free_port, tcp_check, wait_for_port.
  • Local membership lookupsinterface_for() gives the first adapter for an address, interface, network or MAC; interfaces_for() yields every match, and is_local_address() distinguishes assignment from mere address scope.
  • Routing and MTUget_route (first hop, unprivileged), hop_count (raw sockets or traceroute fallback), discover_mtu / get_pmtu, Interface.mtu.
  • CIDR set mathscollapse and subtract, the latter missing from ipaddress entirely.
  • normalize_hosthost:port splitting that gets IPv6 brackets right.
  • Scanning — concurrent scan_ports / scan_hosts.
  • Socket setupbind() with the options named, UdpEndpoint for UDP servers that need to know which interface a datagram arrived on, and retry() for the backoff loop everyone writes without jitter.
  • Multicastmulticast_socket handling the join dance whose failure modes are otherwise silent.
  • DNS and pingresolve() chaining dnspython/OS resolver/nslookup backends and returning native types, accepting an IP/interface object directly and auto-selecting a reverse lookup for an address query; ping() returning round-trip time and TTL, not just a boolean.

Installation

pip install netimps          # the library -- no hard dependencies
pip install netimps[dns]     # plus dnspython, for resolve()'s fullest backend
pip install netimps[cli]     # plus the `netimps` command

Requires Python 3.9+. Both extras are additive and independent; importing the library never requires either.

Command line

netimps interfaces                       # names, MACs, MTU, addresses
netimps ping 8.8.8.8 -m tcp -p 443       # icmp | tcp | udp
netimps resolve example.com aaaa
netimps resolve 8.8.8.8                  # no rdtype -> auto ptr -> dns.google
netimps check example.com https          # port number or scheme name
netimps mtu 8.8.8.8                      # measured, not guessed
netimps scan 192.0.2.0/29 -p common
netimps addr 00:00:5e:00:53:01           # address, network or MAC
netimps split '[::1]:8080'               # -> ::1  8080

Every command takes --json. Exit codes are meaningful: 0 success, 1 "the answer was no", 2 a caller error.

Quick start

import netimps
from netimps import IPAddress, IPNetwork, MACAddress, parse

# Interfaces: names, MACs, MTU and real prefixes on every OS
for iface in netimps.get_interfaces():
    print(iface.name, iface.mac, iface.mtu, [str(ip) for ip in iface.ips])
    # 'Wi-Fi'  00:00:5e:00:53:01  1500  ['192.0.2.10/24', 'fe80::.../64']

# Types annotate; parse builds
def route(dst: IPAddress, via: IPNetwork) -> None: ...

parse("10.0.0.5")                        # IPv4Address('10.0.0.5')
parse("10.0.0.5/24", IPNetwork)          # IPv4Network('10.0.0.0/24')
netimps.try_parse("nope", IPAddress)     # None
netimps.is_valid("::1", IPAddress)       # True

# Which of my addresses actually reaches that host?
netimps.get_source_ip("8.8.8.8")         # IPv4Address('192.0.2.10')
netimps.get_route("8.8.8.8").gateway     # IPv4Address('192.0.2.1')

# Exact assignment, subnet membership, or MAC ownership
netimps.interface_for("192.0.2.10")      # first matching Interface, or None
list(netimps.interfaces_for(parse("192.0.2.0/24", IPNetwork)))
netimps.is_local_address("127.0.0.1")    # True without interface discovery

# Honest reachability, and waiting for a service
netimps.tcp_check("example.com", 443)              # True
netimps.wait_for_port("localhost", 5432, timeout=60)

# CIDR set maths
netimps.subtract(["10.0.0.0/24"], ["10.0.0.64/26"])
# [IPv4Network('10.0.0.0/26'), IPv4Network('10.0.0.128/25')]

# host:port, including the IPv6 case people get wrong
netimps.normalize_host("[::1]:8080")     # ('::1', 8080)
netimps.normalize_host("::1")            # ('::1', None)  -- not port 1

# MAC addresses
mac = MACAddress("AA-BB-CC-DD-EE-FF")
mac.as_str("-", upper=True)              # 'AA-BB-CC-DD-EE-FF'
mac.is_local, mac.oui.hex()              # (True, 'aabbcc') -- AA has the U/L bit

# DNS returns native types
netimps.resolve("example.com")[0].is_global   # an IPv4Address, not a str
netimps.resolve("example.com", "txt")         # ['v=spf1 -all']  -- unquoted

# ping carries the details, and can use TCP or UDP where ICMP is blocked
result = netimps.ping("8.8.8.8")
result.ok, result.rtt_ms, result.ttl     # (True, 9.0, 119)
netimps.ping("8.8.8.8", method="tcp", port=53)   # times the handshake

# Path MTU, measured rather than guessed
netimps.discover_mtu("8.8.8.8")                       # 1500
netimps.discover_mtu("10.0.0.5", method="udp", port=9999)
netimps.get_tcp_mss("example.com", 443)               # 1460

# Scanning and multicast
netimps.scan_ports("192.168.1.1", ["ssh", "https"])   # [22, 443]
sock = netimps.multicast_socket("224.0.0.251", 5353)  # mDNS listener

# Server-side: bind with the options named, and know where packets came from
server = netimps.bind("", 6767, broadcast=True)
endpoint = netimps.UdpEndpoint(server)

# Retry with backoff and jitter
netimps.retry(lambda: netimps.tcp_check("example.com", 443), attempts=3)

API overview

Name Purpose
IPAddress, IPInterface, IPNetwork v4/v6 union aliases for annotations
IPAddressLike, IPInterfaceLike, IPNetworkLike, MACLike accepted-input unions
AddressLike accepted-input union for a single destination (hostname, address, or IPv4Interface/IPv6Interface — its .ip is used)
IPv4Address, IPv4Interface, ... stdlib concrete-type re-exports
parse, try_parse, is_valid build a type from a value (raising / None / bool)
MACAddress parse / classify / render MAC addresses
get_interfaces, Interface, iter_addresses native cross-platform NIC discovery
get_ip, is_link_scoped address resolution and scope classification
collapse, subtract CIDR set maths
normalize_host host:port splitting, IPv6-aware
get_default_port, get_default_scheme, register_port scheme ↔ port registry
resolve DNS lookup → native records ([] on failure)
ping, PingResult reachability with RTT and TTL
bind, bind_error_hint, interface_for, interfaces_for, is_local_address socket creation and local membership
get_source_ip, get_free_port, tcp_check, wait_for_port socket helpers
UdpEndpoint, Datagram UDP receive with arrival interface (IP_PKTINFO)
Host hostname-or-address value type
retry, backoff_delays bounded retry with exponential backoff
APIPA, LOOPBACK_V4, LOOPBACK_V6, LINK_LOCAL_V6 named networks
get_route, Route, hop_count routing and distance
discover_mtu, get_pmtu, get_tcp_mss path MTU by ICMP/UDP/TCP, the kernel's cached guess, or the negotiated MSS
scan_ports, scan_hosts, PORT_RANGES concurrent scanning
multicast_socket, join_group, leave_group, is_multicast multicast
HOST_DN platform.node(), captured at import time

Full per-export reference, with contracts and gotchas, lives in src/netimps/AGENTS.md.

Design notes

A few behaviours are deliberate and worth knowing:

  • Interface.is_loopback is computed from addresses, not nameslo, lo0 and Loopback Pseudo-Interface 1 share no spelling.
  • Concrete types are strict about family. parse("::1", IPAddress) works; parse("::1", IPv4Address) raises rather than quietly returning v6.
  • Networks parse non-strict by default, so 10.0.0.5/24 normalises instead of raising. Pass strict=True for stdlib behaviour.
  • Addresses can belong to more than one interface. interface_for() keeps the historical first-match result; use interfaces_for() when duplicates such as unscoped IPv6 link-local assignments matter.
  • resolve raises on a malformed query rather than returning [] — a typo'd record type should not look like "no such record".
  • ping(ttl=...) behaves the same on every OS. Windows ping exits 0 for "TTL expired in transit", so the reply address is verified instead of trusting the exit code.
  • hop_count works unprivileged, falling back to the system traceroute when a raw socket is unavailable.
  • discover_mtu measures; get_pmtu only reports what the kernel cached. The latter is usually None, and always None on Windows. On one real host the local link was 9000 and the true path MTU 1500 — only probing found it.

Development

python -m venv .venv/dev
.venv/dev/Scripts/pip install -e ".[dev]"   # POSIX: .venv/dev/bin/pip
.venv/dev/Scripts/pytest -q
.venv/dev/Scripts/black src/ tests/

Tested on Python 3.9 (the floor) and 3.14.

Releasing

This project follows Semantic Versioning and keeps a CHANGELOG.md. Pushing a tag matching v* triggers the release workflow: test gate → build → publish → docs deploy.

License

MIT — see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netimps-0.2.1.tar.gz (124.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netimps-0.2.1-py3-none-any.whl (100.4 kB view details)

Uploaded Python 3

File details

Details for the file netimps-0.2.1.tar.gz.

File metadata

  • Download URL: netimps-0.2.1.tar.gz
  • Upload date:
  • Size: 124.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for netimps-0.2.1.tar.gz
Algorithm Hash digest
SHA256 8e66d9d582c8d7a8209a92e88c43c83aa97188d0a6634de07d5a1b9e3336e0f8
MD5 dac84703d27b973eb396549b840ba47f
BLAKE2b-256 8dda3c7791e01a006f444a29d5b77078c7f8dd9486191b335c5df29dadea6b6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for netimps-0.2.1.tar.gz:

Publisher: release.yml on jose-pr/netimps

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netimps-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: netimps-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 100.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for netimps-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 26c5bd6b032e66a29d6e405ae328666bcd916476d29015d3afa8582ee22f991c
MD5 bfcf151a18effed0efcff5cd10a3bf5b
BLAKE2b-256 db13e829d6af20c3a1966a33b5eb17f73351ec41fed060ef3d054beb6e4e9081

See more details on using hashes here.

Provenance

The following attestation bundles were made for netimps-0.2.1-py3-none-any.whl:

Publisher: release.yml on jose-pr/netimps

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.2

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.0

2 files

0.0.2

2 files

0.0.1

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page