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

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

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

# vim: tabstop=4 shiftwidth=4 expandtab 

# 

# Copyright (C) 2010 Tomeu Vizoso <tomeu.vizoso@collabora.co.uk> 

# Copyright (C) 2011, 2012 Canonical Ltd. 

# 

# 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 warnings 

import sys 

import socket 

 

from .._ossighelper import wakeup_on_signal, register_sigint_fallback 

from ..module import get_introspection_module 

from .._gi import (variant_type_from_string, source_new, 

source_set_callback, io_channel_read) 

from ..overrides import override, deprecated, deprecated_attr 

from gi import PyGIDeprecationWarning, version_info 

 

GLib = get_introspection_module('GLib') 

 

__all__ = [] 

 

from gi import _option as option 

option # pyflakes 

__all__.append('option') 

 

 

# Types and functions still needed from static bindings 

from gi import _gi 

from gi._error import GError 

 

Error = GError 

OptionContext = _gi.OptionContext 

OptionGroup = _gi.OptionGroup 

Pid = _gi.Pid 

spawn_async = _gi.spawn_async 

 

 

def threads_init(): 

warnings.warn('Since version 3.11, calling threads_init is no longer needed. ' 

'See: https://wiki.gnome.org/PyGObject/Threading', 

PyGIDeprecationWarning, stacklevel=2) 

 

 

def gerror_matches(self, domain, code): 

# Handle cases where self.domain was set to an integer for compatibility 

# with the introspected GLib.Error. 

if isinstance(self.domain, str): 

self_domain_quark = GLib.quark_from_string(self.domain) 

else: 

self_domain_quark = self.domain 

return (self_domain_quark, self.code) == (domain, code) 

 

 

def gerror_new_literal(domain, message, code): 

domain_quark = GLib.quark_to_string(domain) 

return GError(message, domain_quark, code) 

 

 

# Monkey patch methods that rely on GLib introspection to be loaded at runtime. 

Error.__name__ = 'Error' 

Error.__module__ = 'GLib' 

Error.__gtype__ = GLib.Error.__gtype__ 

Error.matches = gerror_matches 

Error.new_literal = staticmethod(gerror_new_literal) 

 

 

__all__ += ['GError', 'Error', 'OptionContext', 'OptionGroup', 'Pid', 

'spawn_async', 'threads_init'] 

 

 

class _VariantCreator(object): 

 

_LEAF_CONSTRUCTORS = { 

'b': GLib.Variant.new_boolean, 

'y': GLib.Variant.new_byte, 

'n': GLib.Variant.new_int16, 

'q': GLib.Variant.new_uint16, 

'i': GLib.Variant.new_int32, 

'u': GLib.Variant.new_uint32, 

'x': GLib.Variant.new_int64, 

't': GLib.Variant.new_uint64, 

'h': GLib.Variant.new_handle, 

'd': GLib.Variant.new_double, 

's': GLib.Variant.new_string, 

'o': GLib.Variant.new_object_path, 

'g': GLib.Variant.new_signature, 

'v': GLib.Variant.new_variant, 

} 

 

def _create(self, format, value): 

"""Create a GVariant object from given format and a value that matches 

the format. 

 

This method recursively calls itself for complex structures (arrays, 

dictionaries, boxed). 

 

Returns the generated GVariant. 

 

If value is None it will generate an empty GVariant container type. 

""" 

gvtype = GLib.VariantType(format) 

if format in self._LEAF_CONSTRUCTORS: 

return self._LEAF_CONSTRUCTORS[format](value) 

 

# Since we discarded all leaf types, this must be a container 

builder = GLib.VariantBuilder.new(gvtype) 

if value is None: 

return builder.end() 

 

if gvtype.is_maybe(): 

builder.add_value(self._create(gvtype.element().dup_string(), value)) 

return builder.end() 

 

try: 

iter(value) 

except TypeError: 

raise TypeError("Could not create array, tuple or dictionary entry from non iterable value %s %s" % 

(format, value)) 

 

if gvtype.is_tuple() and gvtype.n_items() != len(value): 

