GitPython/lib/git/remote.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

# remote.py

# This module is part of GitPython and is released under

# the BSD License: http://www.opensource.org/licenses/bsd-license.php

"""Module implementing a remote object allowing easy access to git remotes"""

from errors import GitCommandError

from git.utils import LazyMixin, Iterable, IterableList

from objects import Commit

from refs import Reference, RemoteReference, SymbolicReference, TagReference

import re

import os

class _SectionConstraint(object):

"""

Constrains a ConfigParser to only option commands which are constrained to

always use the section we have been initialized with.

It supports all ConfigParser methods that operate on an option

"""

__slots__ = ("_config", "_section_name")

_valid_attrs_ = ("get_value", "set_value", "get", "set", "getint", "getfloat", "getboolean", "has_option")

def __init__(self, config, section):

self._config = config

self._section_name = section

def __getattr__(self, attr):

if attr in self._valid_attrs_:

return lambda *args, **kwargs: self._call_config(attr, *args, **kwargs)

return super(_SectionConstraint,self).__getattribute__(attr)

def _call_config(self, method, *args, **kwargs):

"""Call the configuration at the given method which must take a section name

as first argument"""

return getattr(self._config, method)(self._section_name, *args, **kwargs)

class RemoteProgress(object):

"""

Handler providing an interface to parse progress information emitted by git-push

and git-fetch and to dispatch callbacks allowing subclasses to react to the progress.

"""

BEGIN, END, COUNTING, COMPRESSING, WRITING = [ 1 << x for x in range(5) ]

STAGE_MASK = BEGIN|END

OP_MASK = COUNTING|COMPRESSING|WRITING

__slots__ = ("_cur_line", "_seen_ops")

re_op_absolute = re.compile("(remote: )?([\w\s]+):\s+()(\d+)()(.*)")

re_op_relative = re.compile("(remote: )?([\w\s]+):\s+(\d+)% $(\d+)/(\d+)$(.*)")

def __init__(self):

self._seen_ops = list()

def _parse_progress_line(self, line):

"""

Parse progress information from the given line as retrieved by git-push

or git-fetch

@return: list(line, ...) list of lines that could not be processed"""

# handle

# Counting objects: 4, done.

# Compressing objects: 50% (1/2) \rCompressing objects: 100% (2/2) \rCompressing objects: 100% (2/2), done.

self._cur_line = line

sub_lines = line.split('\r')

failed_lines = list()

for sline in sub_lines:

# find esacpe characters and cut them away - regex will not work with

# them as they are non-ascii. As git might expect a tty, it will send them

last_valid_index = None

for i,c in enumerate(reversed(sline)):

if ord(c) < 32:

# its a slice index

last_valid_index = -i-1

# END character was non-ascii

# END for each character in sline

if last_valid_index is not None:

sline = sline[:last_valid_index]

# END cut away invalid part

sline = sline.rstrip()

cur_count, max_count = None, None

match = self.re_op_relative.match(sline)

if match is None:

match = self.re_op_absolute.match(sline)

if not match:

self.line_dropped(sline)

failed_lines.append(sline)

continue

# END could not get match

op_code = 0

remote, op_name, percent, cur_count, max_count, message = match.groups()

# get operation id

if op_name == "Counting objects":

op_code |= self.COUNTING

elif op_name == "Compressing objects":

op_code |= self.COMPRESSING

elif op_name == "Writing objects":

op_code |= self.WRITING

else:

raise ValueError("Operation name %r unknown" % op_name)

# figure out stage

if op_code not in self._seen_ops:

self._seen_ops.append(op_code)

op_code |= self.BEGIN

# END begin opcode

if message is None:

message = ''

# END message handling

message = message.strip()

done_token = ', done.'

if message.endswith(done_token):

op_code |= self.END

message = message[:-len(done_token)]

# END end message handling

self.update(op_code, cur_count, max_count, message)

# END for each sub line

return failed_lines

def line_dropped(self, line):

"""

Called whenever a line could not be understood and was therefore dropped.

"""

pass

def update(self, op_code, cur_count, max_count=None, message=''):

