1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# -*- Mode: Python; py-indent-offset: 4 -*-
# vim: tabstop=4 shiftwidth=4 expandtab
#
# Copyright (C) 2005-2009 Johan Dahlin <johan@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
# support overrides in different directories than our gi module
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
import sys
import os
import importlib
import types
_static_binding_error = ('When using gi.repository you must not import static '
'modules like "gobject". Please change all occurrences '
'of "import gobject" to "from gi.repository import GObject". '
'See: https://bugzilla.gnome.org/show_bug.cgi?id=709183')
# we can't have pygobject 2 loaded at the same time we load the internal _gobject
if 'gobject' in sys.modules:
raise ImportError(_static_binding_error)
from . import _gi
from ._gi import _API
from ._gi import Repository
from ._gi import PyGIDeprecationWarning
from ._gi import PyGIWarning
_API = _API # pyflakes
PyGIDeprecationWarning = PyGIDeprecationWarning
PyGIWarning = PyGIWarning
_versions = {}
_overridesdir = os.path.join(os.path.dirname(__file__), 'overrides')
# Needed for compatibility with "pygobject.h"/pygobject_init()
_gobject = types.ModuleType("gi._gobject")
sys.modules[_gobject.__name__] = _gobject
_gobject._PyGObject_API = _gi._PyGObject_API
_gobject.pygobject_version = _gi.pygobject_version
version_info = _gi.pygobject_version[:]
__version__ = "{0}.{1}.{2}".format(*version_info)
_gi.register_foreign()
class _DummyStaticModule(types.ModuleType):
__path__ = None
def __getattr__(self, name):
raise AttributeError(_static_binding_error)
sys.modules['glib'] = _DummyStaticModule('glib', _static_binding_error)
sys.modules['gobject'] = _DummyStaticModule('gobject', _static_binding_error)
sys.modules['gio'] = _DummyStaticModule('gio', _static_binding_error)
sys.modules['gtk'] = _DummyStaticModule('gtk', _static_binding_error)
sys.modules['gtk.gdk'] = _DummyStaticModule('gtk.gdk', _static_binding_error)
def check_version(version):
if isinstance(version, str):
version_list = tuple(map(int, version.split(".")))
else:
version_list = version
if version_list > version_info:
raise ValueError((
"pygobject's version %s required, and available version "
"%s is not recent enough") % (version, __version__)
)
def 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')
"""
repository = Repository.get_default()
if not isinstance(version, str):
raise ValueError('Namespace version needs to be a string.')
if namespace in repository.get_loaded_namespaces():
loaded_version = repository.get_version(namespace)
if loaded_version != version:
raise ValueError('Namespace %s is already loaded with version %s' %
(namespace, loaded_version))
if namespace in _versions and _versions[namespace] != version:
raise ValueError('Namespace %s already requires version %s' %
(namespace, _versions[namespace]))
available_versions = repository.enumerate_versions(namespace)
if not available_versions:
raise ValueError('Namespace %s not available' % namespace)
if version not in available_versions:
raise ValueError('Namespace %s not available for version %s' %
(namespace, version))
_versions[namespace] = version
def 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'})
"""
for module_name, module_version in requires.items():
require_version(module_name, module_version)
def get_required_version(namespace):
return _versions.get(namespace, None)
def 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')
"""
try:
_gi.require_foreign(namespace, symbol)
except Exception as e:
raise ImportError(str(e))
importlib.import_module('gi.repository', namespace)
|