raise TypeError("Tuple mismatches value's number of elements %s %s" % (format, value)) 

if gvtype.is_dict_entry() and len(value) != 2: 

raise TypeError("Dictionary entries must have two elements %s %s" % (format, value)) 

 

if gvtype.is_array(): 

element_type = gvtype.element().dup_string() 

if isinstance(value, dict): 

value = value.items() 

for i in value: 

builder.add_value(self._create(element_type, i)) 

else: 

remainer_format = format[1:] 

for i in value: 

dup = variant_type_from_string(remainer_format).dup_string() 

builder.add_value(self._create(dup, i)) 

remainer_format = remainer_format[len(dup):] 

 

return builder.end() 

 

 

class Variant(GLib.Variant): 

def __new__(cls, format_string, value): 

"""Create a GVariant from a native Python object. 

 

format_string is a standard GVariant type signature, value is a Python 

object whose structure has to match the signature. 

 

Examples: 

GLib.Variant('i', 1) 

GLib.Variant('(is)', (1, 'hello')) 

GLib.Variant('(asa{sv})', ([], {'foo': GLib.Variant('b', True), 

'bar': GLib.Variant('i', 2)})) 

""" 

if not GLib.VariantType.string_is_valid(format_string): 

raise TypeError("Invalid GVariant format string '%s'", format_string) 

creator = _VariantCreator() 

v = creator._create(format_string, value) 

v.format_string = format_string 

return v 

 

@staticmethod 

def new_tuple(*elements): 

return GLib.Variant.new_tuple(elements) 

 

def __del__(self): 

try: 

self.unref() 

except ImportError: 

# Calling unref will cause gi and gi.repository.GLib to be 

# imported. However, if the program is exiting, then these 

# modules have likely been removed from sys.modules and will 

# raise an exception. Assume that's the case for ImportError 

# and ignore the exception since everything will be cleaned 

# up, anyways. 

pass 

 

def __str__(self): 

return self.print_(True) 

 

def __repr__(self): 

if hasattr(self, 'format_string'): 

f = self.format_string 

else: 

f = self.get_type_string() 

return "GLib.Variant('%s', %s)" % (f, self.print_(False)) 

 

def __eq__(self, other): 

try: 

return self.equal(other) 

except TypeError: 

return False 

 

def __ne__(self, other): 

try: 

return not self.equal(other) 

except TypeError: 

return True 

 

def __hash__(self): 

# We're not using just hash(self.unpack()) because otherwise we'll have 

# hash collisions between the same content in different variant types, 

# which will cause a performance issue in set/dict/etc. 

return hash((self.get_type_string(), self.unpack())) 

 

def unpack(self): 

"""Decompose a GVariant into a native Python object.""" 

 

LEAF_ACCESSORS = { 

'b': self.get_boolean, 

'y': self.get_byte, 

'n': self.get_int16, 

'q': self.get_uint16, 

'i': self.get_int32, 

'u': self.get_uint32, 

'x': self.get_int64, 

't': self.get_uint64, 

'h': self.get_handle, 

'd': self.get_double, 

's': self.get_string, 

'o': self.get_string, # object path 

'g': self.get_string, # signature 

} 

 

# simple values 

la = LEAF_ACCESSORS.get(self.get_type_string()) 

if la: 

return la() 

 

# tuple 

if self.get_type_string().startswith('('): 

res = [self.get_child_value(i).unpack() 

for i in range(self.n_children())] 

return tuple(res) 

 

# dictionary 

if self.get_type_string().startswith('a{'): 

res = {} 

for i in range(self.n_children()): 

v = self.get_child_value(i) 

res[v.get_child_value(0).unpack()] = v.get_child_value(1).unpack() 

return res 

 

# array 

if self.get_type_string().startswith('a'): 

return [self.get_child_value(i).unpack() 

for i in range(self.n_children())] 

 

# variant (just unbox transparently) 

if self.get_type_string().startswith('v'): 

return self.get_variant().unpack() 

 

# maybe 

if self.get_type_string().startswith('m'): 

if not self.n_children(): 

return None 

return self.get_child_value(0).unpack() 

 