"""

Called whenever the progress changes

``op_code``

Integer allowing to be compared against Operation IDs and stage IDs.

Stage IDs are BEGIN and END. BEGIN will only be set once for each Operation

ID as well as END. It may be that BEGIN and END are set at once in case only

one progress message was emitted due to the speed of the operation.

Between BEGIN and END, none of these flags will be set

Operation IDs are all held within the OP_MASK. Only one Operation ID will

be active per call.

``cur_count``

Current absolute count of items

``max_count``

The maximum count of items we expect. It may be None in case there is

no maximum number of items or if it is (yet) unknown.

``message``

In case of the 'WRITING' operation, it contains the amount of bytes

transferred. It may possibly be used for other purposes as well.

You may read the contents of the current line in self._cur_line

"""

pass

class PushInfo(object):

"""

Carries information about the result of a push operation of a single head::

info = remote.push()[0]

info.flags # bitflags providing more information about the result

info.local_ref # Reference pointing to the local reference that was pushed

# It is None if the ref was deleted.

info.remote_ref_string # path to the remote reference located on the remote side

info.remote_ref # Remote Reference on the local side corresponding to

# the remote_ref_string. It can be a TagReference as well.

info.old_commit # commit at which the remote_ref was standing before we pushed

# it to local_ref.commit. Will be None if an error was indicated

info.summary # summary line providing human readable english text about the push

"""

__slots__ = ('local_ref', 'remote_ref_string', 'flags', 'old_commit', '_remote', 'summary')

NEW_TAG, NEW_HEAD, NO_MATCH, REJECTED, REMOTE_REJECTED, REMOTE_FAILURE, DELETED, \

FORCED_UPDATE, FAST_FORWARD, UP_TO_DATE, ERROR = [ 1 << x for x in range(11) ]

_flag_map = { 'X' : NO_MATCH, '-' : DELETED, '*' : 0,

'+' : FORCED_UPDATE, ' ' : FAST_FORWARD,

'=' : UP_TO_DATE, '!' : ERROR }

def __init__(self, flags, local_ref, remote_ref_string, remote, old_commit=None,

summary=''):

"""

Initialize a new instance

"""

self.flags = flags

self.local_ref = local_ref

self.remote_ref_string = remote_ref_string

self._remote = remote

self.old_commit = old_commit

self.summary = summary

@property

def remote_ref(self):

"""

Returns

Remote Reference or TagReference in the local repository corresponding

to the remote_ref_string kept in this instance.

"""

# translate heads to a local remote, tags stay as they are

if self.remote_ref_string.startswith("refs/tags"):

return TagReference(self._remote.repo, self.remote_ref_string)

elif self.remote_ref_string.startswith("refs/heads"):

remote_ref = Reference(self._remote.repo, self.remote_ref_string)

return RemoteReference(self._remote.repo, "refs/remotes/%s/%s" % (str(self._remote), remote_ref.name))

else:

raise ValueError("Could not handle remote ref: %r" % self.remote_ref_string)

# END

@classmethod

def _from_line(cls, remote, line):

"""

Create a new PushInfo instance as parsed from line which is expected to be like

c refs/heads/master:refs/heads/master 05d2687..1d0568e

"""

control_character, from_to, summary = line.split('\t', 3)

flags = 0

# control character handling

try:

flags |= cls._flag_map[ control_character ]

except KeyError:

raise ValueError("Control Character %r unknown as parsed from line %r" % (control_character, line))

# END handle control character

# from_to handling

from_ref_string, to_ref_string = from_to.split(':')

if flags & cls.DELETED:

from_ref = None

else:

from_ref = Reference.from_path(remote.repo, from_ref_string)

# commit handling, could be message or commit info

old_commit = None

if summary.startswith('['):

if "[rejected]" in summary:

flags |= cls.REJECTED

elif "[remote rejected]" in summary:

flags |= cls.REMOTE_REJECTED

elif "[remote failure]" in summary:

flags |= cls.REMOTE_FAILURE

elif "[no match]" in summary:

flags |= cls.ERROR

elif "[new tag]" in summary:

flags |= cls.NEW_TAG

elif "[new branch]" in summary:

flags |= cls.NEW_HEAD

