GitPython/lib/git/odict.py at 0.2 · og-python-scripts/GitPython · GitHub

Repository navigation

History

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

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

# odict.py

# An Ordered Dictionary object

# E-mail: nico AT tekNico DOT net, fuzzyman AT voidspace DOT org DOT uk

# This software is licensed under the terms of the BSD license.

# http://www.voidspace.org.uk/python/license.shtml

# Basically you're free to copy, modify, distribute and relicense it,

# So long as you keep a copy of the license with it.

# Documentation at http://www.voidspace.org.uk/python/odict.html

# For information about bugfixes, updates and support, please join the

# Pythonutils mailing list:

# http://groups.google.com/group/pythonutils/

# Comments, suggestions and bug reports welcome.

"""A dict that keeps keys in insertion order"""

from __future__ import generators

__author__ = ('Nicola Larosa <nico-NoSp@m-tekNico.net>,'

'Michael Foord <fuzzyman AT voidspace DOT org DOT uk>')

__docformat__ = "restructuredtext en"

__revision__ = '$Id: odict.py 129 2005-09-12 18:15:28Z teknico $'

__version__ = '0.2.2'

__all__ = ['OrderedDict', 'SequenceOrderedDict']

import sys

INTP_VER = sys.version_info[:2]

if INTP_VER < (2, 2):

raise RuntimeError("Python v.2.2 or later required")

import types, warnings

class OrderedDict(dict):

"""

A class of dictionary that keeps the insertion order of keys.

All appropriate methods return keys, items, or values in an ordered way.

All normal dictionary methods are available. Update and comparison is

restricted to other OrderedDict objects.

Various sequence methods are available, including the ability to explicitly

mutate the key ordering.

__contains__ tests:

>>> d = OrderedDict(((1, 3),))

>>> 1 in d

>>> 4 in d

__getitem__ tests:

>>> OrderedDict(((1, 3), (3, 2), (2, 1)))[2]

>>> OrderedDict(((1, 3), (3, 2), (2, 1)))[4]

Traceback (most recent call last):

KeyError: 4

__len__ tests:

>>> len(OrderedDict())

>>> len(OrderedDict(((1, 3), (3, 2), (2, 1))))

get tests:

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.get(1)

>>> d.get(4) is None

>>> d.get(4, 5)

>>> d

OrderedDict([(1, 3), (3, 2), (2, 1)])

has_key tests:

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.has_key(1)

>>> d.has_key(4)

"""

def __init__(self, init_val=(), strict=False):

"""

Create a new ordered dictionary. Cannot init from a normal dict,

nor from kwargs, since items order is undefined in those cases.

If the ``strict`` keyword argument is ``True`` (``False`` is the

default) then when doing slice assignment - the ``OrderedDict`` you are

assigning from *must not* contain any keys in the remaining dict.

>>> OrderedDict()

OrderedDict([])

>>> OrderedDict({1: 1})

Traceback (most recent call last):

TypeError: undefined order, cannot get items from dict

>>> OrderedDict({1: 1}.items())

OrderedDict([(1, 1)])

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d

OrderedDict([(1, 3), (3, 2), (2, 1)])

>>> OrderedDict(d)

OrderedDict([(1, 3), (3, 2), (2, 1)])

"""

self.strict = strict

dict.__init__(self)

if isinstance(init_val, OrderedDict):

self._sequence = init_val.keys()

dict.update(self, init_val)

elif isinstance(init_val, dict):

# we lose compatibility with other ordered dict types this way

raise TypeError('undefined order, cannot get items from dict')

else:

self._sequence = []

self.update(init_val)

### Special methods ###

def __delitem__(self, key):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> del d[3]

>>> d

OrderedDict([(1, 3), (2, 1)])

>>> del d[3]

Traceback (most recent call last):

KeyError: 3

>>> d[3] = 2

>>> d

OrderedDict([(1, 3), (2, 1), (3, 2)])

>>> del d[0:1]

>>> d

OrderedDict([(2, 1), (3, 2)])

