gi - pydoc - phpman

Help on package gi:

NAME
    gi

DESCRIPTION
    # -*- Mode: Python; py-indent-offset: 4 -*-
    # vim: tabstop=4 shiftwidth=4 expandtab
    #
    # Copyright (C) 2005-2009 Johan Dahlin <johan AT gnome.org>
    #
    # This library is free software; you can redistribute it and/or
    # modify it under the terms of the GNU Lesser General Public
    # License as published by the Free Software Foundation; either
    # version 2.1 of the License, or (at your option) any later version.
    #
    # This library is distributed in the hope that it will be useful,
    # but WITHOUT ANY WARRANTY; without even the implied warranty of
    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    # Lesser General Public License for more details.
    #
    # You should have received a copy of the GNU Lesser General Public
    # License along with this library; if not, write to the Free Software
    # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
    # USA

PACKAGE CONTENTS
    _constants
    _error
    _gi
    _gtktemplate
    _option
    _ossighelper
    _propertyhelper
    _signalhelper
    docstring
    importer
    module
    overrides (package)
    pygtkcompat
    repository (package)
    types

SUBMODULES
    _gobject

CLASSES
    builtins.DeprecationWarning(builtins.Warning)
        PyGIDeprecationWarning
    builtins.Warning(builtins.Exception)
        PyGIWarning
    builtins.object
        Repository

    class PyGIDeprecationWarning(builtins.DeprecationWarning)
     |  Method resolution order:
     |      PyGIDeprecationWarning
     |      builtins.DeprecationWarning
     |      builtins.Warning
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors defined here:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.DeprecationWarning:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.DeprecationWarning:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

    class PyGIWarning(builtins.Warning)
     |  Method resolution order:
     |      PyGIWarning
     |      builtins.Warning
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |
     |  Data descriptors defined here:
     |
     |  __weakref__
     |      list of weak references to the object (if defined)
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Warning:
     |
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Warning:
     |
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |
     |  __reduce__(...)
     |      Helper for pickle.
     |
     |  __repr__(self, /)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |
     |  __setstate__(...)
     |
     |  __str__(self, /)
     |      Return str(self).
     |
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |
     |  __cause__
     |      exception cause
     |
     |  __context__
     |      exception context
     |
     |  __dict__
     |
     |  __suppress_context__
     |
     |  __traceback__
     |
     |  args

    class Repository(builtins.object)
     |  Methods defined here:
     |
     |  enumerate_versions(...)
     |
     |  find_by_name(...)
     |
     |  get_dependencies(...)
     |
     |  get_immediate_dependencies(...)
     |
     |  get_infos(...)
     |
     |  get_loaded_namespaces(...)
     |
     |  get_typelib_path(...)
     |
     |  get_version(...)
     |
     |  is_registered(...)
     |
     |  require(...)
     |
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |
     |  get_default(...)

FUNCTIONS
    check_version(version)

    get_required_version(namespace)

    require_foreign(namespace, symbol=None)
        Ensure the given foreign marshaling module is available and loaded.

        :param str namespace:
            Introspection namespace of the foreign module (e.g. "cairo")
        :param symbol:
            Optional symbol typename to ensure a converter exists.
        :type symbol: str or None
        :raises: ImportError

        :Example:

        .. code-block:: python

            import gi
            import cairo
            gi.require_foreign('cairo')

    require_version(namespace, version)
        Ensures the correct versions are loaded when importing `gi` modules.

        :param namespace: The name of module to require.
        :type namespace: str
        :param version: The version of module to require.
        :type version: str
        :raises ValueError: If module/version is already loaded, already required, or unavailable.

        :Example:

        .. code-block:: python

            import gi
            gi.require_version('Gtk', '3.0')

    require_versions(requires)
        Utility function for consolidating multiple `gi.require_version()` calls.

        :param requires: The names and versions of modules to require.
        :type requires: dict

        :Example:

        .. code-block:: python

            import gi
            gi.require_versions({'Gtk': '3.0', 'GLib': '2.0', 'Gio': '2.0'})

DATA
    version_info = (3, 42, 1)

VERSION
    3.42.1

FILE
    /usr/lib/python3/dist-packages/gi/__init__.py