# uptodate encoded in control character

else:

# fast-forward or forced update - was encoded in control character,

# but we parse the old and new commit

split_token = "..."

if control_character == " ":

split_token = ".."

old_sha, new_sha = summary.split(' ')[0].split(split_token)

old_commit = Commit(remote.repo, old_sha)

# END message handling

return PushInfo(flags, from_ref, to_ref_string, remote, old_commit, summary)

class FetchInfo(object):

"""

Carries information about the results of a fetch operation of a single head::

info = remote.fetch()[0]

info.ref # Symbolic Reference or RemoteReference to the changed

# remote head or FETCH_HEAD

info.flags # additional flags to be & with enumeration members,

# i.e. info.flags & info.REJECTED

# is 0 if ref is SymbolicReference

info.note # additional notes given by git-fetch intended for the user

info.old_commit # if info.flags & info.FORCED_UPDATE|info.FAST_FORWARD,

# field is set to the previous location of ref, otherwise None

"""

__slots__ = ('ref','old_commit', 'flags', 'note')

NEW_TAG, NEW_HEAD, HEAD_UPTODATE, TAG_UPDATE, REJECTED, FORCED_UPDATE, \

FAST_FORWARD, ERROR = [ 1 << x for x in range(8) ]

# %c %-*s %-*s -> %s (%s)

re_fetch_result = re.compile("^\s*(.) (\[?[\w\s\.]+\]?)\s+(.+) -> ([/\w_\.-]+)( $.*$?$)?")

_flag_map = { '!' : ERROR, '+' : FORCED_UPDATE, '-' : TAG_UPDATE, '*' : 0,

'=' : HEAD_UPTODATE, ' ' : FAST_FORWARD }

def __init__(self, ref, flags, note = '', old_commit = None):

"""

Initialize a new instance

"""

self.ref = ref

self.flags = flags

self.note = note

self.old_commit = old_commit

def __str__(self):

return self.name

@property

def name(self):

"""

Returns

Name of our remote ref

"""

return self.ref.name

@property

def commit(self):

"""

Returns

Commit of our remote ref

"""

return self.ref.commit

@classmethod

def _from_line(cls, repo, line, fetch_line):

"""

Parse information from the given line as returned by git-fetch -v

and return a new FetchInfo object representing this information.

We can handle a line as follows

"%c %-*s %-*s -> %s%s"

Where c is either ' ', !, +, -, *, or =

! means error

+ means success forcing update

- means a tag was updated

* means birth of new branch or tag

= means the head was up to date ( and not moved )

' ' means a fast-forward

fetch line is the corresponding line from FETCH_HEAD, like

acb0fa8b94ef421ad60c8507b634759a472cd56c not-for-merge branch '0.1.7RC' of /tmp/tmpya0vairemote_repo

"""

match = cls.re_fetch_result.match(line)

if match is None:

raise ValueError("Failed to parse line: %r" % line)

# parse lines

control_character, operation, local_remote_ref, remote_local_ref, note = match.groups()

try:

new_hex_sha, fetch_operation, fetch_note = fetch_line.split("\t")

ref_type_name, fetch_note = fetch_note.split(' ', 1)

except ValueError: # unpack error

raise ValueError("Failed to parse FETCH__HEAD line: %r" % fetch_line)

# handle FETCH_HEAD and figure out ref type

# If we do not specify a target branch like master:refs/remotes/origin/master,

# the fetch result is stored in FETCH_HEAD which destroys the rule we usually

# have. In that case we use a symbolic reference which is detached

ref_type = None

if remote_local_ref == "FETCH_HEAD":

ref_type = SymbolicReference

elif ref_type_name == "branch":

ref_type = RemoteReference

elif ref_type_name == "tag":

ref_type = TagReference

else:

raise TypeError("Cannot handle reference type: %r" % ref_type_name)

# create ref instance

if ref_type is SymbolicReference:

remote_local_ref = ref_type(repo, "FETCH_HEAD")

else:

remote_local_ref = Reference.from_path(repo, os.path.join(ref_type._common_path_default, remote_local_ref.strip()))

# END create ref instance

note = ( note and note.strip() ) or ''