"""

if isinstance(key, types.SliceType):

# FIXME: efficiency?

keys = self._sequence[key]

for entry in keys:

dict.__delitem__(self, entry)

del self._sequence[key]

else:

# do the dict.__delitem__ *first* as it raises

# the more appropriate error

dict.__delitem__(self, key)

self._sequence.remove(key)

def __eq__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d == OrderedDict(d)

True

>>> d == OrderedDict(((1, 3), (2, 1), (3, 2)))

False

>>> d == OrderedDict(((1, 0), (3, 2), (2, 1)))

False

>>> d == OrderedDict(((0, 3), (3, 2), (2, 1)))

False

>>> d == dict(d)

False

>>> d == False

False

"""

if isinstance(other, OrderedDict):

# FIXME: efficiency?

# Generate both item lists for each compare

return (self.items() == other.items())

else:

return False

def __lt__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))

>>> c < d

True

>>> d < c

False

>>> d < dict(c)

Traceback (most recent call last):

TypeError: Can only compare with other OrderedDicts

"""

if not isinstance(other, OrderedDict):

raise TypeError('Can only compare with other OrderedDicts')

# FIXME: efficiency?

# Generate both item lists for each compare

return (self.items() < other.items())

def __le__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))

>>> e = OrderedDict(d)

>>> c <= d

True

>>> d <= c

False

>>> d <= dict(c)

Traceback (most recent call last):

TypeError: Can only compare with other OrderedDicts

>>> d <= e

True

"""

if not isinstance(other, OrderedDict):

raise TypeError('Can only compare with other OrderedDicts')

# FIXME: efficiency?

# Generate both item lists for each compare

return (self.items() <= other.items())

def __ne__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d != OrderedDict(d)

False

>>> d != OrderedDict(((1, 3), (2, 1), (3, 2)))

True

>>> d != OrderedDict(((1, 0), (3, 2), (2, 1)))

True

>>> d == OrderedDict(((0, 3), (3, 2), (2, 1)))

False

>>> d != dict(d)

True

>>> d != False

True

"""

if isinstance(other, OrderedDict):

# FIXME: efficiency?

# Generate both item lists for each compare

return not (self.items() == other.items())

else:

return True

def __gt__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))

>>> d > c

True

>>> c > d

False

>>> d > dict(c)

Traceback (most recent call last):

TypeError: Can only compare with other OrderedDicts

"""

if not isinstance(other, OrderedDict):

raise TypeError('Can only compare with other OrderedDicts')

# FIXME: efficiency?

# Generate both item lists for each compare

return (self.items() > other.items())

def __ge__(self, other):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))

>>> e = OrderedDict(d)

>>> c >= d

False

>>> d >= c

True

>>> d >= dict(c)

Traceback (most recent call last):

TypeError: Can only compare with other OrderedDicts

>>> e >= d

True

"""

if not isinstance(other, OrderedDict):

raise TypeError('Can only compare with other OrderedDicts')

# FIXME: efficiency?

# Generate both item lists for each compare

return (self.items() >= other.items())

def __repr__(self):

"""

Used for __repr__ and __str__

>>> r1 = repr(OrderedDict((('a', 'b'), ('c', 'd'), ('e', 'f'))))

>>> r1

"OrderedDict([('a', 'b'), ('c', 'd'), ('e', 'f')])"

>>> r2 = repr(OrderedDict((('a', 'b'), ('e', 'f'), ('c', 'd'))))

>>> r2

"OrderedDict([('a', 'b'), ('e', 'f'), ('c', 'd')])"

>>> r1 == str(OrderedDict((('a', 'b'), ('c', 'd'), ('e', 'f'))))

True

>>> r2 == str(OrderedDict((('a', 'b'), ('e', 'f'), ('c', 'd'))))

True

"""

return '%s([%s])' % (self.__class__.__name__, ', '.join(

['(%r, %r)' % (key, self[key]) for key in self._sequence]))

def __setitem__(self, key, val):

"""

Allows slice assignment, so long as the slice is an OrderedDict

>>> d = OrderedDict()

>>> d['a'] = 'b'