raise NotImplementedError('unsupported GVariant type ' + self.get_type_string()) 

 

@classmethod 

def split_signature(klass, signature): 

"""Return a list of the element signatures of the topmost signature tuple. 

 

If the signature is not a tuple, it returns one element with the entire 

signature. If the signature is an empty tuple, the result is []. 

 

This is useful for e. g. iterating over method parameters which are 

passed as a single Variant. 

""" 

if signature == '()': 

return [] 

 

if not signature.startswith('('): 

return [signature] 

 

result = [] 

head = '' 

tail = signature[1:-1] # eat the surrounding () 

while tail: 

c = tail[0] 

head += c 

tail = tail[1:] 

 

if c in ('m', 'a'): 

# prefixes, keep collecting 

continue 

if c in ('(', '{'): 

# consume until corresponding )/} 

level = 1 

up = c 

if up == '(': 

down = ')' 

else: 

down = '}' 

while level > 0: 

c = tail[0] 

head += c 

tail = tail[1:] 

if c == up: 

level += 1 

elif c == down: 

level -= 1 

 

# otherwise we have a simple type 

result.append(head) 

head = '' 

 

return result 

 

# 

# Pythonic iterators 

# 

 

def __len__(self): 

if self.get_type_string() in ['s', 'o', 'g']: 

return len(self.get_string()) 

# Array, dict, tuple 

if self.get_type_string().startswith('a') or self.get_type_string().startswith('('): 

return self.n_children() 

raise TypeError('GVariant type %s does not have a length' % self.get_type_string()) 

 

def __getitem__(self, key): 

# dict 

if self.get_type_string().startswith('a{'): 

try: 

val = self.lookup_value(key, variant_type_from_string('*')) 

if val is None: 

raise KeyError(key) 

return val.unpack() 

except TypeError: 

# lookup_value() only works for string keys, which is certainly 

# the common case; we have to do painful iteration for other 

# key types 

for i in range(self.n_children()): 

v = self.get_child_value(i) 

if v.get_child_value(0).unpack() == key: 

return v.get_child_value(1).unpack() 

raise KeyError(key) 

 

# array/tuple 

if self.get_type_string().startswith('a') or self.get_type_string().startswith('('): 

key = int(key) 

if key < 0: 

key = self.n_children() + key 

if key < 0 or key >= self.n_children(): 

raise IndexError('list index out of range') 

return self.get_child_value(key).unpack() 

 

# string 

if self.get_type_string() in ['s', 'o', 'g']: 

return self.get_string().__getitem__(key) 

 

raise TypeError('GVariant type %s is not a container' % self.get_type_string()) 

 

# 

# Pythonic bool operations 

# 

 

def __nonzero__(self): 

return self.__bool__() 

 

def __bool__(self): 

if self.get_type_string() in ['y', 'n', 'q', 'i', 'u', 'x', 't', 'h', 'd']: 

return self.unpack() != 0 

if self.get_type_string() in ['b']: 

return self.get_boolean() 

if self.get_type_string() in ['s', 'o', 'g']: 

return len(self.get_string()) != 0 

# Array, dict, tuple 

if self.get_type_string().startswith('a') or self.get_type_string().startswith('('): 

return self.n_children() != 0 

if self.get_type_string() in ['v']: 

# unpack works recursively, hence bool also works recursively 

return bool(self.unpack()) 

# Everything else is True 

return True 

 

def keys(self): 

if not self.get_type_string().startswith('a{'): 

return TypeError, 'GVariant type %s is not a dictionary' % self.get_type_string() 

 

res = [] 

for i in range(self.n_children()): 

v = self.get_child_value(i) 

res.append(v.get_child_value(0).unpack()) 

return res 

 

 

def get_string(self): 

value, length = GLib.Variant.get_string(self) 

return value 

 

 

setattr(Variant, 'get_string', get_string) 

 

__all__.append('Variant') 

 

 

def markup_escape_text(text, length=-1): 

if isinstance(text, bytes): 

return GLib.markup_escape_text(text.decode('UTF-8'), length) 

else: 

return GLib.markup_escape_text(text, length) 

 

 

