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

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

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

# -*- Mode: Python; py-indent-offset: 4 -*- 

# vim: tabstop=4 shiftwidth=4 expandtab 

# 

# Copyright (C) 2012 Canonical Ltd. 

# Author: Martin Pitt <martin.pitt@ubuntu.com> 

# Copyright (C) 2012-2013 Simon Feltman <sfeltman@src.gnome.org> 

# Copyright (C) 2012 Bastian Winkler <buz@netbuz.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 

 

import sys 

import warnings 

from collections import namedtuple 

 

import gi.overrides 

import gi.module 

from gi.overrides import override, deprecated_attr 

from gi.repository import GLib 

from gi import PyGIDeprecationWarning 

 

from gi import _propertyhelper as propertyhelper 

from gi import _signalhelper as signalhelper 

from gi import _gi 

 

 

GObjectModule = gi.module.get_introspection_module('GObject') 

 

__all__ = [] 

 

 

from gi import _option as option 

option = option 

 

 

# API aliases for backwards compatibility 

for name in ['markup_escape_text', 'get_application_name', 

'set_application_name', 'get_prgname', 'set_prgname', 

'main_depth', 'filename_display_basename', 

'filename_display_name', 'filename_from_utf8', 

'uri_list_extract_uris', 

'MainLoop', 'MainContext', 'main_context_default', 

'source_remove', 'Source', 'Idle', 'Timeout', 'PollFD', 

'idle_add', 'timeout_add', 'timeout_add_seconds', 

'io_add_watch', 'child_watch_add', 'get_current_time', 

'spawn_async']: 

globals()[name] = getattr(GLib, name) 

deprecated_attr("GObject", name, "GLib." + name) 

__all__.append(name) 

 

# deprecated constants 

for name in ['PRIORITY_DEFAULT', 'PRIORITY_DEFAULT_IDLE', 'PRIORITY_HIGH', 

'PRIORITY_HIGH_IDLE', 'PRIORITY_LOW', 

'IO_IN', 'IO_OUT', 'IO_PRI', 'IO_ERR', 'IO_HUP', 'IO_NVAL', 

'IO_STATUS_ERROR', 'IO_STATUS_NORMAL', 'IO_STATUS_EOF', 

'IO_STATUS_AGAIN', 'IO_FLAG_APPEND', 'IO_FLAG_NONBLOCK', 

'IO_FLAG_IS_READABLE', 'IO_FLAG_IS_WRITEABLE', 

'IO_FLAG_IS_SEEKABLE', 'IO_FLAG_MASK', 'IO_FLAG_GET_MASK', 

'IO_FLAG_SET_MASK', 

'SPAWN_LEAVE_DESCRIPTORS_OPEN', 'SPAWN_DO_NOT_REAP_CHILD', 

'SPAWN_SEARCH_PATH', 'SPAWN_STDOUT_TO_DEV_NULL', 

'SPAWN_STDERR_TO_DEV_NULL', 'SPAWN_CHILD_INHERITS_STDIN', 

'SPAWN_FILE_AND_ARGV_ZERO', 

'OPTION_FLAG_HIDDEN', 'OPTION_FLAG_IN_MAIN', 'OPTION_FLAG_REVERSE', 

'OPTION_FLAG_NO_ARG', 'OPTION_FLAG_FILENAME', 'OPTION_FLAG_OPTIONAL_ARG', 

'OPTION_FLAG_NOALIAS', 'OPTION_ERROR_UNKNOWN_OPTION', 

'OPTION_ERROR_BAD_VALUE', 'OPTION_ERROR_FAILED', 'OPTION_REMAINING', 

'glib_version']: 

with warnings.catch_warnings(): 

# TODO: this uses deprecated Glib attributes, silence for now 

warnings.simplefilter('ignore', PyGIDeprecationWarning) 

globals()[name] = getattr(GLib, name) 

deprecated_attr("GObject", name, "GLib." + name) 

__all__.append(name) 

 

 