>>> d['b'] = 'a'

>>> d[3] = 12

>>> d

OrderedDict([('a', 'b'), ('b', 'a'), (3, 12)])

>>> d[:] = OrderedDict(((1, 2), (2, 3), (3, 4)))

>>> d

OrderedDict([(1, 2), (2, 3), (3, 4)])

>>> d[::2] = OrderedDict(((7, 8), (9, 10)))

>>> d

OrderedDict([(7, 8), (2, 3), (9, 10)])

>>> d = OrderedDict(((0, 1), (1, 2), (2, 3), (3, 4)))

>>> d[1:3] = OrderedDict(((1, 2), (5, 6), (7, 8)))

>>> d

OrderedDict([(0, 1), (1, 2), (5, 6), (7, 8), (3, 4)])

>>> d = OrderedDict(((0, 1), (1, 2), (2, 3), (3, 4)), strict=True)

>>> d[1:3] = OrderedDict(((1, 2), (5, 6), (7, 8)))

>>> d

OrderedDict([(0, 1), (1, 2), (5, 6), (7, 8), (3, 4)])

>>> a = OrderedDict(((0, 1), (1, 2), (2, 3)), strict=True)

>>> a[3] = 4

>>> a

OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a[::1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a

OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a[:2] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4), (4, 5)])

Traceback (most recent call last):

ValueError: slice assignment must be from unique keys

>>> a = OrderedDict(((0, 1), (1, 2), (2, 3)))

>>> a[3] = 4

>>> a

OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a[::1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a

OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a[:2] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a

OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a[::-1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> a

OrderedDict([(3, 4), (2, 3), (1, 2), (0, 1)])

>>> d = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> d[:1] = 3

Traceback (most recent call last):

TypeError: slice assignment requires an OrderedDict

>>> d = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])

>>> d[:1] = OrderedDict([(9, 8)])

>>> d

OrderedDict([(9, 8), (1, 2), (2, 3), (3, 4)])

"""

if isinstance(key, types.SliceType):

if not isinstance(val, OrderedDict):

# FIXME: allow a list of tuples?

raise TypeError('slice assignment requires an OrderedDict')

keys = self._sequence[key]

# NOTE: Could use ``range(*key.indices(len(self._sequence)))``

indexes = range(len(self._sequence))[key]

if key.step is None:

# NOTE: new slice may not be the same size as the one being

# overwritten !

# NOTE: What is the algorithm for an impossible slice?

# e.g. d[5:3]

pos = key.start or 0

del self[key]

newkeys = val.keys()

for k in newkeys:

if k in self:

if self.strict:

raise ValueError('slice assignment must be from '

'unique keys')

else:

# NOTE: This removes duplicate keys *first*

# so start position might have changed?

del self[k]

self._sequence = (self._sequence[:pos] + newkeys +

self._sequence[pos:])

dict.update(self, val)

else:

# extended slice - length of new slice must be the same

# as the one being replaced

if len(keys) != len(val):

raise ValueError('attempt to assign sequence of size %s '

'to extended slice of size %s' % (len(val), len(keys)))

# FIXME: efficiency?

del self[key]

item_list = zip(indexes, val.items())

# smallest indexes first - higher indexes not guaranteed to

# exist

item_list.sort()

for pos, (newkey, newval) in item_list:

if self.strict and newkey in self:

raise ValueError('slice assignment must be from unique'

' keys')

self.insert(pos, newkey, newval)

else:

if key not in self:

self._sequence.append(key)

dict.__setitem__(self, key, val)

def __getitem__(self, key):

"""

Allows slicing. Returns an OrderedDict if you slice.

>>> b = OrderedDict([(7, 0), (6, 1), (5, 2), (4, 3), (3, 4), (2, 5), (1, 6)])

>>> b[::-1]

OrderedDict([(1, 6), (2, 5), (3, 4), (4, 3), (5, 2), (6, 1), (7, 0)])

>>> b[2:5]

OrderedDict([(5, 2), (4, 3), (3, 4)])

>>> type(b[2:4])

