:right-sidebar: True

IOModule
===================================================================

.. currentmodule:: gi.repository.Gio





.. class:: IOModule(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.TypeModule`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.GObject.TypePlugin`



Provides an interface and default functions for loading and unloading
modules. This is used internally to make GIO extensible, but can also
be used by others to implement module loading.


Constructors
------------

.. rst-class:: interim-class

.. class:: IOModule
   :no-index:


   .. classmethod:: new(filename: str) -> ~gi.repository.Gio.IOModule

      Creates a new GIOModule that will load the specific
      shared library when in use.






      :param filename: filename of the shared library module.








Methods
-------

.. rst-class:: interim-class

.. class:: IOModule
   :no-index:


   .. classmethod:: query() -> list[str]

      Optional API for GIO modules to implement.

      Should return a list of all the extension points that may be
      implemented in this module.

      This method will not be called in normal use, however it may be
      called when probing existing modules and recording which extension
      points that this model is used for. This means we won't have to
      load and initialize this module unless its needed.

      If this function is not implemented by the module the module will
      always be loaded, initialized and then unloaded on application
      startup so that it can register its extension points during init.

      Note that a module need not actually implement all the extension
      points that :func:`~gi.repository.Gio.IOModule.query` returns, since the exact list of
      extension may depend on runtime issues. However all extension
      points actually implemented must be returned by :func:`~gi.repository.Gio.IOModule.query`
      (if defined).

      When installing a module that implements :func:`~gi.repository.Gio.IOModule.query` you must
      run gio-querymodules in order to build the cache files required for
      lazy loading.

      Since 2.56, this function should be named ``g_io_<modulename>_query``\, where
      ``modulename`` is the plugin’s filename with the ``lib`` or ``libgio`` prefix and
      everything after the first dot removed, and with ``-`` replaced with ``_``
      throughout. For example, ``libgiognutls-helper.so`` becomes ``gnutls_helper``\.
      Using the new symbol names avoids name clashes when building modules
      statically. The old symbol names continue to be supported, but cannot be used
      for static builds.


      .. versionadded:: 2.24