# parse flags from control_character

flags = 0

try:

flags |= cls._flag_map[control_character]

except KeyError:

raise ValueError("Control character %r unknown as parsed from line %r" % (control_character, line))

# END control char exception hanlding

# parse operation string for more info - makes no sense for symbolic refs

old_commit = None

if isinstance(remote_local_ref, Reference):

if 'rejected' in operation:

flags |= cls.REJECTED

if 'new tag' in operation:

flags |= cls.NEW_TAG

if 'new branch' in operation:

flags |= cls.NEW_HEAD

if '...' in operation or '..' in operation:

split_token = '...'

if control_character == ' ':

split_token = split_token[:-1]

old_commit = Commit(repo, operation.split(split_token)[0])

# END handle refspec

# END reference flag handling

return cls(remote_local_ref, flags, note, old_commit)

class Remote(LazyMixin, Iterable):

"""

Provides easy read and write access to a git remote.

Everything not part of this interface is considered an option for the current

remote, allowing constructs like remote.pushurl to query the pushurl.

NOTE: When querying configuration, the configuration accessor will be cached

to speed up subsequent accesses.

"""

__slots__ = ( "repo", "name", "_config_reader" )

_id_attribute_ = "name"

def __init__(self, repo, name):

"""

Initialize a remote instance

``repo``

The repository we are a remote of

``name``

the name of the remote, i.e. 'origin'

"""

self.repo = repo

self.name = name

def __getattr__(self, attr):

"""

Allows to call this instance like

remote.special( *args, **kwargs) to call git-remote special self.name

"""

if attr == "_config_reader":

return super(Remote, self).__getattr__(attr)

return self._config_reader.get(attr)

def _config_section_name(self):

return 'remote "%s"' % self.name

def _set_cache_(self, attr):

if attr == "_config_reader":

self._config_reader = _SectionConstraint(self.repo.config_reader(), self._config_section_name())

else:

super(Remote, self)._set_cache_(attr)

def __str__(self):

return self.name

def __repr__(self):

return '<git.%s "%s">' % (self.__class__.__name__, self.name)

def __eq__(self, other):

return self.name == other.name

def __ne__(self, other):

return not ( self == other )

def __hash__(self):

return hash(self.name)

@classmethod

def iter_items(cls, repo):

"""

Returns

Iterator yielding Remote objects of the given repository

"""

for section in repo.config_reader("repository").sections():

if not section.startswith('remote'):

continue

lbound = section.find('"')

rbound = section.rfind('"')

if lbound == -1 or rbound == -1:

raise ValueError("Remote-Section has invalid format: %r" % section)

yield Remote(repo, section[lbound+1:rbound])

# END for each configuration section

@property

def refs(self):

"""

Returns

IterableList of RemoteReference objects. It is prefixed, allowing

you to omit the remote path portion, i.e.::

remote.refs.master # yields RemoteReference('/refs/remotes/origin/master')

"""

out_refs = IterableList(RemoteReference._id_attribute_, "%s/" % self.name)

for ref in RemoteReference.list_items(self.repo):

if ref.remote_name == self.name:

out_refs.append(ref)

# END if names match

# END for each ref

assert out_refs, "Remote %s did not have any references" % self.name

return out_refs

@property

def stale_refs(self):

"""

Returns

IterableList RemoteReference objects that do not have a corresponding

head in the remote reference anymore as they have been deleted on the

remote side, but are still available locally.

The IterableList is prefixed, hence the 'origin' must be omitted. See

'refs' property for an example.

"""

out_refs = IterableList(RemoteReference._id_attribute_, "%s/" % self.name)

for line in self.repo.git.remote("prune", "--dry-run", self).splitlines()[2:]:

# expecting

# * [would prune] origin/new_branch

token = " * [would prune] "

if not line.startswith(token):

raise ValueError("Could not parse git-remote prune result: %r" % line)

fqhn = "%s/%s" % (RemoteReference._common_path_default,line.replace(token, ""))

out_refs.append(RemoteReference(self.repo, fqhn))

# END for each line

return out_refs

@classmethod

def create(cls, repo, name, url, **kwargs):