"""

if isinstance(key, types.SliceType):

# FIXME: does this raise the error we want?

keys = self._sequence[key]

# FIXME: efficiency?

return OrderedDict([(entry, self[entry]) for entry in keys])

else:

return dict.__getitem__(self, key)

__str__ = __repr__

def __setattr__(self, name, value):

"""

Implemented so that accesses to ``sequence`` raise a warning and are

diverted to the new ``setkeys`` method.

"""

if name == 'sequence':

warnings.warn('Use of the sequence attribute is deprecated.'

' Use the keys method instead.', DeprecationWarning)

# NOTE: doesn't return anything

self.setkeys(value)

else:

# FIXME: do we want to allow arbitrary setting of attributes?

# Or do we want to manage it?

object.__setattr__(self, name, value)

def __getattr__(self, name):

"""

Implemented so that access to ``sequence`` raises a warning.

>>> d = OrderedDict()

>>> d.sequence

[]

"""

if name == 'sequence':

warnings.warn('Use of the sequence attribute is deprecated.'

' Use the keys method instead.', DeprecationWarning)

# NOTE: Still (currently) returns a direct reference. Need to

# because code that uses sequence will expect to be able to

# mutate it in place.

return self._sequence

else:

# raise the appropriate error

raise AttributeError("OrderedDict has no '%s' attribute" % name)

def __deepcopy__(self, memo):

"""

To allow deepcopy to work with OrderedDict.

>>> from copy import deepcopy

>>> a = OrderedDict([(1, 1), (2, 2), (3, 3)])

>>> a['test'] = {}

>>> b = deepcopy(a)

>>> b == a

True

>>> b is a

False

>>> a['test'] is b['test']

False

"""

from copy import deepcopy

return self.__class__(deepcopy(self.items(), memo), self.strict)

### Read-only methods ###

def copy(self):

"""

>>> OrderedDict(((1, 3), (3, 2), (2, 1))).copy()

OrderedDict([(1, 3), (3, 2), (2, 1)])

"""

return OrderedDict(self)

def items(self):

"""

``items`` returns a list of tuples representing all the

``(key, value)`` pairs in the dictionary.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.items()

[(1, 3), (3, 2), (2, 1)]

>>> d.clear()

>>> d.items()

[]

"""

return zip(self._sequence, self.values())

def keys(self):

"""

Return a list of keys in the ``OrderedDict``.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.keys()

[1, 3, 2]

"""

return self._sequence[:]

def values(self, values=None):

"""

Return a list of all the values in the OrderedDict.

Optionally you can pass in a list of values, which will replace the

current list. The value list must be the same len as the OrderedDict.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.values()

[3, 2, 1]

"""

return [self[key] for key in self._sequence]

def iteritems(self):

"""

>>> ii = OrderedDict(((1, 3), (3, 2), (2, 1))).iteritems()

>>> ii.next()

(1, 3)

>>> ii.next()

(3, 2)

>>> ii.next()

(2, 1)

>>> ii.next()

Traceback (most recent call last):

StopIteration

"""

def make_iter(self=self):

keys = self.iterkeys()

while True:

key = keys.next()

yield (key, self[key])

return make_iter()

def iterkeys(self):

"""

>>> ii = OrderedDict(((1, 3), (3, 2), (2, 1))).iterkeys()

>>> ii.next()

Traceback (most recent call last):

StopIteration

"""

return iter(self._sequence)

__iter__ = iterkeys

def itervalues(self):

"""

>>> iv = OrderedDict(((1, 3), (3, 2), (2, 1))).itervalues()

>>> iv.next()

Traceback (most recent call last):

StopIteration

"""

def make_iter(self=self):

keys = self.iterkeys()

while True:

yield self[keys.next()]

return make_iter()

### Read-write methods ###

def clear(self):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.clear()

>>> d

OrderedDict([])

"""

dict.clear(self)

self._sequence = []

def pop(self, key, *args):