__all__.append('markup_escape_text') 

 

 

# backwards compatible names from old static bindings 

for n in ['DESKTOP', 'DOCUMENTS', 'DOWNLOAD', 'MUSIC', 'PICTURES', 

'PUBLIC_SHARE', 'TEMPLATES', 'VIDEOS']: 

attr = 'USER_DIRECTORY_' + n 

deprecated_attr("GLib", attr, "GLib.UserDirectory.DIRECTORY_" + n) 

globals()[attr] = getattr(GLib.UserDirectory, 'DIRECTORY_' + n) 

__all__.append(attr) 

 

for n in ['ERR', 'HUP', 'IN', 'NVAL', 'OUT', 'PRI']: 

globals()['IO_' + n] = getattr(GLib.IOCondition, n) 

__all__.append('IO_' + n) 

 

for n in ['APPEND', 'GET_MASK', 'IS_READABLE', 'IS_SEEKABLE', 

'MASK', 'NONBLOCK', 'SET_MASK']: 

attr = 'IO_FLAG_' + n 

deprecated_attr("GLib", attr, "GLib.IOFlags." + n) 

globals()[attr] = getattr(GLib.IOFlags, n) 

__all__.append(attr) 

 

# spelling for the win 

IO_FLAG_IS_WRITEABLE = GLib.IOFlags.IS_WRITABLE 

deprecated_attr("GLib", "IO_FLAG_IS_WRITEABLE", "GLib.IOFlags.IS_WRITABLE") 

__all__.append('IO_FLAG_IS_WRITEABLE') 

 

for n in ['AGAIN', 'EOF', 'ERROR', 'NORMAL']: 

attr = 'IO_STATUS_' + n 

globals()[attr] = getattr(GLib.IOStatus, n) 

deprecated_attr("GLib", attr, "GLib.IOStatus." + n) 

__all__.append(attr) 

 

for n in ['CHILD_INHERITS_STDIN', 'DO_NOT_REAP_CHILD', 'FILE_AND_ARGV_ZERO', 

'LEAVE_DESCRIPTORS_OPEN', 'SEARCH_PATH', 'STDERR_TO_DEV_NULL', 

'STDOUT_TO_DEV_NULL']: 

attr = 'SPAWN_' + n 

globals()[attr] = getattr(GLib.SpawnFlags, n) 

deprecated_attr("GLib", attr, "GLib.SpawnFlags." + n) 

__all__.append(attr) 

 

for n in ['HIDDEN', 'IN_MAIN', 'REVERSE', 'NO_ARG', 'FILENAME', 'OPTIONAL_ARG', 

'NOALIAS']: 

attr = 'OPTION_FLAG_' + n 

globals()[attr] = getattr(GLib.OptionFlags, n) 

deprecated_attr("GLib", attr, "GLib.OptionFlags." + n) 

__all__.append(attr) 

 

for n in ['UNKNOWN_OPTION', 'BAD_VALUE', 'FAILED']: 

attr = 'OPTION_ERROR_' + n 

deprecated_attr("GLib", attr, "GLib.OptionError." + n) 

globals()[attr] = getattr(GLib.OptionError, n) 

__all__.append(attr) 

 

 

# 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']: 

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

globals()[attr] = getattr(_gi, name) 

__all__.append(attr) 

 

 

class MainLoop(GLib.MainLoop): 

# Backwards compatible constructor API 

def __new__(cls, context=None): 

return GLib.MainLoop.new(context, False) 

 

def __init__(self, context=None): 

pass 

 

def run(self): 

with register_sigint_fallback(self.quit): 

with wakeup_on_signal(): 

super(MainLoop, self).run() 

 

 

MainLoop = override(MainLoop) 

__all__.append('MainLoop') 

 

 

class MainContext(GLib.MainContext): 

# Backwards compatible API with default value 

def iteration(self, may_block=True): 

return super(MainContext, self).iteration(may_block) 

 

 

MainContext = override(MainContext) 

__all__.append('MainContext') 

 

 

class Source(GLib.Source): 

def __new__(cls, *args, **kwargs): 