for name in ['G_MININT8', 'G_MAXINT8', 'G_MAXUINT8', 'G_MININT16', 

'G_MAXINT16', 'G_MAXUINT16', 'G_MININT32', 'G_MAXINT32', 

'G_MAXUINT32', 'G_MININT64', 'G_MAXINT64', 'G_MAXUINT64']: 

new_name = name.split("_", 1)[-1] 

globals()[name] = getattr(GLib, new_name) 

deprecated_attr("GObject", name, "GLib." + new_name) 

__all__.append(name) 

 

# these are not currently exported in GLib gir, presumably because they are 

# platform dependent; so get them from our static bindings 

for name in ['G_MINFLOAT', 'G_MAXFLOAT', 'G_MINDOUBLE', 'G_MAXDOUBLE', 

'G_MINSHORT', 'G_MAXSHORT', 'G_MAXUSHORT', 'G_MININT', 'G_MAXINT', 

'G_MAXUINT', 'G_MINLONG', 'G_MAXLONG', 'G_MAXULONG', 'G_MAXSIZE', 

'G_MINSSIZE', 'G_MAXSSIZE', 'G_MINOFFSET', 'G_MAXOFFSET']: 

new_name = name.split("_", 1)[-1] 

globals()[name] = getattr(GLib, new_name) 

deprecated_attr("GObject", name, "GLib." + new_name) 

__all__.append(name) 

 

 

TYPE_INVALID = GObjectModule.type_from_name('invalid') 

TYPE_NONE = GObjectModule.type_from_name('void') 

TYPE_INTERFACE = GObjectModule.type_from_name('GInterface') 

TYPE_CHAR = GObjectModule.type_from_name('gchar') 

TYPE_UCHAR = GObjectModule.type_from_name('guchar') 

TYPE_BOOLEAN = GObjectModule.type_from_name('gboolean') 

TYPE_INT = GObjectModule.type_from_name('gint') 

TYPE_UINT = GObjectModule.type_from_name('guint') 

TYPE_LONG = GObjectModule.type_from_name('glong') 

TYPE_ULONG = GObjectModule.type_from_name('gulong') 

TYPE_INT64 = GObjectModule.type_from_name('gint64') 

TYPE_UINT64 = GObjectModule.type_from_name('guint64') 

TYPE_ENUM = GObjectModule.type_from_name('GEnum') 

TYPE_FLAGS = GObjectModule.type_from_name('GFlags') 

TYPE_FLOAT = GObjectModule.type_from_name('gfloat') 

TYPE_DOUBLE = GObjectModule.type_from_name('gdouble') 

TYPE_STRING = GObjectModule.type_from_name('gchararray') 

TYPE_POINTER = GObjectModule.type_from_name('gpointer') 

TYPE_BOXED = GObjectModule.type_from_name('GBoxed') 

TYPE_PARAM = GObjectModule.type_from_name('GParam') 

TYPE_OBJECT = GObjectModule.type_from_name('GObject') 

TYPE_PYOBJECT = GObjectModule.type_from_name('PyObject') 

TYPE_GTYPE = GObjectModule.type_from_name('GType') 

TYPE_STRV = GObjectModule.type_from_name('GStrv') 

TYPE_VARIANT = GObjectModule.type_from_name('GVariant') 

TYPE_GSTRING = GObjectModule.type_from_name('GString') 

TYPE_VALUE = GObjectModule.Value.__gtype__ 

TYPE_UNICHAR = TYPE_UINT 

__all__ += ['TYPE_INVALID', 'TYPE_NONE', 'TYPE_INTERFACE', 'TYPE_CHAR', 

'TYPE_UCHAR', 'TYPE_BOOLEAN', 'TYPE_INT', 'TYPE_UINT', 'TYPE_LONG', 

'TYPE_ULONG', 'TYPE_INT64', 'TYPE_UINT64', 'TYPE_ENUM', 'TYPE_FLAGS', 

'TYPE_FLOAT', 'TYPE_DOUBLE', 'TYPE_STRING', 'TYPE_POINTER', 

'TYPE_BOXED', 'TYPE_PARAM', 'TYPE_OBJECT', 'TYPE_PYOBJECT', 

'TYPE_GTYPE', 'TYPE_STRV', 'TYPE_VARIANT', 'TYPE_GSTRING', 

'TYPE_UNICHAR', 'TYPE_VALUE'] 

 

 

