Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

import types 

import warnings 

import importlib 

import sys 

from pkgutil import get_loader 

 

from gi import PyGIDeprecationWarning 

from gi._gi import CallableInfo 

from gi._constants import \ 

TYPE_NONE, \ 

TYPE_INVALID 

 

# support overrides in different directories than our gi module 

from pkgutil import extend_path 

__path__ = extend_path(__path__, __name__) 

 

 

# namespace -> (attr, replacement) 

_deprecated_attrs = {} 

 

 

def wraps(wrapped): 

def assign(wrapper): 

wrapper.__name__ = wrapped.__name__ 

wrapper.__module__ = wrapped.__module__ 

return wrapper 

return assign 

 

 

class OverridesProxyModule(types.ModuleType): 

"""Wraps a introspection module and contains all overrides""" 

 

def __init__(self, introspection_module): 

super(OverridesProxyModule, self).__init__( 

introspection_module.__name__) 

self._introspection_module = introspection_module 

 

def __getattr__(self, name): 

return getattr(self._introspection_module, name) 

 

def __dir__(self): 

result = set(dir(self.__class__)) 

result.update(self.__dict__.keys()) 

result.update(dir(self._introspection_module)) 

return sorted(result) 

 

def __repr__(self): 

return "<%s %r>" % (type(self).__name__, self._introspection_module) 

 

 

class _DeprecatedAttribute(object): 

"""A deprecation descriptor for OverridesProxyModule subclasses. 

 

Emits a PyGIDeprecationWarning on every access and tries to act as a 

normal instance attribute (can be replaced and deleted). 

""" 

 

def __init__(self, namespace, attr, value, replacement): 

self._attr = attr 

self._value = value 

self._warning = PyGIDeprecationWarning( 

'%s.%s is deprecated; use %s instead' % ( 

namespace, attr, replacement)) 

 

def __get__(self, instance, owner): 

if instance is None: 

raise AttributeError(self._attr) 

warnings.warn(self._warning, stacklevel=2) 

return self._value 

 

def __set__(self, instance, value): 

attr = self._attr 

# delete the descriptor, then set the instance value 

delattr(type(instance), attr) 

setattr(instance, attr, value) 

 

def __delete__(self, instance): 

# delete the descriptor 

delattr(type(instance), self._attr) 

 

 

def load_overrides(introspection_module): 

"""Loads overrides for an introspection module. 

 

Either returns the same module again in case there are no overrides or a 

proxy module including overrides. Doesn't cache the result. 

""" 

 

namespace = introspection_module.__name__.rsplit(".", 1)[-1] 

module_key = 'gi.repository.' + namespace 

 

# We use sys.modules so overrides can import from gi.repository 

# but restore everything at the end so this doesn't have any side effects 

has_old = module_key in sys.modules 

old_module = sys.modules.get(module_key) 

 

# Create a new sub type, so we can separate descriptors like 

# _DeprecatedAttribute for each namespace. 

proxy_type = type(namespace + "ProxyModule", (OverridesProxyModule, ), {}) 

 

proxy = proxy_type(introspection_module) 

sys.modules[module_key] = proxy 

 

# backwards compat: 

# gedit uses gi.importer.modules['Gedit']._introspection_module 

from ..importer import modules 

assert hasattr(proxy, "_introspection_module") 

modules[namespace] = proxy 

 

try: 

override_package_name = 'gi.overrides.' + namespace 

 

# http://bugs.python.org/issue14710 

try: 

override_loader = get_loader(override_package_name) 

 

except AttributeError: 

override_loader = None 

 

# Avoid checking for an ImportError, an override might 

# depend on a missing module thus causing an ImportError 

if override_loader is None: 

return introspection_module 

 

override_mod = importlib.import_module(override_package_name) 

 

finally: 

del modules[namespace] 

del sys.modules[module_key] 

if has_old: 

sys.modules[module_key] = old_module 

 