"""

No dict.pop in Python 2.2, gotta reimplement it

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.pop(3)

>>> d

OrderedDict([(1, 3), (2, 1)])

>>> d.pop(4)

Traceback (most recent call last):

KeyError: 4

>>> d.pop(4, 0)

>>> d.pop(4, 0, 1)

Traceback (most recent call last):

TypeError: pop expected at most 2 arguments, got 3

"""

if len(args) > 1:

raise TypeError, ('pop expected at most 2 arguments, got %s' %

(len(args) + 1))

if key in self:

val = self[key]

del self[key]

else:

try:

val = args[0]

except IndexError:

raise KeyError(key)

return val

def popitem(self, i=-1):

"""

Delete and return an item specified by index, not a random one as in

dict. The index is -1 by default (the last item).

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.popitem()

(2, 1)

>>> d

OrderedDict([(1, 3), (3, 2)])

>>> d.popitem(0)

(1, 3)

>>> OrderedDict().popitem()

Traceback (most recent call last):

KeyError: 'popitem(): dictionary is empty'

>>> d.popitem(2)

Traceback (most recent call last):

IndexError: popitem(): index 2 not valid

"""

if not self._sequence:

raise KeyError('popitem(): dictionary is empty')

try:

key = self._sequence[i]

except IndexError:

raise IndexError('popitem(): index %s not valid' % i)

return (key, self.pop(key))

def setdefault(self, key, defval = None):

"""

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.setdefault(1)

>>> d.setdefault(4) is None

True

>>> d

OrderedDict([(1, 3), (3, 2), (2, 1), (4, None)])

>>> d.setdefault(5, 0)

>>> d

OrderedDict([(1, 3), (3, 2), (2, 1), (4, None), (5, 0)])

"""

if key in self:

return self[key]

else:

self[key] = defval

return defval

def update(self, from_od):

"""

Update from another OrderedDict or sequence of (key, value) pairs

>>> d = OrderedDict(((1, 0), (0, 1)))

>>> d.update(OrderedDict(((1, 3), (3, 2), (2, 1))))

>>> d

OrderedDict([(1, 3), (0, 1), (3, 2), (2, 1)])

>>> d.update({4: 4})

Traceback (most recent call last):

TypeError: undefined order, cannot get items from dict

>>> d.update((4, 4))

Traceback (most recent call last):

TypeError: cannot convert dictionary update sequence element "4" to a 2-item sequence

"""

if isinstance(from_od, OrderedDict):

for key, val in from_od.items():

self[key] = val

elif isinstance(from_od, dict):

# we lose compatibility with other ordered dict types this way

raise TypeError('undefined order, cannot get items from dict')

else:

# FIXME: efficiency?

# sequence of 2-item sequences, or error

for item in from_od:

try:

key, val = item

except TypeError:

raise TypeError('cannot convert dictionary update'

' sequence element "%s" to a 2-item sequence' % item)

self[key] = val

def rename(self, old_key, new_key):

"""

Rename the key for a given value, without modifying sequence order.

For the case where new_key already exists this raise an exception,

since if new_key exists, it is ambiguous as to what happens to the

associated values, and the position of new_key in the sequence.

>>> od = OrderedDict()

>>> od['a'] = 1

>>> od['b'] = 2

>>> od.items()

[('a', 1), ('b', 2)]

>>> od.rename('b', 'c')

>>> od.items()

[('a', 1), ('c', 2)]

>>> od.rename('c', 'a')

Traceback (most recent call last):

ValueError: New key already exists: 'a'

>>> od.rename('d', 'b')

Traceback (most recent call last):

KeyError: 'd'

"""

if new_key == old_key:

# no-op

return

if new_key in self:

raise ValueError("New key already exists: %r" % new_key)

# rename sequence entry

value = self[old_key]

old_idx = self._sequence.index(old_key)

self._sequence[old_idx] = new_key

# rename internal dict entry

dict.__delitem__(self, old_key)

dict.__setitem__(self, new_key, value)

def setitems(self, items):

"""

This method allows you to set the items in the dict.

It takes a list of tuples - of the same sort returned by the ``items``

method.

>>> d = OrderedDict()

>>> d.setitems(((3, 1), (2, 3), (1, 2)))

>>> d

OrderedDict([(3, 1), (2, 3), (1, 2)])

"""