# Deprecated, use GLib directly 

for name in ['Pid', 'GError', 'OptionGroup', 'OptionContext']: 

globals()[name] = getattr(GLib, name) 

deprecated_attr("GObject", name, "GLib." + name) 

__all__.append(name) 

 

 

# Deprecated, use: GObject.ParamFlags.* directly 

for name in ['PARAM_CONSTRUCT', 'PARAM_CONSTRUCT_ONLY', 'PARAM_LAX_VALIDATION', 

'PARAM_READABLE', 'PARAM_WRITABLE']: 

new_name = name.split("_", 1)[-1] 

globals()[name] = getattr(GObjectModule.ParamFlags, new_name) 

deprecated_attr("GObject", name, "GObject.ParamFlags." + new_name) 

__all__.append(name) 

 

# PARAM_READWRITE should come from the gi module but cannot due to: 

# https://bugzilla.gnome.org/show_bug.cgi?id=687615 

PARAM_READWRITE = GObjectModule.ParamFlags.READABLE | \ 

GObjectModule.ParamFlags.WRITABLE 

__all__.append("PARAM_READWRITE") 

 

# READWRITE is part of ParamFlags since glib 2.42. Only mark PARAM_READWRITE as 

# deprecated in case ParamFlags.READWRITE is available. Also include the glib 

# version in the warning so it's clear that this needs a newer glib, unlike 

# the other ParamFlags related deprecations. 

# https://bugzilla.gnome.org/show_bug.cgi?id=726037 

if hasattr(GObjectModule.ParamFlags, "READWRITE"): 

deprecated_attr("GObject", "PARAM_READWRITE", 

"GObject.ParamFlags.READWRITE (glib 2.42+)") 

 

 

# Deprecated, use: GObject.SignalFlags.* directly 

for name in ['SIGNAL_ACTION', 'SIGNAL_DETAILED', 'SIGNAL_NO_HOOKS', 

'SIGNAL_NO_RECURSE', 'SIGNAL_RUN_CLEANUP', 'SIGNAL_RUN_FIRST', 

'SIGNAL_RUN_LAST']: 

new_name = name.split("_", 1)[-1] 

globals()[name] = getattr(GObjectModule.SignalFlags, new_name) 

deprecated_attr("GObject", name, "GObject.SignalFlags." + new_name) 

__all__.append(name) 

 

# Static types 

GBoxed = _gi.GBoxed 

GEnum = _gi.GEnum 

GFlags = _gi.GFlags 

GInterface = _gi.GInterface 

GObject = _gi.GObject 

GObjectWeakRef = _gi.GObjectWeakRef 

GParamSpec = _gi.GParamSpec 

GPointer = _gi.GPointer 

GType = _gi.GType 

Warning = _gi.Warning 

__all__ += ['GBoxed', 'GEnum', 'GFlags', 'GInterface', 'GObject', 

'GObjectWeakRef', 'GParamSpec', 'GPointer', 'GType', 

'Warning'] 

 

 

features = _gi.features 

list_properties = _gi.list_properties 

new = _gi.new 

pygobject_version = _gi.pygobject_version 

threads_init = GLib.threads_init 

type_register = _gi.type_register 

__all__ += ['features', 'list_properties', 'new', 

'pygobject_version', 'threads_init', 'type_register'] 

 

 

class Value(GObjectModule.Value): 

def __init__(self, value_type=None, py_value=None): 

GObjectModule.Value.__init__(self) 

if value_type is not None: 

self.init(value_type) 

if py_value is not None: 

self.set_value(py_value) 

 

def __del__(self): 

if self._free_on_dealloc and self.g_type != TYPE_INVALID: 

self.unset() 

 

# We must call base class __del__() after unset. 

super(Value, self).__del__() 

 

def set_boxed(self, boxed): 

# Workaround the introspection marshalers inability to know 