# use our custom pyg_source_new() here as g_source_new() is not 

# bindable 

source = source_new() 

source.__class__ = cls 

setattr(source, '__pygi_custom_source', True) 

return source 

 

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

return super(Source, self).__init__() 

 

def __del__(self): 

if hasattr(self, '__pygi_custom_source'): 

self.unref() 

 

def set_callback(self, fn, user_data=None): 

if hasattr(self, '__pygi_custom_source'): 

# use our custom pyg_source_set_callback() if for a GSource object 

# with custom functions 

source_set_callback(self, fn, user_data) 

else: 

# otherwise, for Idle and Timeout, use the standard method 

super(Source, self).set_callback(fn, user_data) 

 

def get_current_time(self): 

return GLib.get_real_time() * 0.000001 

 

get_current_time = deprecated(get_current_time, 

'GLib.Source.get_time() or GLib.get_real_time()') 

 

# as get/set_priority are introspected, we can't use the static 

# property(get_priority, ..) here 

def __get_priority(self): 

return self.get_priority() 

 

def __set_priority(self, value): 

self.set_priority(value) 

 

priority = property(__get_priority, __set_priority) 

 

def __get_can_recurse(self): 

return self.get_can_recurse() 

 

def __set_can_recurse(self, value): 

self.set_can_recurse(value) 

 

can_recurse = property(__get_can_recurse, __set_can_recurse) 

 

 

Source = override(Source) 

__all__.append('Source') 

 

 

class Idle(Source): 

def __new__(cls, priority=GLib.PRIORITY_DEFAULT): 

source = GLib.idle_source_new() 

source.__class__ = cls 

return source 

 

def __init__(self, priority=GLib.PRIORITY_DEFAULT): 

super(Source, self).__init__() 

if priority != GLib.PRIORITY_DEFAULT: 

self.set_priority(priority) 

 

 

__all__.append('Idle') 

 

 

class Timeout(Source): 

def __new__(cls, interval=0, priority=GLib.PRIORITY_DEFAULT): 

source = GLib.timeout_source_new(interval) 

source.__class__ = cls 

return source 

 

def __init__(self, interval=0, priority=GLib.PRIORITY_DEFAULT): 

if priority != GLib.PRIORITY_DEFAULT: 

self.set_priority(priority) 

 

 

__all__.append('Timeout') 

 

 

# backwards compatible API 

def idle_add(function, *user_data, **kwargs): 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT_IDLE) 

return GLib.idle_add(priority, function, *user_data) 

 

 

__all__.append('idle_add') 

 

 

def timeout_add(interval, function, *user_data, **kwargs): 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT) 

return GLib.timeout_add(priority, interval, function, *user_data) 

 

 

__all__.append('timeout_add') 

 

 

def timeout_add_seconds(interval, function, *user_data, **kwargs): 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT) 

return GLib.timeout_add_seconds(priority, interval, function, *user_data) 

 

 

__all__.append('timeout_add_seconds') 

 

 

# The GI GLib API uses g_io_add_watch_full renamed to g_io_add_watch with 

# a signature of (channel, priority, condition, func, user_data). 

# Prior to PyGObject 3.8, this function was statically bound with an API closer to the 

# non-full version with a signature of: (fd, condition, func, *user_data) 

# We need to support this until we are okay with breaking API in a way which is 

# not backwards compatible. 

# 

# This needs to take into account several historical APIs: 

# - calling with an fd as first argument 

# - calling with a Python file object as first argument (we keep this one as 

# it's really convenient and does not change the number of arguments) 

# - calling without a priority as second argument 

def _io_add_watch_get_args(channel, priority_, condition, *cb_and_user_data, **kwargs): 

if not isinstance(priority_, int) or isinstance(priority_, GLib.IOCondition): 

warnings.warn('Calling io_add_watch without priority as second argument is deprecated', 

PyGIDeprecationWarning) 

# shift the arguments around 

user_data = cb_and_user_data 

callback = condition 

condition = priority_ 

if not callable(callback): 

raise TypeError('third argument must be callable') 

 

# backwards compatibility: Call with priority kwarg 