self.clear()

# FIXME: this allows you to pass in an OrderedDict as well :-)

self.update(items)

def setkeys(self, keys):

"""

``setkeys`` all ows you to pass in a new list of keys which will

replace the current set. This must contain the same set of keys, but

need not be in the same order.

If you pass in new keys that don't match, a ``KeyError`` will be

raised.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.keys()

[1, 3, 2]

>>> d.setkeys((1, 2, 3))

>>> d

OrderedDict([(1, 3), (2, 1), (3, 2)])

>>> d.setkeys(['a', 'b', 'c'])

Traceback (most recent call last):

KeyError: 'Keylist is not the same as current keylist.'

"""

# FIXME: Efficiency? (use set for Python 2.4 :-)

# NOTE: list(keys) rather than keys[:] because keys[:] returns

# a tuple, if keys is a tuple.

kcopy = list(keys)

kcopy.sort()

self._sequence.sort()

if kcopy != self._sequence:

raise KeyError('Keylist is not the same as current keylist.')

# NOTE: This makes the _sequence attribute a new object, instead

# of changing it in place.

# FIXME: efficiency?

self._sequence = list(keys)

def setvalues(self, values):

"""

You can pass in a list of values, which will replace the

current list. The value list must be the same len as the OrderedDict.

(Or a ``ValueError`` is raised.)

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.setvalues((1, 2, 3))

>>> d

OrderedDict([(1, 1), (3, 2), (2, 3)])

>>> d.setvalues([6])

Traceback (most recent call last):

ValueError: Value list is not the same length as the OrderedDict.

"""

if len(values) != len(self):

# FIXME: correct error to raise?

raise ValueError('Value list is not the same length as the '

'OrderedDict.')

self.update(zip(self, values))

### Sequence Methods ###

def index(self, key):

"""

Return the position of the specified key in the OrderedDict.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.index(3)

>>> d.index(4)

Traceback (most recent call last):

ValueError: list.index(x): x not in list

"""

return self._sequence.index(key)

def insert(self, index, key, value):

"""

Takes ``index``, ``key``, and ``value`` as arguments.

Sets ``key`` to ``value``, so that ``key`` is at position ``index`` in

the OrderedDict.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.insert(0, 4, 0)

>>> d

OrderedDict([(4, 0), (1, 3), (3, 2), (2, 1)])

>>> d.insert(0, 2, 1)

>>> d

OrderedDict([(2, 1), (4, 0), (1, 3), (3, 2)])

>>> d.insert(8, 8, 1)

>>> d

OrderedDict([(2, 1), (4, 0), (1, 3), (3, 2), (8, 1)])

"""

if key in self:

# FIXME: efficiency?

del self[key]

self._sequence.insert(index, key)

dict.__setitem__(self, key, value)

def reverse(self):

"""

Reverse the order of the OrderedDict.

>>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))

>>> d.reverse()

>>> d

OrderedDict([(2, 1), (3, 2), (1, 3)])

"""

self._sequence.reverse()

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

"""

Sort the key order in the OrderedDict.

This method takes the same arguments as the ``list.sort`` method on

your version of Python.

>>> d = OrderedDict(((4, 1), (2, 2), (3, 3), (1, 4)))

>>> d.sort()

>>> d

OrderedDict([(1, 4), (2, 2), (3, 3), (4, 1)])

"""

self._sequence.sort(*args, **kwargs)

class Keys(object):

# FIXME: should this object be a subclass of list?

"""

Custom object for accessing the keys of an OrderedDict.

Can be called like the normal ``OrderedDict.keys`` method, but also

supports indexing and sequence methods.

"""

def __init__(self, main):

self._main = main

def __call__(self):

"""Pretend to be the keys method."""

return self._main._keys()

def __getitem__(self, index):

"""Fetch the key at position i."""

# NOTE: this automatically supports slicing :-)

return self._main._sequence[index]

def __setitem__(self, index, name):