# these methods should be marshaling boxed types. This is because 

# the type information is stored on the GValue. 

_gi._gvalue_set(self, boxed) 

 

def get_boxed(self): 

return _gi._gvalue_get(self) 

 

def set_value(self, py_value): 

gtype = self.g_type 

 

if gtype == _gi.TYPE_INVALID: 

raise TypeError("GObject.Value needs to be initialized first") 

elif gtype == TYPE_BOOLEAN: 

self.set_boolean(py_value) 

elif gtype == TYPE_CHAR: 

self.set_char(py_value) 

elif gtype == TYPE_UCHAR: 

self.set_uchar(py_value) 

elif gtype == TYPE_INT: 

self.set_int(py_value) 

elif gtype == TYPE_UINT: 

self.set_uint(py_value) 

elif gtype == TYPE_LONG: 

self.set_long(py_value) 

elif gtype == TYPE_ULONG: 

self.set_ulong(py_value) 

elif gtype == TYPE_INT64: 

self.set_int64(py_value) 

elif gtype == TYPE_UINT64: 

self.set_uint64(py_value) 

elif gtype == TYPE_FLOAT: 

self.set_float(py_value) 

elif gtype == TYPE_DOUBLE: 

self.set_double(py_value) 

elif gtype == TYPE_STRING: 

if isinstance(py_value, str): 

py_value = str(py_value) 

elif sys.version_info < (3, 0): 

if isinstance(py_value, unicode): 

py_value = py_value.encode('UTF-8') 

else: 

raise ValueError("Expected string or unicode but got %s%s" % 

(py_value, type(py_value))) 

else: 

raise ValueError("Expected string but got %s%s" % 

(py_value, type(py_value))) 

self.set_string(py_value) 

elif gtype == TYPE_PARAM: 

self.set_param(py_value) 

elif gtype.is_a(TYPE_ENUM): 

self.set_enum(py_value) 

elif gtype.is_a(TYPE_FLAGS): 

self.set_flags(py_value) 

elif gtype.is_a(TYPE_BOXED): 

self.set_boxed(py_value) 

elif gtype == TYPE_POINTER: 

self.set_pointer(py_value) 

elif gtype.is_a(TYPE_OBJECT): 

self.set_object(py_value) 

elif gtype == TYPE_UNICHAR: 

self.set_uint(int(py_value)) 

# elif gtype == TYPE_OVERRIDE: 

# pass 

elif gtype == TYPE_GTYPE: 

self.set_gtype(py_value) 

elif gtype == TYPE_VARIANT: 

self.set_variant(py_value) 

elif gtype == TYPE_PYOBJECT: 

self.set_boxed(py_value) 

else: 

raise TypeError("Unknown value type %s" % gtype) 

 

def get_value(self): 

gtype = self.g_type 

 

if gtype == TYPE_BOOLEAN: 

return self.get_boolean() 

elif gtype == TYPE_CHAR: 

return self.get_char() 

elif gtype == TYPE_UCHAR: 

return self.get_uchar() 

elif gtype == TYPE_INT: 

return self.get_int() 

elif gtype == TYPE_UINT: 

return self.get_uint() 

elif gtype == TYPE_LONG: 

return self.get_long() 

elif gtype == TYPE_ULONG: 

return self.get_ulong() 

elif gtype == TYPE_INT64: 

return self.get_int64() 

elif gtype == TYPE_UINT64: 

return self.get_uint64() 

elif gtype == TYPE_FLOAT: 

return self.get_float() 

elif gtype == TYPE_DOUBLE: 

return self.get_double() 

elif gtype == TYPE_STRING: 

return self.get_string() 

elif gtype == TYPE_PARAM: 

return self.get_param() 

elif gtype.is_a(TYPE_ENUM): 

return self.get_enum() 

elif gtype.is_a(TYPE_FLAGS): 

return self.get_flags() 

elif gtype.is_a(TYPE_BOXED): 

return self.get_boxed() 

elif gtype == TYPE_POINTER: 

return self.get_pointer() 

elif gtype.is_a(TYPE_OBJECT): 