"""

Create a new remote to the given repository

``repo``

Repository instance that is to receive the new remote

``name``

Desired name of the remote

``url``

URL which corresponds to the remote's name

``**kwargs``

Additional arguments to be passed to the git-remote add command

Returns

New Remote instance

Raise

GitCommandError in case an origin with that name already exists

"""

repo.git.remote( "add", name, url, **kwargs )

return cls(repo, name)

# add is an alias

add = create

@classmethod

def remove(cls, repo, name ):

"""

Remove the remote with the given name

"""

repo.git.remote("rm", name)

# alias

rm = remove

def rename(self, new_name):

"""

Rename self to the given new_name

Returns

self

"""

if self.name == new_name:

return self

self.repo.git.remote("rename", self.name, new_name)

self.name = new_name

del(self._config_reader) # it contains cached values, section names are different now

return self

def update(self, **kwargs):

"""

Fetch all changes for this remote, including new branches which will

be forced in ( in case your local remote branch is not part the new remote branches

ancestry anymore ).

``kwargs``

Additional arguments passed to git-remote update

Returns

self

"""

self.repo.git.remote("update", self.name)

return self

def _digest_process_messages(self, fh, progress):

"""Read progress messages from file-like object fh, supplying the respective

progress messages to the progress instance.

@return: list(line, ...) list of lines without linebreaks that did

not contain progress information"""

line_so_far = ''

dropped_lines = list()

while True:

char = fh.read(1)

if not char:

break

if char in ('\r', '\n'):

dropped_lines.extend(progress._parse_progress_line(line_so_far))

line_so_far = ''

else:

line_so_far += char

# END process parsed line

# END while file is not done reading

return dropped_lines

def _finalize_proc(self, proc):

"""Wait for the process (fetch, pull or push) and handle its errors accordingly"""

try:

proc.wait()

except GitCommandError,e:

# if a push has rejected items, the command has non-zero return status

# a return status of 128 indicates a connection error - reraise the previous one

if proc.poll() == 128:

raise

pass

# END exception handling

def _get_fetch_info_from_stderr(self, proc, progress):

# skip first line as it is some remote info we are not interested in

output = IterableList('name')

# lines which are no progress are fetch info lines

# this also waits for the command to finish

# Skip some progress lines that don't provide relevant information

fetch_info_lines = list()

for line in self._digest_process_messages(proc.stderr, progress):

if line.startswith('From') or line.startswith('remote: Total'):

continue

fetch_info_lines.append(line)

# END for each line

# read head information

fp = open(os.path.join(self.repo.git_dir, 'FETCH_HEAD'),'r')

fetch_head_info = fp.readlines()

fp.close()

assert len(fetch_info_lines) == len(fetch_head_info)

output.extend(FetchInfo._from_line(self.repo, err_line, fetch_line)

for err_line,fetch_line in zip(fetch_info_lines, fetch_head_info))

self._finalize_proc(proc)

return output

def _get_push_info(self, proc, progress):

# read progress information from stderr

# we hope stdout can hold all the data, it should ...

# read the lines manually as it will use carriage returns between the messages

# to override the previous one. This is why we read the bytes manually

self._digest_process_messages(proc.stderr, progress)

output = IterableList('name')

for line in proc.stdout.readlines():

try:

output.append(PushInfo._from_line(self, line))

except ValueError:

# if an error happens, additional info is given which we cannot parse

pass

# END exception handling

# END for each line

self._finalize_proc(proc)

return output

def fetch(self, refspec=None, progress=None, **kwargs):

"""

Fetch the latest changes for this remote

``refspec``

A "refspec" is used by fetch and push to describe the mapping

between remote ref and local ref. They are combined with a colon in

the format <src>:<dst>, preceded by an optional plus sign, +.

For example: git fetch $URL refs/heads/master:refs/heads/origin means

"grab the master branch head from the $URL and store it as my origin

branch head". And git push $URL refs/heads/master:refs/heads/to-upstream

means "publish my master branch head as to-upstream branch at $URL".

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

Repository navigation

Expand file tree

Breadcrumbs

remote.py

Latest commit

History

Breadcrumbs

remote.py

File metadata and controls