# backwards compat: for gst-python/gstmodule.c, 

# which tries to access Gst.Fraction through 

# Gst._overrides_module.Fraction. We assign the proxy instead as that 

# contains all overridden classes like Fraction during import anyway and 

# there is no need to keep the real override module alive. 

proxy._overrides_module = proxy 

 

override_all = [] 

if hasattr(override_mod, "__all__"): 

override_all = override_mod.__all__ 

 

for var in override_all: 

try: 

item = getattr(override_mod, var) 

except (AttributeError, TypeError): 

# Gedit puts a non-string in __all__, so catch TypeError here 

continue 

setattr(proxy, var, item) 

 

# Replace deprecated module level attributes with a descriptor 

# which emits a warning when accessed. 

for attr, replacement in _deprecated_attrs.pop(namespace, []): 

try: 

value = getattr(proxy, attr) 

except AttributeError: 

raise AssertionError( 

"%s was set deprecated but wasn't added to __all__" % attr) 

delattr(proxy, attr) 

deprecated_attr = _DeprecatedAttribute( 

namespace, attr, value, replacement) 

setattr(proxy_type, attr, deprecated_attr) 

 

return proxy 

 

 

def override(type_): 

"""Decorator for registering an override. 

 

Other than objects added to __all__, these can get referenced in the same 

override module via the gi.repository module (get_parent_for_object() does 

for example), so they have to be added to the module immediately. 

""" 

 

if isinstance(type_, CallableInfo): 

func = type_ 

namespace = func.__module__.rsplit('.', 1)[-1] 

module = sys.modules["gi.repository." + namespace] 

 

def wrapper(func): 

setattr(module, func.__name__, func) 

return func 

 

return wrapper 

elif isinstance(type_, types.FunctionType): 

raise TypeError("func must be a gi function, got %s" % type_) 

else: 

try: 

info = getattr(type_, '__info__') 

except AttributeError: 

raise TypeError( 

'Can not override a type %s, which is not in a gobject ' 

'introspection typelib' % type_.__name__) 

 

if not type_.__module__.startswith('gi.overrides'): 

raise KeyError( 

'You have tried override outside of the overrides module. ' 

'This is not allowed (%s, %s)' % (type_, type_.__module__)) 

 

g_type = info.get_g_type() 

assert g_type != TYPE_NONE 

if g_type != TYPE_INVALID: 

g_type.pytype = type_ 

 

namespace = type_.__module__.rsplit(".", 1)[-1] 

module = sys.modules["gi.repository." + namespace] 

setattr(module, type_.__name__, type_) 

 

return type_ 

 

 

overridefunc = override 

"""Deprecated""" 

 

 

def deprecated(fn, replacement): 

"""Decorator for marking methods and classes as deprecated""" 

@wraps(fn) 

def wrapped(*args, **kwargs): 

warnings.warn('%s is deprecated; use %s instead' % (fn.__name__, replacement), 

PyGIDeprecationWarning, stacklevel=2) 

return fn(*args, **kwargs) 

return wrapped 

 

 

def deprecated_attr(namespace, attr, replacement): 

"""Marks a module level attribute as deprecated. Accessing it will emit 

a PyGIDeprecationWarning warning. 

 

e.g. for ``deprecated_attr("GObject", "STATUS_FOO", "GLib.Status.FOO")`` 

accessing GObject.STATUS_FOO will emit: 

 

"GObject.STATUS_FOO is deprecated; use GLib.Status.FOO instead" 

 

:param str namespace: 

The namespace of the override this is called in. 

:param str namespace: 

The attribute name (which gets added to __all__). 

:param str replacement: 

The replacement text which will be included in the warning. 

""" 

 

_deprecated_attrs.setdefault(namespace, []).append((attr, replacement)) 

 

 

def deprecated_init(super_init_func, arg_names, ignore=tuple(), 

deprecated_aliases={}, deprecated_defaults={}, 

category=PyGIDeprecationWarning, 

stacklevel=2): 