if 'priority' in kwargs: 

warnings.warn('Calling io_add_watch with priority keyword argument is deprecated, put it as second positional argument', 

PyGIDeprecationWarning) 

priority_ = kwargs['priority'] 

else: 

priority_ = GLib.PRIORITY_DEFAULT 

else: 

if len(cb_and_user_data) < 1 or not callable(cb_and_user_data[0]): 

raise TypeError('expecting callback as fourth argument') 

callback = cb_and_user_data[0] 

user_data = cb_and_user_data[1:] 

 

# backwards compatibility: Allow calling with fd 

if isinstance(channel, int): 

func_fdtransform = lambda _, cond, *data: callback(channel, cond, *data) 

real_channel = GLib.IOChannel.unix_new(channel) 

elif isinstance(channel, socket.socket) and sys.platform == 'win32': 

func_fdtransform = lambda _, cond, *data: callback(channel, cond, *data) 

real_channel = GLib.IOChannel.win32_new_socket(channel.fileno()) 

elif hasattr(channel, 'fileno'): 

# backwards compatibility: Allow calling with Python file 

func_fdtransform = lambda _, cond, *data: callback(channel, cond, *data) 

real_channel = GLib.IOChannel.unix_new(channel.fileno()) 

else: 

assert isinstance(channel, GLib.IOChannel) 

func_fdtransform = callback 

real_channel = channel 

 

return real_channel, priority_, condition, func_fdtransform, user_data 

 

 

__all__.append('_io_add_watch_get_args') 

 

 

def io_add_watch(*args, **kwargs): 

"""io_add_watch(channel, priority, condition, func, *user_data) -> event_source_id""" 

channel, priority, condition, func, user_data = _io_add_watch_get_args(*args, **kwargs) 

return GLib.io_add_watch(channel, priority, condition, func, *user_data) 

 

 

__all__.append('io_add_watch') 

 

 

# backwards compatible API 

class IOChannel(GLib.IOChannel): 

def __new__(cls, filedes=None, filename=None, mode=None, hwnd=None): 

if filedes is not None: 

return GLib.IOChannel.unix_new(filedes) 

if filename is not None: 

return GLib.IOChannel.new_file(filename, mode or 'r') 

if hwnd is not None: 

return GLib.IOChannel.win32_new_fd(hwnd) 

raise TypeError('either a valid file descriptor, file name, or window handle must be supplied') 

 

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

return super(IOChannel, self).__init__() 

 

def read(self, max_count=-1): 

return io_channel_read(self, max_count) 

 

def readline(self, size_hint=-1): 

# note, size_hint is just to maintain backwards compatible API; the 

# old static binding did not actually use it 

(status, buf, length, terminator_pos) = self.read_line() 

if buf is None: 

return '' 

return buf 

 

def readlines(self, size_hint=-1): 

# note, size_hint is just to maintain backwards compatible API; 

# the old static binding did not actually use it 

lines = [] 

status = GLib.IOStatus.NORMAL 

while status == GLib.IOStatus.NORMAL: 

(status, buf, length, terminator_pos) = self.read_line() 

# note, this appends an empty line after EOF; this is 

# bug-compatible with the old static bindings 

if buf is None: 

buf = '' 

lines.append(buf) 

return lines 

 

def write(self, buf, buflen=-1): 

if not isinstance(buf, bytes): 

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

if buflen == -1: 

buflen = len(buf) 

(status, written) = self.write_chars(buf, buflen) 

return written 

 

def writelines(self, lines): 

for line in lines: 

self.write(line) 

 

_whence_map = {0: GLib.SeekType.SET, 1: GLib.SeekType.CUR, 2: GLib.SeekType.END} 

 

def seek(self, offset, whence=0): 

try: 

w = self._whence_map[whence] 

except KeyError: 

raise ValueError("invalid 'whence' value") 

return self.seek_position(offset, w) 

 

def add_watch(self, condition, callback, *user_data, **kwargs): 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT) 

return io_add_watch(self, priority, condition, callback, *user_data) 

 

add_watch = deprecated(add_watch, 'GLib.io_add_watch()') 

 

