QNetworkInterface

PyQt5.QtNetwork.QNetworkInterface

Description

The QNetworkInterface class provides a listing of the host’s IP addresses and network interfaces.

QNetworkInterface represents one network interface attached to the host where the program is being run. Each network interface may contain zero or more IP addresses, each of which is optionally associated with a netmask and/or a broadcast address. The list of such trios can be obtained with addressEntries(). Alternatively, when the netmask or the broadcast addresses or other information aren’t necessary, use the allAddresses() convenience function to obtain just the IP addresses of the active interfaces.

QNetworkInterface also reports the interface’s hardware address with hardwareAddress().

Not all operating systems support reporting all features. Only the IPv4 addresses are guaranteed to be listed by this class in all platforms. In particular, IPv6 address listing is only supported on Windows, Linux, macOS and the BSDs.

See also

QNetworkAddressEntry.

Classes

InterfaceFlags

Enums

InterfaceFlag

Specifies the flags associated with this network interface. The possible values are:

Note that one network interface cannot be both broadcast-based and point-to-point.

Member	Value	Description
CanBroadcast	0x4	the network interface works in broadcast mode
CanMulticast	0x20	the network interface supports multicasting
IsLoopBack	0x8	the network interface is a loopback interface: that is, it’s a virtual interface whose destination is the host computer itself
IsPointToPoint	0x10	the network interface is a point-to-point interface: that is, there is one, single other address that can be directly reached by it.
IsRunning	0x2	the network interface has resources allocated
IsUp	0x1	the network interface is active

---

InterfaceType

TODO

Member	Value	Description
CanBus	TODO	TODO
Ethernet	TODO	TODO
Fddi	TODO	TODO
Ieee1394	TODO	TODO
Ieee80211	TODO	TODO
Ieee802154	TODO	TODO
Ieee80216	TODO	TODO
Loopback	TODO	TODO
Phonet	TODO	TODO
Ppp	TODO	TODO
SixLoWPAN	TODO	TODO
Slip	TODO	TODO
Unknown	TODO	TODO
Virtual	TODO	TODO
Wifi	TODO	TODO

Methods

__init__()

Constructs an empty network interface object.

---

__init__(QNetworkInterface)

Creates a copy of the QNetworkInterface object contained in other.

---

addressEntries() → List[QNetworkAddressEntry]

Returns the list of IP addresses that this interface possesses along with their associated netmasks and broadcast addresses.

If the netmask or broadcast address or other information is not necessary, you can call the allAddresses() function to obtain just the IP addresses of the active interfaces.

---

@staticmethod
allAddresses() → List[QHostAddress]

This convenience function returns all IP addresses found on the host machine. It is equivalent to calling addressEntries() on all the objects returned by allInterfaces() that are in the IsUp state to obtain lists of QNetworkAddressEntry objects then calling ip() on each of these.

---

@staticmethod
allInterfaces() → List[QNetworkInterface]

Returns a listing of all the network interfaces found on the host machine. In case of failure it returns a list with zero elements.

---

flags() → InterfaceFlags

Returns the flags associated with this network interface.

---

hardwareAddress() → str

Returns the low-level hardware address for this interface. On Ethernet interfaces, this will be a MAC address in string representation, separated by colons.

Other interface types may have other types of hardware addresses. Implementations should not depend on this function returning a valid MAC address.

See also

type().

---

humanReadableName() → str

Returns the human-readable name of this network interface on Windows, such as “Local Area Connection”, if the name could be determined. If it couldn’t, this function returns the same as name(). The human-readable name is a name that the user can modify in the Windows Control Panel, so it may change during the execution of the program.

On Unix, this function currently always returns the same as name(), since Unix systems don’t store a configuration for human-readable names.

---

index() → int

Returns the interface system index, if known. This is an integer assigned by the operating system to identify this interface and it generally doesn’t change. It matches the scope ID field in IPv6 addresses.

If the index isn’t known, this function returns 0.

---

@staticmethod
interfaceFromIndex(int) → QNetworkInterface

Returns a QNetworkInterface object for the interface whose internal ID is index. Network interfaces have a unique identifier called the “interface index” to distinguish it from other interfaces on the system. Often, this value is assigned progressively and interfaces being removed and then added again get a different value every time.

This index is also found in the IPv6 address’ scope ID field.

---

@staticmethod
interfaceFromName(str) → QNetworkInterface

Returns a QNetworkInterface object for the interface named name. If no such interface exists, this function returns an invalid QNetworkInterface object.

The string name may be either an actual interface name (such as “eth0” or “en1”) or an interface index in string form (“1”, “2”, etc.).

See also

name(), isValid().

---

@staticmethod
interfaceIndexFromName(str) → int

TODO

---

@staticmethod
interfaceNameFromIndex(int) → str

TODO

---

isValid() → bool

Returns true if this QNetworkInterface object contains valid information about a network interface.

---

maximumTransmissionUnit() → int

TODO

---

name() → str

Returns the name of this network interface. On Unix systems, this is a string containing the type of the interface and optionally a sequence number, such as “eth0”, “lo” or “pcn0”. On Windows, it’s an internal ID that cannot be changed by the user.

---

swap(QNetworkInterface)

TODO

---

type() → InterfaceType

TODO