"""Wrapper for deprecating GObject based __init__ methods which specify 

defaults already available or non-standard defaults. 

 

:param callable super_init_func: 

Initializer to wrap. 

:param list arg_names: 

Ordered argument name list. 

:param list ignore: 

List of argument names to ignore when calling the wrapped function. 

This is useful for function which take a non-standard keyword that is munged elsewhere. 

:param dict deprecated_aliases: 

Dictionary mapping a keyword alias to the actual g_object_newv keyword. 

:param dict deprecated_defaults: 

Dictionary of non-standard defaults that will be used when the 

keyword is not explicitly passed. 

:param Exception category: 

Exception category of the error. 

:param int stacklevel: 

Stack level for the deprecation passed on to warnings.warn 

:returns: Wrapped version of ``super_init_func`` which gives a deprecation 

warning when non-keyword args or aliases are used. 

:rtype: callable 

""" 

# We use a list of argument names to maintain order of the arguments 

# being deprecated. This allows calls with positional arguments to 

# continue working but with a deprecation message. 

def new_init(self, *args, **kwargs): 

"""Initializer for a GObject based classes with support for property 

sets through the use of explicit keyword arguments. 

""" 

# Print warnings for calls with positional arguments. 

if args: 

warnings.warn('Using positional arguments with the GObject constructor has been deprecated. ' 

'Please specify keyword(s) for "%s" or use a class specific constructor. ' 

'See: https://wiki.gnome.org/PyGObject/InitializerDeprecations' % 

', '.join(arg_names[:len(args)]), 

category, stacklevel=stacklevel) 

new_kwargs = dict(zip(arg_names, args)) 

else: 

new_kwargs = {} 

new_kwargs.update(kwargs) 

 

# Print warnings for alias usage and transfer them into the new key. 

aliases_used = [] 

for key, alias in deprecated_aliases.items(): 

if alias in new_kwargs: 

new_kwargs[key] = new_kwargs.pop(alias) 

aliases_used.append(key) 

 

if aliases_used: 

warnings.warn('The keyword(s) "%s" have been deprecated in favor of "%s" respectively. ' 

'See: https://wiki.gnome.org/PyGObject/InitializerDeprecations' % 

(', '.join(deprecated_aliases[k] for k in sorted(aliases_used)), 

', '.join(sorted(aliases_used))), 

category, stacklevel=stacklevel) 

 

# Print warnings for defaults different than what is already provided by the property 

defaults_used = [] 

for key, value in deprecated_defaults.items(): 

if key not in new_kwargs: 

new_kwargs[key] = deprecated_defaults[key] 

defaults_used.append(key) 

 

if defaults_used: 

warnings.warn('Initializer is relying on deprecated non-standard ' 

'defaults. Please update to explicitly use: %s ' 

'See: https://wiki.gnome.org/PyGObject/InitializerDeprecations' % 

', '.join('%s=%s' % (k, deprecated_defaults[k]) for k in sorted(defaults_used)), 

category, stacklevel=stacklevel) 

 

# Remove keywords that should be ignored. 

for key in ignore: 

if key in new_kwargs: 

new_kwargs.pop(key) 

 

return super_init_func(self, **new_kwargs) 

 

return new_init 

 

 

def strip_boolean_result(method, exc_type=None, exc_str=None, fail_ret=None): 

"""Translate method's return value for stripping off success flag. 

 

There are a lot of methods which return a "success" boolean and have 

several out arguments. Translate such a method to return the out arguments 

on success and None on failure. 

""" 

@wraps(method) 

def wrapped(*args, **kwargs): 

ret = method(*args, **kwargs) 

if ret[0]: 

if len(ret) == 2: 

return ret[1] 

else: 

return ret[1:] 

else: 

if exc_type: 

raise exc_type(exc_str or 'call failed') 

return fail_ret 

return wrapped