def __iter__(self): 

return self 

 

def __next__(self): 

(status, buf, length, terminator_pos) = self.read_line() 

if status == GLib.IOStatus.NORMAL: 

return buf 

raise StopIteration 

 

# Python 2.x compatibility 

next = __next__ 

 

 

IOChannel = override(IOChannel) 

__all__.append('IOChannel') 

 

 

class PollFD(GLib.PollFD): 

def __new__(cls, fd, events): 

pollfd = GLib.PollFD() 

pollfd.__class__ = cls 

return pollfd 

 

def __init__(self, fd, events): 

self.fd = fd 

self.events = events 

 

 

PollFD = override(PollFD) 

__all__.append('PollFD') 

 

 

# The GI GLib API uses g_child_watch_add_full renamed to g_child_watch_add with 

# a signature of (priority, pid, callback, data). 

# Prior to PyGObject 3.8, this function was statically bound with an API closer to the 

# non-full version with a signature of: (pid, callback, data=None, priority=GLib.PRIORITY_DEFAULT) 

# We need to support this until we are okay with breaking API in a way which is 

# not backwards compatible. 

def _child_watch_add_get_args(priority_or_pid, pid_or_callback, *args, **kwargs): 

user_data = [] 

 

if callable(pid_or_callback): 

warnings.warn('Calling child_watch_add without priority as first argument is deprecated', 

PyGIDeprecationWarning) 

pid = priority_or_pid 

callback = pid_or_callback 

if len(args) == 0: 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT) 

elif len(args) == 1: 

user_data = args 

priority = kwargs.get('priority', GLib.PRIORITY_DEFAULT) 

elif len(args) == 2: 

user_data = [args[0]] 

priority = args[1] 

else: 

raise TypeError('expected at most 4 positional arguments') 

else: 

priority = priority_or_pid 

pid = pid_or_callback 

if 'function' in kwargs: 

callback = kwargs['function'] 

user_data = args 

elif len(args) > 0 and callable(args[0]): 

callback = args[0] 

user_data = args[1:] 

else: 

raise TypeError('expected callback as third argument') 

 

if 'data' in kwargs: 

if user_data: 

raise TypeError('got multiple values for "data" argument') 

user_data = [kwargs['data']] 

 

return priority, pid, callback, user_data 

 

 

# we need this to be accessible for unit testing 

__all__.append('_child_watch_add_get_args') 

 

 

def child_watch_add(*args, **kwargs): 

"""child_watch_add(priority, pid, function, *data)""" 

priority, pid, function, data = _child_watch_add_get_args(*args, **kwargs) 

return GLib.child_watch_add(priority, pid, function, *data) 

 

 

__all__.append('child_watch_add') 

 

 

def get_current_time(): 

return GLib.get_real_time() * 0.000001 

 

 

get_current_time = deprecated(get_current_time, 'GLib.get_real_time()') 

 

__all__.append('get_current_time') 

 

 

# backwards compatible API with default argument, and ignoring bytes_read 

# output argument 

def filename_from_utf8(utf8string, len=-1): 

return GLib.filename_from_utf8(utf8string, len)[0] 

 

 

__all__.append('filename_from_utf8') 

 

 

# backwards compatible API for renamed function 

if not hasattr(GLib, 'unix_signal_add_full'): 

def add_full_compat(*args): 

warnings.warn('GLib.unix_signal_add_full() was renamed to GLib.unix_signal_add()', 

PyGIDeprecationWarning) 

return GLib.unix_signal_add(*args) 

 

GLib.unix_signal_add_full = add_full_compat 

 

 

# obsolete constants for backwards compatibility 

glib_version = (GLib.MAJOR_VERSION, GLib.MINOR_VERSION, GLib.MICRO_VERSION) 

__all__.append('glib_version') 

deprecated_attr("GLib", "glib_version", 

"(GLib.MAJOR_VERSION, GLib.MINOR_VERSION, GLib.MICRO_VERSION)") 

 

pyglib_version = version_info 

__all__.append('pyglib_version') 

deprecated_attr("GLib", "pyglib_version", "gi.version_info")