"""

You cannot assign to keys, but you can do slice assignment to re-order

them.

You can only do slice assignment if the new set of keys is a reordering

of the original set.

"""

if isinstance(index, types.SliceType):

# FIXME: efficiency?

# check length is the same

indexes = range(len(self._main._sequence))[index]

if len(indexes) != len(name):

raise ValueError('attempt to assign sequence of size %s '

'to slice of size %s' % (len(name), len(indexes)))

# check they are the same keys

# FIXME: Use set

old_keys = self._main._sequence[index]

new_keys = list(name)

old_keys.sort()

new_keys.sort()

if old_keys != new_keys:

raise KeyError('Keylist is not the same as current keylist.')

orig_vals = [self._main[k] for k in name]

del self._main[index]

vals = zip(indexes, name, orig_vals)

vals.sort()

for i, k, v in vals:

if self._main.strict and k in self._main:

raise ValueError('slice assignment must be from '

'unique keys')

self._main.insert(i, k, v)

else:

raise ValueError('Cannot assign to keys')

### following methods pinched from UserList and adapted ###

def __repr__(self): return repr(self._main._sequence)

# FIXME: do we need to check if we are comparing with another ``Keys``

# object? (like the __cast method of UserList)

def __lt__(self, other): return self._main._sequence < other

def __le__(self, other): return self._main._sequence <= other

def __eq__(self, other): return self._main._sequence == other

def __ne__(self, other): return self._main._sequence != other

def __gt__(self, other): return self._main._sequence > other

def __ge__(self, other): return self._main._sequence >= other

# FIXME: do we need __cmp__ as well as rich comparisons?

def __cmp__(self, other): return cmp(self._main._sequence, other)

def __contains__(self, item): return item in self._main._sequence

def __len__(self): return len(self._main._sequence)

def __iter__(self): return self._main.iterkeys()

def count(self, item): return self._main._sequence.count(item)

def index(self, item, *args): return self._main._sequence.index(item, *args)

def reverse(self): self._main._sequence.reverse()

def sort(self, *args, **kwds): self._main._sequence.sort(*args, **kwds)

def __mul__(self, n): return self._main._sequence*n

__rmul__ = __mul__

def __add__(self, other): return self._main._sequence + other

def __radd__(self, other): return other + self._main._sequence

## following methods not implemented for keys ##

def __delitem__(self, i): raise TypeError('Can\'t delete items from keys')

def __iadd__(self, other): raise TypeError('Can\'t add in place to keys')

def __imul__(self, n): raise TypeError('Can\'t multiply keys in place')

def append(self, item): raise TypeError('Can\'t append items to keys')

def insert(self, i, item): raise TypeError('Can\'t insert items into keys')

def pop(self, i=-1): raise TypeError('Can\'t pop items from keys')

def remove(self, item): raise TypeError('Can\'t remove items from keys')

def extend(self, other): raise TypeError('Can\'t extend keys')

class Items(object):

"""

Custom object for accessing the items of an OrderedDict.

Can be called like the normal ``OrderedDict.items`` method, but also

supports indexing and sequence methods.

"""

def __init__(self, main):

self._main = main

def __call__(self):

"""Pretend to be the items method."""

return self._main._items()

def __getitem__(self, index):

"""Fetch the item at position i."""

if isinstance(index, types.SliceType):

# fetching a slice returns an OrderedDict

return self._main[index].items()

key = self._main._sequence[index]

return (key, self._main[key])

def __setitem__(self, index, item):

"""Set item at position i to item."""

if isinstance(index, types.SliceType):

# NOTE: item must be an iterable (list of tuples)

self._main[index] = OrderedDict(item)

else:

# FIXME: Does this raise a sensible error?

orig = self._main.keys[index]

key, value = item

if self._main.strict and key in self and (key != orig):

raise ValueError('slice assignment must be from '

'unique keys')

View remainder of file in raw view

GitPython/lib/git/odict.py at 0.2 · og-python-scripts/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

odict.py

Latest commit

History

Breadcrumbs

odict.py

File metadata and controls