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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
#
# Kiwi: a Framework and Enhanced Widgets for Python
#
# Copyright (C) 2005-2007 Async Open Source
#
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA
#
# Author(s): Lorenzo Gil Sanchez <lgs@sicem.biz>
# Johan Dahlin <jdahlin@async.com.br>
#
"""GObject utilities and addons"""
import os
import struct
import sys
import gobject
HAVE_2_6 = gobject.pygtk_version[:2] <= (2, 6)
# When we can depend on 2.8 clean this up, so ClassInittable does not
# need to be tied to GObjectMeta, since it doesn't need to be a GObject
# Always use type for epydoc, since GObjectMeta creates lots of trouble
# for us when using fake objects.
if HAVE_2_6 or os.path.basename(sys.argv[0]) == 'epyrun':
metabase = type
else:
metabase = gobject.GObjectMeta
def list_properties(gtype, parent=True):
"""
Return a list of all properties for GType gtype, excluding
properties in parent classes
"""
pspecs = gobject.list_properties(gtype)
if parent:
return pspecs
parent = gobject.type_parent(gtype)
parent_pspecs = gobject.list_properties(parent)
return [pspec for pspec in pspecs
if pspec not in parent_pspecs]
def type_register(gtype):
"""Register the type, but only if it's not already registered
@param gtype: the class to register
"""
# copied from gobjectmodule.c:_wrap_type_register
if (getattr(gtype, '__gtype__', None) !=
getattr(gtype.__base__, '__gtype__', None)):
return False
gobject.type_register(gtype)
return True
class _GObjectClassInittableMetaType(metabase):
def __init__(self, name, bases, namespace):
metabase.__init__(self, name, bases, namespace)
self.__class_init__(namespace)
class _GobjectClassInittableObject(object):
__metaclass__ = _GObjectClassInittableMetaType
def __class_init__(cls, namespace):
pass
__class_init__ = classmethod(__class_init__)
class PropertyMeta(_GObjectClassInittableMetaType):
"""
Metaclass that takes into account properties and signals
of baseclasses, even if they're not GObject subclasses.
Which allows you to put signals and properties in mixin
classes.
"""
# pylint fails to understand this is a metaclass
def __init__(self, name, bases, namespace):
def _update_bases(bases, props, signals):
for base in bases:
props.update(getattr(base, '__gproperties__', {}))
signals.update(getattr(base, '__gsignals__', {}))
_update_bases(base.__bases__, props, signals)
for base in bases:
if issubclass(base, gobject.GObject):
# This will be fun.
# Merge in properties and signals from all bases, this
# is not the default behavior of PyGTK, but we need it
props = namespace.setdefault('__gproperties__', {})
signals = namespace.setdefault('__gsignals__', {})
_update_bases(bases, props, signals)
break
# Workaround brokenness in PyGObject meta/type registration
props = namespace.get('__gproperties__', {})
signals = namespace.get('__gsignals__', {})
if hasattr(self, '__gtype__'):
self.__gproperties__ = props
self.__gsignals__ = signals
gtype = self.__gtype__
# Delete signals and properties which are already
# present in the list
signal_names = gobject.signal_list_names(gtype)
for signal in signals.copy():
if signal in signal_names :
del signals[signal]
prop_names = [prop.name for prop in gobject.list_properties(gtype)]
for prop in props.copy():
if prop in prop_names:
del props[prop]
if HAVE_2_6 and issubclass(self, gobject.GObject):
gobject.type_register(self)
_GObjectClassInittableMetaType.__init__(self, name, bases, namespace)
# The metaclass forgets to remove properties and signals
self.__gproperties__ = {}
self.__gsignals__ = {}
def __call__(self, *args, **kwargs):
rv = super(PropertyMeta, self).__call__(*args, **kwargs)
rv.__post_init__()
return rv
class PropertyObject(object):
"""
I am an object which maps GObject properties to attributes
To be able to use me, you must also inherit from a
gobject.GObject subclass.
Example:
>>> from kiwi.utils import PropertyObject, gproperty
>>> class Person(PropertyObject, gobject.GObject):
>>> gproperty('name', str)
>>> gproperty('age', int)
>>> gproperty('married', bool, False)
>>> test = Test()
>>> test.age = 20
>>> test.age
20
>>> test.married
False
"""
__metaclass__ = PropertyMeta
_default_values = {}
def __init__(self, **kwargs):
self._attributes = {}
if not isinstance(self, gobject.GObject):
raise TypeError("%r must be a GObject subclass" % self)
defaults = self._default_values.copy()
for kwarg in kwargs:
if not kwarg in defaults:
raise TypeError("Unknown keyword argument: %s" % kwarg)
defaults.update(kwargs)
for name, value in defaults.items():
self._set(name, value)
def __class_init__(cls, namespace):
# Do not try to register gobject subclasses
# If you try to instantiate an object you'll get a warning,
# So it is safe to ignore here.
if not issubclass(cls, gobject.GObject):
return
# Create python properties for gobject properties, store all
# the values in self._attributes, so do_set/get_property
# can access them. Using set property for attribute assignments
# allows us to add hooks (notify::attribute) when they change.
default_values = {}
for pspec in list_properties(cls, parent=False):
prop_name = pspec.name.replace('-', '_')
p = property(lambda self, n=prop_name: self._attributes[n],
lambda self, v, n=prop_name: self.set_property(n, v))
setattr(cls, prop_name, p)
if hasattr(pspec, 'default_value'):
default_values[prop_name] = pspec.default_value
cls._default_values.update(default_values)
__class_init__ = classmethod(__class_init__)
def __post_init__(self):
"""
A hook which is called after the constructor is called.
It's mainly here to workaround
http://bugzilla.gnome.org/show_bug.cgi?id=425501
so you can set properties at construction time
"""
def _set(self, name, value):
func = getattr(self, 'prop_set_%s' % name, None)
if callable(func) and func:
value = func(value)
self._attributes[name] = value
def _get(self, name):
func = getattr(self, 'prop_get_%s' % name, None)
if callable(func) and func:
return func()
return self._attributes[name]
def get_attribute_names(self):
return self._attributes.keys()
def is_default_value(self, attr, value):
return self._default_values[attr] == value
def do_set_property(self, pspec, value):
prop_name = pspec.name.replace('-', '_')
self._set(prop_name, value)
def do_get_property(self, pspec):
prop_name = pspec.name.replace('-', '_')
return self._get(prop_name)
def gsignal(name, *args, **kwargs):
"""
Add a GObject signal to the current object.
It current supports the following types:
- str, int, float, long, object, enum
@param name: name of the signal
@type name: string
@param args: types for signal parameters,
if the first one is a string 'override', the signal will be
overridden and must therefor exists in the parent GObject.
@note: flags: A combination of;
- gobject.SIGNAL_RUN_FIRST
- gobject.SIGNAL_RUN_LAST
- gobject.SIGNAL_RUN_CLEANUP
- gobject.SIGNAL_NO_RECURSE
- gobject.SIGNAL_DETAILED
- gobject.SIGNAL_ACTION
- gobject.SIGNAL_NO_HOOKS
@note: retval: return value in signal callback
"""
frame = sys._getframe(1)
try:
locals = frame.f_locals
finally:
del frame
dict = locals.setdefault('__gsignals__', {})
if args and args[0] == 'override':
dict[name] = 'override'
else:
retval = kwargs.get('retval', None)
if retval is None:
default_flags = gobject.SIGNAL_RUN_FIRST
else:
default_flags = gobject.SIGNAL_RUN_LAST
flags = kwargs.get('flags', default_flags)
if retval is not None and flags != gobject.SIGNAL_RUN_LAST:
raise TypeError(
"You cannot use a return value without setting flags to "
"gobject.SIGNAL_RUN_LAST")
dict[name] = (flags, retval, args)
def _max(c):
# Python 2.3 does not like bitshifting here
return 2 ** ((8 * struct.calcsize(c)) - 1) - 1
_MAX_VALUES = {int : _max('i'),
float: float(2**1024 - 2**971),
long : _max('l') }
_DEFAULT_VALUES = {str : '', float : 0.0, int : 0, long : 0L}
def gproperty(name, ptype, default=None, nick='', blurb='',
flags=gobject.PARAM_READWRITE, **kwargs):
"""
Add a GObject property to the current object.
@param name: name of property
@type name: string
@param ptype: type of property
@type ptype: type
@param default: default value
@param nick: short description
@param blurb: long description
@param flags: parameter flags, a combination of:
- PARAM_READABLE
- PARAM_READWRITE
- PARAM_WRITABLE
- PARAM_CONSTRUCT
- PARAM_CONSTRUCT_ONLY
- PARAM_LAX_VALIDATION
Optional, only for int, float, long types:
@note: minimum: minimum allowed value
@note: maximum: maximum allowed value
"""
# General type checking
if default is None:
default = _DEFAULT_VALUES.get(ptype)
elif not isinstance(default, ptype):
raise TypeError("default must be of type %s, not %r" % (
ptype, default))
if not isinstance(nick, str):
raise TypeError('nick for property %s must be a string, not %r' % (
name, nick))
nick = nick or name
if not isinstance(blurb, str):
raise TypeError('blurb for property %s must be a string, not %r' % (
name, blurb))
# Specific type checking
if ptype == int or ptype == float or ptype == long:
default = (kwargs.get('minimum', ptype(0)),
kwargs.get('maximum', _MAX_VALUES[ptype]),
default)
elif ptype == bool:
if (default is not True and
default is not False):
raise TypeError("default must be True or False, not %r" % (
default))
default = default,
elif gobject.type_is_a(ptype, gobject.GEnum):
if default is None:
raise TypeError("enum properties needs a default value")
elif not isinstance(default, ptype):
raise TypeError("enum value %s must be an instance of %r" %
(default, ptype))
default = default,
elif ptype == str:
default = default,
elif ptype == object:
if default is not None:
raise TypeError("object types does not have default values")
default = ()
else:
raise NotImplementedError("type %r" % ptype)
if flags < 0 or flags > 32:
raise TypeError("invalid flag value: %r" % (flags,))
frame = sys._getframe(1)
try:
locals = frame.f_locals
dict = locals.setdefault('__gproperties__', {})
finally:
del frame
dict[name] = (ptype, nick, blurb) + default + (flags,)
def quote(msg):
"""
Similar to urllib.quote but for glibs GMarkup
@param msg: string to quote
@returns: quoted string
"""
msg = msg.replace('&', '&')
msg = msg.replace('<', '<')
msg = msg.replace('>', '>')
return msg
|