:mod:`ipaddress`
================

.. py:module:: ipaddress

.. autoapi-nested-parse::

   The `ipaddress` module provides types for IP addresses. It is a subset of CPython's ipaddress
   module.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> AITHinker ESP32-C3S_Kit
    <li> ATMegaZero ESP32-S2
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit FunHouse
    <li> Adafruit MagTag
    <li> Adafruit Metro ESP32S2
    <li> Adafruit QT Py ESP32S2
    <li> Artisense Reference Design RD00
    <li> BastWiFi
    <li> CrumpS2
    <li> ESP 12k NodeMCU
    <li> Feather ESP32S2 without PSRAM
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MORPHEANS MorphESP-240
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> S2Mini
    <li> S2Pico
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Thingz - Galaxia
    <li> TinyS2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    </ul>
    </details>
    </p>




.. py:function:: ip_address(obj: Union[int, str]) -> IPv4Address

   Return a corresponding IP address object or raise ValueError if not possible.


.. py:class:: IPv4Address(address: Union[int, str, bytes])

   Encapsulates an IPv4 address.

   Create a new IPv4Address object encapsulating the address value.

   The value itself can either be bytes or a string formatted address.

   .. py:attribute:: packed
      :annotation: :bytes

      The bytes that make up the address (read-only).


   .. py:attribute:: version
      :annotation: :int

      4 for IPv4, 6 for IPv6


   .. py:method:: __eq__(other: object) -> bool

      Two Address objects are equal if their addresses and address types are equal.


   .. py:method:: __hash__() -> int

      Returns a hash for the IPv4Address data.