return self.get_object() 

elif gtype == TYPE_UNICHAR: 

return self.get_uint() 

elif gtype == TYPE_GTYPE: 

return self.get_gtype() 

elif gtype == TYPE_VARIANT: 

return self.get_variant() 

elif gtype == TYPE_PYOBJECT: 

pass 

else: 

return None 

 

def __repr__(self): 

return '<Value (%s) %s>' % (self.g_type.name, self.get_value()) 

 

 

Value = override(Value) 

__all__.append('Value') 

 

 

def type_from_name(name): 

type_ = GObjectModule.type_from_name(name) 

if type_ == TYPE_INVALID: 

raise RuntimeError('unknown type name: %s' % name) 

return type_ 

 

 

__all__.append('type_from_name') 

 

 

def type_parent(type_): 

parent = GObjectModule.type_parent(type_) 

if parent == TYPE_INVALID: 

raise RuntimeError('no parent for type') 

return parent 

 

 

__all__.append('type_parent') 

 

 

def _validate_type_for_signal_method(type_): 

if hasattr(type_, '__gtype__'): 

type_ = type_.__gtype__ 

if not type_.is_instantiatable() and not type_.is_interface(): 

raise TypeError('type must be instantiable or an interface, got %s' % type_) 

 

 

def signal_list_ids(type_): 

_validate_type_for_signal_method(type_) 

return GObjectModule.signal_list_ids(type_) 

 

 

__all__.append('signal_list_ids') 

 

 

def signal_list_names(type_): 

ids = signal_list_ids(type_) 

return tuple(GObjectModule.signal_name(i) for i in ids) 

 

 

__all__.append('signal_list_names') 

 

 

def signal_lookup(name, type_): 

_validate_type_for_signal_method(type_) 

return GObjectModule.signal_lookup(name, type_) 

 

 

__all__.append('signal_lookup') 

 

 

SignalQuery = namedtuple('SignalQuery', 

['signal_id', 

'signal_name', 

'itype', 

'signal_flags', 

'return_type', 

# n_params', 

'param_types']) 

 

 

def signal_query(id_or_name, type_=None): 

if type_ is not None: 

id_or_name = signal_lookup(id_or_name, type_) 

 

res = GObjectModule.signal_query(id_or_name) 

if res is None: 

return None 

 

if res.signal_id == 0: 

return None 

 

# Return a named tuple to allows indexing which is compatible with the 

# static bindings along with field like access of the gi struct. 

# Note however that the n_params was not returned from the static bindings 

# so we must skip over it. 

return SignalQuery(res.signal_id, res.signal_name, res.itype, 

res.signal_flags, res.return_type, 

tuple(res.param_types)) 

 

 

__all__.append('signal_query') 

 

 

class _HandlerBlockManager(object): 

def __init__(self, obj, handler_id): 

self.obj = obj 

self.handler_id = handler_id 

 

def __enter__(self): 

pass 

 

def __exit__(self, exc_type, exc_value, traceback): 

GObjectModule.signal_handler_unblock(self.obj, self.handler_id) 

 

 

def signal_handler_block(obj, handler_id): 

"""Blocks the signal handler from being invoked until 

handler_unblock() is called. 

 

:param GObject.Object obj: 

Object instance to block handlers for. 

:param int handler_id: 

Id of signal to block. 

:returns: 

A context manager which optionally can be used to 

automatically unblock the handler: 

 

.. code-block:: python 

 

with GObject.signal_handler_block(obj, id): 

pass 

""" 

GObjectModule.signal_handler_block(obj, handler_id) 

return _HandlerBlockManager(obj, handler_id) 

 

 

__all__.append('signal_handler_block') 

 

 

def signal_parse_name(detailed_signal, itype, force_detail_quark): 

"""Parse a detailed signal name into (signal_id, detail). 

 

:param str detailed_signal: 

Signal name which can include detail. 

For example: "notify:prop_name" 

:returns: 

Tuple of (signal_id, detail) 

:raises ValueError: 

If the given signal is unknown. 

""" 

