GNOME Python API documentation
==============================


GNOME version:  47.4


Also known as: `PyGObject <https://pygobject.gnome.org>`_ API docs.

This site contains documentation for the latest release of the GNOME libraries: GTK 4, LibAdwaita, etc.
The documentation is organized by library. Each library has its own page,
which lists all the classes, functions, and other objects in that library.

The documentation is generated from the actual API, as exposed by PyGObject.

The API for the PyGObject library itself (:mod:`gi`) is documented in the `PyGObject User Guide <https://pygobject.gnome.org/guide>`_.

.. note::

   The documentation is derived from the official C-based API's. This means that the documentation can contain
   C-specific wording. Code examples are not translated to Python.
   In general that should not be a problem, since the mapping from C to Python is pretty straightforward.

If you find an inconsistency in the API docs, please `create an issue <https://gitlab.gnome.org/GNOME/pygobject-docs/-/issues>`_.

.. toctree::
   :class: library-index
   :maxdepth: 1
   :glob:
   :caption: Libraries



   GLib-2.0/index

   Gio-2.0/index

   GObject-2.0/index

   Gtk-4.0/index

   Gdk-4.0/index

   Adw-1/index

   DBus-1.0/index

   DBusGLib-1.0/index

   Flatpak-1.0/index

   GModule-2.0/index

   Gcr-4/index

   GdkPixbuf-2.0/index

   GdkPixdata-2.0/index

   GdkWayland-4.0/index

   GdkX11-4.0/index

   Graphene-1.0/index

   Gsk-4.0/index

   Gst-1.0/index

   GstBase-1.0/index

   GstCheck-1.0/index

   GstController-1.0/index

   GstNet-1.0/index

   GtkSource-5/index

   HarfBuzz-0.0/index

   ICal-3.0/index

   JavaScriptCore-6.0/index

   Pango-1.0/index

   PangoCairo-1.0/index

   PangoFT2-1.0/index

   PangoFc-1.0/index

   PangoOT-1.0/index

   PangoXft-1.0/index

   Shumate-1.0/index

   Soup-3.0/index

   Vte-3.91/index

   WebKit-6.0/index

   WebKitWebProcessExtension-6.0/index

   Xdp-1.0/index

   XdpGtk4-1.0/index

   pycairo <https://pycairo.readthedocs.io/>


.. seealso::

   `PyGObject Docs <https://pygobject.gnome.org/>`__
      Documentation about the PyGObject library, and usage.

   `GNOME Developer Documentation <https://developer.gnome.org/>`__
      Everything you need to know to build GNOME applications.