res, signal_id, detail = GObjectModule.signal_parse_name(detailed_signal, itype, 

force_detail_quark) 

if res: 

return signal_id, detail 

else: 

raise ValueError('%s: unknown signal name: %s' % (itype, detailed_signal)) 

 

 

__all__.append('signal_parse_name') 

 

 

def remove_emission_hook(obj, detailed_signal, hook_id): 

signal_id, detail = signal_parse_name(detailed_signal, obj, True) 

GObjectModule.signal_remove_emission_hook(signal_id, hook_id) 

 

 

__all__.append('remove_emission_hook') 

 

 

# GObject accumulators with pure Python implementations 

# These return a tuple of (continue_emission, accumulation_result) 

 

def signal_accumulator_first_wins(ihint, return_accu, handler_return, user_data=None): 

# Stop emission but return the result of the last handler 

return (False, handler_return) 

 

 

__all__.append('signal_accumulator_first_wins') 

 

 

def signal_accumulator_true_handled(ihint, return_accu, handler_return, user_data=None): 

# Stop emission if the last handler returns True 

return (not handler_return, handler_return) 

 

 

__all__.append('signal_accumulator_true_handled') 

 

 

# Statically bound signal functions which need to clobber GI (for now) 

 

add_emission_hook = _gi.add_emission_hook 

signal_new = _gi.signal_new 

 

__all__ += ['add_emission_hook', 'signal_new'] 

 

 

class _FreezeNotifyManager(object): 

def __init__(self, obj): 

self.obj = obj 

 

def __enter__(self): 

pass 

 

def __exit__(self, exc_type, exc_value, traceback): 

self.obj.thaw_notify() 

 

 

def _signalmethod(func): 

# Function wrapper for signal functions used as instance methods. 

# This is needed when the signal functions come directly from GI. 

# (they are not already wrapped) 

@gi.overrides.wraps(func) 

def meth(*args, **kwargs): 

return func(*args, **kwargs) 

return meth 

 

 

class Object(GObjectModule.Object): 

def _unsupported_method(self, *args, **kargs): 

raise RuntimeError('This method is currently unsupported.') 

 

def _unsupported_data_method(self, *args, **kargs): 

raise RuntimeError('Data access methods are unsupported. ' 

'Use normal Python attributes instead') 

 

# Generic data methods are not needed in python as it can be handled 

# with standard attribute access: https://bugzilla.gnome.org/show_bug.cgi?id=641944 

get_data = _unsupported_data_method 

get_qdata = _unsupported_data_method 

set_data = _unsupported_data_method 

steal_data = _unsupported_data_method 

steal_qdata = _unsupported_data_method 

replace_data = _unsupported_data_method 

replace_qdata = _unsupported_data_method 

 

# The following methods as unsupported until we verify 

# they work as gi methods. 

bind_property_full = _unsupported_method 

compat_control = _unsupported_method 

interface_find_property = _unsupported_method 

interface_install_property = _unsupported_method 

interface_list_properties = _unsupported_method 

notify_by_pspec = _unsupported_method 

run_dispose = _unsupported_method 

watch_closure = _unsupported_method 

 

# Make all reference management methods private but still accessible. 

_ref = GObjectModule.Object.ref 

_ref_sink = GObjectModule.Object.ref_sink 

_unref = GObjectModule.Object.unref 

_force_floating = GObjectModule.Object.force_floating 

 

ref = _unsupported_method 

ref_sink = _unsupported_method 

unref = _unsupported_method 

force_floating = _unsupported_method 

 

# The following methods are static APIs which need to leap frog the 

# gi methods until we verify the gi methods can replace them. 

get_property = _gi.GObject.get_property 

get_properties = _gi.GObject.get_properties 

set_property = _gi.GObject.set_property 

set_properties = _gi.GObject.set_properties 

bind_property = _gi.GObject.bind_property 

connect = _gi.GObject.connect 

connect_after = _gi.GObject.connect_after 

connect_object = _gi.GObject.connect_object 

connect_object_after = _gi.GObject.connect_object_after 

disconnect_by_func = _gi.GObject.disconnect_by_func 

handler_block_by_func = _gi.GObject.handler_block_by_func 

handler_unblock_by_func = _gi.GObject.handler_unblock_by_func 

emit = _gi.GObject.emit 

chain = _gi.GObject.chain 

weak_ref = _gi.GObject.weak_ref 

__copy__ = _gi.GObject.__copy__ 

__deepcopy__ = _gi.GObject.__deepcopy__ 

 

def freeze_notify(self): 

"""Freezes the object's property-changed notification queue. 

 

:returns: 

A context manager which optionally can be used to 

automatically thaw notifications. 

 

This will freeze the object so that "notify" signals are blocked until 

the thaw_notify() method is called. 

 

.. code-block:: python 

 

with obj.freeze_notify(): 

pass 

""" 

super(Object, self).freeze_notify() 

return _FreezeNotifyManager(self) 

 

def connect_data(self, detailed_signal, handler, *data, **kwargs): 

"""Connect a callback to the given signal with optional user data. 

 

:param str detailed_signal: 

A detailed signal to connect to. 

:param callable handler: 

Callback handler to connect to the signal. 

:param *data: 

Variable data which is passed through to the signal handler. 

:param GObject.ConnectFlags connect_flags: 

Flags used for connection options. 

:returns: 

A signal id which can be used with disconnect. 

""" 

flags = kwargs.get('connect_flags', 0) 

if flags & GObjectModule.ConnectFlags.AFTER: 

connect_func = _gi.GObject.connect_after 

else: 

connect_func = _gi.GObject.connect 

 

if flags & GObjectModule.ConnectFlags.SWAPPED: 

if len(data) != 1: 

raise ValueError('Using GObject.ConnectFlags.SWAPPED requires exactly ' 

'one argument for user data, got: %s' % [data]) 

 

def new_handler(obj, *args): 

# Swap obj with the last element in args which will be the user 

# data passed to the connect function. 

args = list(args) 

swap = args.pop() 

args = args + [obj] 

return handler(swap, *args) 

else: 

new_handler = handler 

 

return connect_func(self, detailed_signal, new_handler, *data) 

 

# 

# Aliases 

# 

 

handler_block = signal_handler_block 

handler_unblock = _signalmethod(GObjectModule.signal_handler_unblock) 

disconnect = _signalmethod(GObjectModule.signal_handler_disconnect) 

handler_disconnect = _signalmethod(GObjectModule.signal_handler_disconnect) 

handler_is_connected = _signalmethod(GObjectModule.signal_handler_is_connected) 

stop_emission_by_name = _signalmethod(GObjectModule.signal_stop_emission_by_name) 

 

# 

# Deprecated Methods 

# 

 

def stop_emission(self, detailed_signal): 

"""Deprecated, please use stop_emission_by_name.""" 

warnings.warn(self.stop_emission.__doc__, PyGIDeprecationWarning, stacklevel=2) 

return self.stop_emission_by_name(detailed_signal) 

 

emit_stop_by_name = stop_emission 

 

 

Object = override(Object) 

GObject = Object 

__all__ += ['Object', 'GObject'] 

 

 

class Binding(GObjectModule.Binding): 

def __call__(self): 

warnings.warn('Using parentheses (binding()) to retrieve the Binding object is no ' 

'longer needed because the binding is returned directly from "bind_property.', 

PyGIDeprecationWarning, stacklevel=2) 

return self 

 

def unbind(self): 

if hasattr(self, '_unbound'): 

raise ValueError('binding has already been cleared out') 

else: 

setattr(self, '_unbound', True) 

super(Binding, self).unbind() 

 

 

Binding = override(Binding) 

__all__.append('Binding') 

 

 

Property = propertyhelper.Property 

Signal = signalhelper.Signal 

SignalOverride = signalhelper.SignalOverride 

# Deprecated naming "property" available for backwards compatibility. 

# Keep this at the end of the file to avoid clobbering the builtin. 

property = Property 

deprecated_attr("GObject", "property", "GObject.Property") 

__all__ += ['Property', 'Signal', 'SignalOverride', 'property']