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

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

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

1250

1251

1252

1253

1254

1255

1256

1257

1258

1259

1260

1261

1262

1263

1264

1265

1266

1267

1268

1269

1270

1271

1272

1273

1274

1275

1276

1277

1278

1279

1280

1281

1282

1283

1284

1285

1286

1287

1288

1289

1290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300

1301

1302

1303

1304

1305

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

1323

1324

1325

1326

1327

1328

1329

1330

1331

1332

1333

1334

1335

1336

1337

1338

1339

1340

1341

1342

1343

1344

1345

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

1368

1369

1370

1371

1372

1373

1374

1375

1376

1377

1378

1379

1380

1381

1382

1383

1384

1385

1386

1387

1388

1389

1390

1391

1392

1393

1394

1395

1396

1397

1398

1399

1400

1401

1402

1403

1404

1405

1406

1407

1408

1409

1410

1411

1412

1413

1414

1415

1416

1417

1418

1419

1420

1421

1422

1423

1424

1425

1426

1427

1428

1429

1430

1431

1432

1433

1434

1435

1436

1437

1438

1439

1440

1441

1442

1443

1444

1445

1446

1447

1448

1449

1450

1451

1452

1453

1454

1455

1456

1457

1458

1459

1460

1461

1462

1463

1464

1465

1466

1467

1468

1469

1470

1471

1472

1473

1474

1475

1476

1477

1478

1479

1480

1481

1482

1483

1484

1485

1486

1487

1488

1489

1490

1491

1492

1493

1494

1495

1496

1497

1498

1499

1500

1501

1502

1503

1504

1505

1506

1507

1508

1509

1510

1511

1512

1513

1514

1515

1516

1517

1518

1519

1520

1521

1522

1523

1524

1525

1526

1527

1528

1529

1530

1531

1532

1533

1534

1535

1536

1537

1538

1539

1540

1541

1542

1543

1544

1545

1546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

1558

1559

1560

1561

1562

1563

1564

1565

1566

1567

1568

1569

1570

1571

1572

1573

1574

1575

1576

1577

1578

1579

1580

1581

1582

1583

1584

1585

1586

1587

1588

1589

1590

1591

1592

1593

1594

1595

1596

1597

1598

1599

1600

1601

1602

1603

1604

1605

1606

1607

1608

1609

1610

1611

1612

1613

1614

1615

1616

1617

1618

1619

1620

1621

1622

1623

1624

# vim: set fileencoding=utf-8 : 

# 

# (C) 2006,2007,2008,2011 Guido Guenther <agx@sigxcpu.org> 

#    This program is free software; you can redistribute it and/or modify 

#    it under the terms of the GNU General Public License as published by 

#    the Free Software Foundation; either version 2 of the License, or 

#    (at your option) any later version. 

# 

#    This program 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 General Public License for more details. 

# 

#    You should have received a copy of the GNU General Public License 

#    along with this program; if not, write to the Free Software 

#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

"""A Git repository""" 

 

import subprocess 

import os.path 

import re 

from collections import defaultdict 

 

import gbp.log as log 

from gbp.command_wrappers import (GitCommand, CommandExecFailed) 

from gbp.errors import GbpError 

from gbp.git.modifier import GitModifier 

from gbp.git.commit import GitCommit 

from gbp.git.errors import GitError 

from gbp.git.args import GitArgs 

 

 

class GitRepositoryError(GitError): 

    """Exception thrown by L{GitRepository}""" 

    pass 

 

 

class GitRepository(object): 

    """ 

    Represents a git repository at I{path}. It's currently assumed that the git 

    repository is stored in a directory named I{.git/} below I{path}. 

 

    @ivar _path: The path to the working tree 

    @type _path: C{str} 

    @ivar _bare: Whether this is a bare repository 

    @type _bare: C{bool} 

    @raises GitRepositoryError: on git errors GitRepositoryError is raised by 

        all methods. 

    """ 

 

    def _check_bare(self): 

        """Check whether this is a bare repository""" 

        out, dummy, ret = self._git_inout('rev-parse', ['--is-bare-repository'], 

                                          capture_stderr=True) 

        if ret: 

            raise GitRepositoryError( 

                "Failed to get repository state at '%s'" % self.path) 

        self._bare = False if out.strip() != 'true' else True 

        self._git_dir = '' if self._bare else '.git' 

 

    def __init__(self, path): 

        self._path = os.path.abspath(path) 

        self._bare = False 

        try: 

            out, dummy, ret = self._git_inout('rev-parse', ['--show-cdup'], 

                                              capture_stderr=True) 

            if ret or out.strip(): 

                raise GitRepositoryError("No Git repository at '%s': '%s'" % (self.path, out)) 

        except GitRepositoryError: 

            raise # We already have a useful error message 

        except: 

            raise GitRepositoryError("No Git repository at '%s'" % self.path) 

        self._check_bare() 

 

    def __build_env(self, extra_env): 

        """Prepare environment for subprocess calls""" 

        env = None 

        if extra_env is not None: 

            env = os.environ.copy() 

            env.update(extra_env) 

        return env 

 

    def _git_getoutput(self, command, args=[], extra_env=None, cwd=None): 

        """ 

        Run a git command and return the output 

 

        @param command: git command to run 

        @type command: C{str} 

        @param args: list of arguments 

        @type args: C{list} 

        @param extra_env: extra environment variables to pass 

        @type extra_env: C{dict} 

        @param cwd: directory to swith to when running the command, defaults to I{self.path} 

        @type cwd: C{str} 

        @return: stdout, return code 

        @rtype: C{tuple} of C{list} of C{str} and C{int} 

 

        @deprecated: use L{gbp.git.repository.GitRepository._git_inout} instead. 

        """ 

        output = [] 

 

        if not cwd: 

            cwd = self.path 

 

        env = self.__build_env(extra_env) 

        cmd = ['git', command] + args 

        log.debug(cmd) 

        popen = subprocess.Popen(cmd, stdout=subprocess.PIPE, env=env, cwd=cwd) 

        while popen.poll() == None: 

            output += popen.stdout.readlines() 

        output += popen.stdout.readlines() 

        return output, popen.returncode 

 

    def _git_inout(self, command, args, input=None, extra_env=None, cwd=None, 

                   capture_stderr=False): 

        """ 

        Run a git command with input and return output 

 

        @param command: git command to run 

        @type command: C{str} 

        @param input: input to pipe to command 

        @type input: C{str} 

        @param args: list of arguments 

        @type args: C{list} 

        @param extra_env: extra environment variables to pass 

        @type extra_env: C{dict} 

        @param capture_stderr: whether to capture stderr 

        @type capture_stderr: C{bool} 

        @return: stdout, stderr, return code 

        @rtype: C{tuple} of C{str}, C{str}, C{int} 

        """ 

        if not cwd: 

            cwd = self.path 

 

        stderr_arg = subprocess.PIPE if capture_stderr else None 

 

        env = self.__build_env(extra_env) 

        cmd = ['git', command] + args 

        log.debug(cmd) 

        popen = subprocess.Popen(cmd, 

                                 stdin=subprocess.PIPE, 

                                 stdout=subprocess.PIPE, 

                                 stderr=stderr_arg, 

                                 env=env, 

                                 cwd=cwd) 

        (stdout, stderr) = popen.communicate(input) 

        return stdout, stderr, popen.returncode 

 

    def _git_command(self, command, args=[], extra_env=None): 

        """ 

        Execute git command with arguments args and environment env 

        at path. 

 

        @param command: git command 

        @type command: C{str} 

        @param args: command line arguments 

        @type args: C{list} 

        @param extra_env: extra environment variables to set when running command 

        @type extra_env: C{dict} 

        """ 

        try: 

            GitCommand(command, args, extra_env=extra_env, cwd=self.path)() 

        except CommandExecFailed as excobj: 

            raise GitRepositoryError("Error running git %s: %s" % 

                                     (command, excobj)) 

 

    def _cmd_has_feature(self, command, feature): 

        """ 

        Check if the git command has certain feature enabled. 

 

        @param command: git command 

        @type command: C{str} 

        @param feature: feature / command option to check 

        @type feature: C{str} 

        @return: True if feature is supported 

        @rtype: C{bool} 

        """ 

        args = GitArgs(command, '-m') 

        help, foo, ret = self._git_inout('help', args.args) 

        if ret: 

            raise GitRepositoryError("Invalid git command: %s" % command) 

 

        # Parse git command man page 

        section_re = re.compile(r'^(?P<section>[A-Z].*)') 

        option_re = re.compile(r'--?(?P<name>[a-zA-Z\-]+).*') 

        man_section = None 

        for line in help.splitlines(): 

            if man_section == "OPTIONS" and line.startswith('       -'): 

                opts = line.split(',') 

                for opt in opts: 

                    match = option_re.match(opt.strip()) 

                    if match and match.group('name') == feature: 

                        return True 

            # Check man section 

            match = section_re.match(line) 

            if match: 

                man_section = match.group('section') 

        return False 

 

    @property 

    def path(self): 

        """The absolute path to the repository""" 

        return self._path 

 

    @property 

    def git_dir(self): 

        """The absolute path to git's metadata""" 

        return os.path.join(self.path, self._git_dir) 

 

    @property 

    def bare(self): 

        """Wheter this is a bare repository""" 

        return self._bare 

 

    @property 

    def tags(self): 

        """List of all tags in the repository""" 

        return self.get_tags() 

 

    @property 

    def branch(self): 

        """The currently checked out branch""" 

        try: 

            return self.get_branch() 

        except GitRepositoryError: 

            return None 

 

    @property 

    def head(self): 

        """return the SHA1 of the current HEAD""" 

        return self.rev_parse('HEAD') 

 

#{ Branches and Merging 

    def rename_branch(self, branch, newbranch): 

        """ 

        Rename branch 

 

        @param branch: name of the branch to be renamed 

        @param newbranch: new name of the branch 

        """ 

        args = GitArgs("-m", branch, newbranch) 

        self._git_command("branch", args.args) 

 

    def create_branch(self, branch, rev=None): 

        """ 

        Create a new branch 

 

        @param branch: the branch's name 

        @param rev: where to start the branch from 

 

        If rev is None the branch starts form the current HEAD. 

        """ 

        args = GitArgs(branch) 

        args.add_true(rev, rev) 

        self._git_command("branch", args.args) 

 

    def delete_branch(self, branch, remote=False): 

        """ 

        Delete branch I{branch} 

 

        @param branch: name of the branch to delete 

        @type branch: C{str} 

        @param remote: delete a remote branch 

        @param remote: C{bool} 

        """ 

        args = GitArgs('-D') 

        args.add_true(remote, '-r') 

        args.add(branch) 

 

        if self.branch != branch: 

            self._git_command("branch", args.args) 

        else: 

            raise GitRepositoryError("Can't delete the branch you're on") 

 

    def get_branch(self): 

        """ 

        On what branch is the current working copy 

 

        @return: current branch 

        @rtype: C{str} 

        """ 

        out, ret = self._git_getoutput('symbolic-ref', [ 'HEAD' ]) 

        if ret: 

            raise GitRepositoryError("Currently not on a branch") 

 

        ref = out[0][:-1] 

        # Check if ref really exists 

        failed = self._git_getoutput('show-ref', [ ref ])[1] 

        if not failed: 

            return ref[11:] # strip /refs/heads 

 

    def has_branch(self, branch, remote=False): 

        """ 

        Check if the repository has branch named I{branch}. 

 

        @param branch: branch to look for 

        @param remote: only look for remote branches 

        @type remote: C{bool} 

        @return: C{True} if the repository has this branch, C{False} otherwise 

        @rtype: C{bool} 

        """ 

        if remote: 

            ref = 'refs/remotes/%s' % branch 

        else: 

            ref = 'refs/heads/%s' % branch 

        failed = self._git_getoutput('show-ref', [ ref ])[1] 

        if failed: 

            return False 

        return True 

 

    def set_branch(self, branch): 

        """ 

        Switch to branch I{branch} 

 

        @param branch: name of the branch to switch to 

        @type branch: C{str} 

        """ 

        if self.branch == branch: 

            return 

 

        if self.bare: 

            self._git_command("symbolic-ref", 

                              [ 'HEAD', 'refs/heads/%s' % branch ]) 

        else: 

            self._git_command("checkout", [ branch ]) 

 

    def get_merge_branch(self, branch): 

        """ 

        Get the branch we'd merge from 

 

        @return: repo and branch we would merge from 

        @rtype: C{str} 

        """ 

        try: 

            remote = self.get_config("branch.%s.remote" % branch) 

            merge = self.get_config("branch.%s.merge" % branch) 

        except KeyError: 

            return None 

        remote += merge.replace("refs/heads","", 1) 

        return remote 

 

    def get_merge_base(self, commit1, commit2): 

        """ 

        Get the common ancestor between two commits 

 

        @param commit1: commit SHA1 or name of a branch or tag 

        @type commit1: C{str} 

        @param commit2: commit SHA1 or name of a branch or tag 

        @type commit2: C{str} 

        @return: SHA1 of the common ancestor 

        @rtype: C{str} 

        """ 

        args = GitArgs() 

        args.add(commit1) 

        args.add(commit2) 

        sha1, stderr, ret = self._git_inout('merge-base', args.args, capture_stderr=True) 

        if not ret: 

            return self.strip_sha1(sha1) 

        else: 

            raise GitRepositoryError("Failed to get common ancestor: %s" % stderr.strip()) 

 

    def merge(self, commit, verbose=False, edit=False): 

        """ 

        Merge changes from the named commit into the current branch 

 

        @param commit: the commit to merge from (usually a branch name or tag) 

        @type commit: C{str} 

        @param verbose: whether to print a summary after the merge 

        @type verbose: C{bool} 

        @param edit: wheter to invoke an editor to edit the merge message 

        @type edit: C{bool} 

        """ 

        args = GitArgs() 

        args.add_cond(verbose, '--summary', '--no-summary') 

        if (self._cmd_has_feature('merge', 'edit')): 

            args.add_cond(edit, '--edit', '--no-edit') 

        else: 

            log.debug("Your git suite doesn't support --edit/--no-edit " 

                      "option for git-merge ") 

        args.add(commit) 

        self._git_command("merge", args.args) 

 

    def is_fast_forward(self, from_branch, to_branch): 

        """ 

        Check if an update I{from from_branch} to I{to_branch} would be a fast 

        forward or if the branch is up to date already. 

 

        @return: can_fast_forward, up_to_date 

        @rtype: C{tuple} 

        """ 

        has_local = False       # local repo has new commits 

        has_remote = False      # remote repo has new commits 

        out = self._git_getoutput('rev-list', ["--left-right", 

                                   "%s...%s" % (from_branch, to_branch), 

                                   "--"])[0] 

 

        if not out: # both branches have the same commits 

            return True, True 

 

        for line in out: 

            if line.startswith("<"): 

                has_local = True 

            elif line.startswith(">"): 

                has_remote = True 

 

        if has_local and has_remote: 

            return False, False 

        elif has_local: 

            return False, True 

        elif has_remote: 

            return True, False 

 

    def _get_branches(self, remote=False): 

        """ 

        Get a list of branches 

 

        @param remote: whether to list local or remote branches 

        @type remote: C{bool} 

        @return: local or remote branches 

        @rtype: C{list} 

        """ 

        args = [ '--format=%(refname:short)' ] 

        args += [ 'refs/remotes/' ] if remote else [ 'refs/heads/' ] 

        out = self._git_getoutput('for-each-ref', args)[0] 

        return [ ref.strip() for ref in out ] 

 

    def get_local_branches(self): 

        """ 

        Get a list of local branches 

 

        @return: local branches 

        @rtype: C{list} 

        """ 

        return self._get_branches(remote=False) 

 

 

    def get_remote_branches(self): 

        """ 

        Get a list of remote branches 

 

        @return: remote branches 

        @rtype: C{list} 

        """ 

        return self._get_branches(remote=True) 

 

    def update_ref(self, ref, new, old=None, msg=None): 

        """ 

        Update ref I{ref} to commit I{new} if I{ref} currently points to 

        I{old} 

 

        @param ref: the ref to update 

        @type ref: C{str} 

        @param new: the new value for ref 

        @type new: C{str} 

        @param old: the old value of ref 

        @type old: C{str} 

        @param msg: the reason for the update 

        @type msg: C{str} 

        """ 

        args = [ ref, new ] 

        if old: 

            args += [ old ] 

        if msg: 

            args = [ '-m', msg ] + args 

        self._git_command("update-ref", args) 

 

    def branch_contains(self, branch, commit, remote=False): 

        """ 

        Check if branch I{branch} contains commit I{commit} 

 

        @param branch: the branch the commit should be on 

        @type branch: C{str} 

        @param commit: the C{str} commit to check 

        @type commit: C{str} 

        @param remote: whether to check remote instead of local branches 

        @type remote: C{bool} 

        """ 

        args = GitArgs() 

        args.add_true(remote, '-r') 

        args.add('--contains') 

        args.add(commit) 

 

        out, ret =  self._git_getoutput('branch', args.args) 

        for line in out: 

            # remove prefix '*' for current branch before comparing 

            line = line.replace('*', '') 

            if line.strip() == branch: 

                return True 

        return False 

 

    def set_upstream_branch(self, local_branch, upstream): 

        """ 

        Set upstream branches for local branch 

 

        @param local_branch: name of the local branch 

        @type local_branch: C{str} 

        @param upstream: remote/branch, for example origin/master 

        @type upstream: C{str} 

        """ 

 

        # check if both branches exist 

        for branch, remote in [(local_branch, False), (upstream, True)]: 

            if not self.has_branch(branch, remote=remote): 

                raise GitRepositoryError("Branch %s doesn't exist!" % branch) 

 

            self._git_getoutput('branch', ["--set-upstream", local_branch, upstream]) 

 

 

    def get_upstream_branch(self, local_branch): 

        """ 

        Get upstream branch for the local branch 

 

        @param local_branch: name fo the local branch 

        @type local_branch: C{str} 

        @return: upstream (remote/branch) or  '' if no upstream found 

        @rtype: C{str} 

 

        """ 

        args = GitArgs('--format=%(upstream:short)') 

        if self.has_branch(local_branch, remote=False): 

            args.add('refs/heads/%s' % local_branch) 

        else: 

            raise GitRepositoryError("Branch %s doesn't exist!" % local_branch) 

 

        out = self._git_getoutput('for-each-ref', args.args)[0] 

 

        return out[0].strip() 

 

#{ Tags 

 

    def create_tag(self, name, msg=None, commit=None, sign=False, keyid=None): 

        """ 

        Create a new tag. 

 

        @param name: the tag's name 

        @type name: C{str} 

        @param msg: The tag message. 

        @type msg: C{str} 

        @param commit: the commit or object to create the tag at, default 

            is I{HEAD} 

        @type commit: C{str} 

        @param sign: Whether to sing the tag 

        @type sign: C{bool} 

        @param keyid: the GPG keyid used to sign the tag 

        @type keyid: C{str} 

        """ 

        args = [] 

        args += [ '-m', msg ] if msg else [] 

        if sign: 

            args += [ '-s' ] 

            args += [ '-u', keyid ] if keyid else [] 

        args += [ name ] 

        args += [ commit ] if commit else [] 

        self._git_command("tag", args) 

 

    def delete_tag(self, tag): 

        """ 

        Delete a tag named I{tag} 

 

        @param tag: the tag to delete 

        @type tag: C{str} 

        """ 

        if self.has_tag(tag): 

            self._git_command("tag", [ "-d", tag ]) 

 

    def move_tag(self, old, new): 

        self._git_command("tag", [ new, old ]) 

        self.delete_tag(old) 

 

    def has_tag(self, tag): 

        """ 

        Check if the repository has a tag named I{tag}. 

 

        @param tag: tag to look for 

        @type tag: C{str} 

        @return: C{True} if the repository has that tag, C{False} otherwise 

        @rtype: C{bool} 

        """ 

        out, ret = self._git_getoutput('tag', [ '-l', tag ]) 

        return [ False, True ][len(out)] 

 

    def find_tag(self, commit, pattern=None): 

        """ 

        Find the closest tag to a given commit 

 

        @param commit: the commit to describe 

        @type commit: C{str} 

        @param pattern: only look for tags matching I{pattern} 

        @type pattern: C{str} 

        @return: the found tag 

        @rtype: C{str} 

        """ 

        args =  [ '--abbrev=0' ] 

        if pattern: 

            args += [ '--match' , pattern ] 

        args += [ commit ] 

 

        tag, err, ret = self._git_inout('describe', args, capture_stderr=True) 

        if ret: 

            raise GitRepositoryError("Can't find tag for %s. Git error: %s" % \ 

                                         (commit, err.strip())) 

        return tag.strip() 

 

    def get_tags(self, pattern=None): 

        """ 

        List tags 

 

        @param pattern: only list tags matching I{pattern} 

        @type pattern: C{str} 

        @return: tags 

        @rtype: C{list} of C{str} 

        """ 

        args = [ '-l', pattern ] if pattern else [] 

        return [ line.strip() for line in self._git_getoutput('tag', args)[0] ] 

 

    def verify_tag(self, tag): 

        """ 

        Verify a signed tag 

 

        @param tag: the tag's name 

        @type tag: C{str} 

        @return: Whether the signature on the tag could be verified 

        @rtype: C{bool} 

        """ 

        args = GitArgs('-v', tag) 

 

        try: 

            self._git_command('tag', args.args) 

        except GitRepositoryError: 

            return False 

        return True 

 

#} 

    def force_head(self, commit, hard=False): 

        """ 

        Force HEAD to a specific commit 

 

        @param commit: commit to move HEAD to 

        @param hard: also update the working copy 

        @type hard: C{bool} 

        """ 

        if not GitCommit.is_sha1(commit): 

            commit = self.rev_parse(commit) 

 

        if self.bare: 

            ref = "refs/heads/%s" % self.get_branch() 

            self._git_command("update-ref", [ ref, commit ]) 

        else: 

            args = ['--quiet'] 

            if hard: 

                args += [ '--hard' ] 

            args += [ commit, '--' ] 

            self._git_command("reset", args) 

 

    def is_clean(self, ignore_untracked=False): 

        """ 

        Does the repository contain any uncommitted modifications? 

 

        @param ignore_untracked: whether to ignore untracked files when 

            checking the repository status 

        @type ignore_untracked: C{bool} 

        @return: C{True} if the repository is clean, C{False} otherwise 

            and Git's status message 

        @rtype: C{tuple} 

        """ 

        if self.bare: 

            return (True, '') 

 

        clean_msg = 'nothing to commit' 

 

        args = GitArgs() 

        args.add_true(ignore_untracked, '-uno') 

 

        out, ret = self._git_getoutput('status', 

                                       args.args, 

                                       extra_env={'LC_ALL': 'C'}) 

        if ret: 

            raise GbpError("Can't get repository status") 

        ret = False 

        for line in out: 

            if line.startswith('#'): 

                continue 

            if line.startswith(clean_msg): 

                ret = True 

            break 

        return (ret, "".join(out)) 

 

    def is_empty(self): 

        """ 

        Is the repository empty? 

 

        @return: True if the repositorydoesn't have any commits, 

            False otherwise 

        @rtype: C{bool} 

        """ 

        # an empty repo has no branches: 

        return False if self.branch else True 

 

    def rev_parse(self, name, short=0): 

        """ 

        Find the SHA1 of a given name 

 

        @param name: the name to look for 

        @type name: C{str} 

        @param short:  try to abbreviate SHA1 to given length 

        @type short: C{int} 

        @return: the name's sha1 

        @rtype: C{str} 

        """ 

        args = GitArgs("--quiet", "--verify") 

        args.add_cond(short, '--short=%d' % short) 

        args.add(name) 

        sha, ret = self._git_getoutput('rev-parse', args.args) 

        if ret: 

            raise GitRepositoryError("revision '%s' not found" % name) 

        return self.strip_sha1(sha[0], short) 

 

    @staticmethod 

    def strip_sha1(sha1, length=0): 

        """ 

        Strip a given sha1 and check if the resulting 

        hash has the expected length. 

 

        >>> GitRepository.strip_sha1('  58ef37dbeb12c44b206b92f746385a6f61253c0a\\n') 

        '58ef37dbeb12c44b206b92f746385a6f61253c0a' 

        >>> GitRepository.strip_sha1('58ef37d', 10) 

        Traceback (most recent call last): 

        ... 

        GitRepositoryError: '58ef37d' is not a valid sha1 of length 10 

        >>> GitRepository.strip_sha1('58ef37d', 7) 

        '58ef37d' 

        >>> GitRepository.strip_sha1('123456789', 7) 

        '123456789' 

        >>> GitRepository.strip_sha1('foobar') 

        Traceback (most recent call last): 

        ... 

        GitRepositoryError: 'foobar' is not a valid sha1 

        """ 

        maxlen = 40 

        s = sha1.strip() 

 

        l = length or maxlen 

 

        if len(s) < l or len(s) > maxlen: 

            raise GitRepositoryError("'%s' is not a valid sha1%s" % 

                                     (s, " of length %d" % l if length else "")) 

        return s 

 

#{ Trees 

    def checkout(self, treeish): 

        """ 

        Checkout treeish 

 

        @param treeish: the treeish to check out 

        @type treeish: C{str} 

        """ 

        self._git_command("checkout", ["--quiet", treeish]) 

 

    def has_treeish(self, treeish): 

        """ 

        Check if the repository has the treeish object I{treeish}. 

 

        @param treeish: treeish object to look for 

        @type treeish: C{str} 

        @return: C{True} if the repository has that tree, C{False} otherwise 

        @rtype: C{bool} 

        """ 

        out, ret =  self._git_getoutput('ls-tree', [ treeish ]) 

        return [ True, False ][ret != 0] 

 

    def write_tree(self, index_file=None): 

        """ 

        Create a tree object from the current index 

 

        @param index_file: alternate index file to read changes from 

        @type index_file: C{str} 

        @return: the new tree object's sha1 

        @rtype: C{str} 

        """ 

        if index_file: 

            extra_env = {'GIT_INDEX_FILE': index_file } 

        else: 

            extra_env = None 

 

        tree, ret = self._git_getoutput('write-tree', extra_env=extra_env) 

        if ret: 

            raise GitRepositoryError("Can't write out current index") 

        return tree[0].strip() 

 

    def make_tree(self, contents): 

        """ 

        Create a tree based on contents. I{contents} has the same format than 

        the I{GitRepository.list_tree} output. 

        """ 

        out='' 

        args = GitArgs('-z') 

 

        for obj in contents: 

             mode, type, sha1, name = obj 

             out += '%s %s %s\t%s\0' % (mode, type, sha1, name) 

 

        sha1, err, ret =  self._git_inout('mktree', 

                                          args.args, 

                                          out, 

                                          capture_stderr=True) 

        if ret: 

            raise GitRepositoryError("Failed to mktree: '%s'" % err) 

        return self.strip_sha1(sha1) 

 

    def get_obj_type(self, obj): 

        """ 

        Get type of a git repository object 

 

        @param obj: repository object 

        @type obj: C{str} 

        @return: type of the repository object 

        @rtype: C{str} 

        """ 

        out, ret = self._git_getoutput('cat-file', args=['-t', obj]) 

        if ret: 

            raise GitRepositoryError("Not a Git repository object: '%s'" % obj) 

        return out[0].strip() 

 

    def list_tree(self, treeish, recurse=False): 

        """ 

        Get a trees content. It returns a list of objects that match the 

        'ls-tree' output: [ mode, type, sha1, path ]. 

 

        @param treeish: the treeish object to list 

        @type treeish: C{str} 

        @param recurse: whether to list the tree recursively 

        @type recurse: C{bool} 

        @return: the tree 

        @rtype: C{list} of objects. See above. 

        """ 

        args = GitArgs('-z') 

        args.add_true(recurse, '-r') 

        args.add(treeish) 

 

        out, err, ret =  self._git_inout('ls-tree', args.args, capture_stderr=True) 

        if ret: 

            raise GitRepositoryError("Failed to ls-tree '%s': '%s'" % (treeish, err)) 

 

        tree = [] 

        for line in out.split('\0'): 

            if line: 

                tree.append(line.split(None, 3)) 

        return tree 

 

#} 

 

    def get_config(self, name): 

        """ 

        Gets the config value associated with I{name} 

 

        @param name: config value to get 

        @return: fetched config value 

        @rtype: C{str} 

        """ 

        value, ret = self._git_getoutput('config', [ name ]) 

        if ret: raise KeyError 

        return value[0][:-1] # first line with \n ending removed 

 

    def get_author_info(self): 

        """ 

        Determine a sane values for author name and author email from git's 

        config and environment variables. 

 

        @return: name and email 

        @rtype: L{GitModifier} 

        """ 

        try: 

           name =  self.get_config("user.name") 

        except KeyError: 

           name = os.getenv("USER") 

        try: 

           email =  self.get_config("user.email") 

        except KeyError: 

            email = os.getenv("EMAIL") 

        email = os.getenv("GIT_AUTHOR_EMAIL", email) 

        name = os.getenv("GIT_AUTHOR_NAME", name) 

        return GitModifier(name, email) 

 

#{ Remote Repositories 

 

    def get_remote_repos(self): 

        """ 

        Get all remote repositories 

 

        @return: remote repositories 

        @rtype: C{list} of C{str} 

        """ 

        out = self._git_getoutput('remote')[0] 

        return [ remote.strip() for remote in out ] 

 

    def has_remote_repo(self, name): 

        """ 

        Do we know about a remote named I{name}? 

 

        @param name: name of the remote repository 

        @type name: C{str} 

        @return: C{True} if the remote repositore is known, C{False} otherwise 

        @rtype: C{bool} 

        """ 

        if name in self.get_remote_repos(): 

            return True 

        else: 

            return False 

 

    def add_remote_repo(self, name, url, tags=True, fetch=False): 

        """ 

        Add a tracked remote repository 

 

        @param name: the name to use for the remote 

        @type name: C{str} 

        @param url: the url to add 

        @type url: C{str} 

        @param tags: whether to fetch tags 

        @type tags: C{bool} 

        @param fetch: whether to fetch immediately from the remote side 

        @type fetch: C{bool} 

        """ 

        args = GitArgs('add') 

        args.add_false(tags, '--no-tags') 

        args.add_true(fetch, '--fetch') 

        args.add(name, url) 

        self._git_command("remote", args.args) 

 

    def remove_remote_repo(self, name): 

        args = GitArgs('rm', name) 

        self._git_command("remote", args.args) 

 

    def fetch(self, repo=None, tags=False, depth=0): 

        """ 

        Download objects and refs from another repository. 

 

        @param repo: repository to fetch from 

        @type repo: C{str} 

        @param tags: whether to fetch all tag objects 

        @type tags: C{bool} 

        @param depth: deepen the history of (shallow) repository to depth I{depth} 

        @type depth: C{int} 

        """ 

        args = GitArgs('--quiet') 

        args.add_true(tags, '--tags') 

        args.add_cond(depth, '--depth=%s' % depth) 

        args.add_cond(repo, repo) 

 

        self._git_command("fetch", args.args) 

 

    def pull(self, repo=None, ff_only=False): 

        """ 

        Fetch and merge from another repository 

 

        @param repo: repository to fetch from 

        @type repo: C{str} 

        @param ff_only: only merge if this results in a fast forward merge 

        @type ff_only: C{bool} 

        """ 

        args = [] 

        args += [ '--ff-only' ] if ff_only else [] 

        args += [ repo ] if repo else [] 

        self._git_command("pull", args) 

 

    def push(self, repo=None, src=None, dst=None, ff_only=True): 

        """ 

        Push changes to the remote repo 

 

        @param repo: repository to push to 

        @type repo: C{str} 

        @param src: the source ref to push 

        @type src: C{str} 

        @param dst: the name of the destination ref to push to 

        @type dst: C{str} 

        @param ff_only: only push if it's a fast forward update 

        @type ff_only: C{bool} 

        """ 

        args = GitArgs() 

        args.add_cond(repo, repo) 

 

        # Allow for src == '' to delete dst on the remote 

        if src != None: 

            refspec = src 

            if dst: 

                refspec += ':%s' % dst 

            if not ff_only: 

                refspec = '+%s' % refspec 

            args.add(refspec) 

        self._git_command("push", args.args) 

 

    def push_tag(self, repo, tag): 

        """ 

        Push a tag to the remote repo 

 

        @param repo: repository to push to 

        @type repo: C{str} 

        @param tag: the name of the tag 

        @type tag: C{str} 

        """ 

        args = GitArgs(repo, 'tag', tag) 

        self._git_command("push", args.args) 

 

#{ Files 

 

    def add_files(self, paths, force=False, index_file=None, work_tree=None): 

        """ 

        Add files to a the repository 

 

        @param paths: list of files to add 

        @type paths: list or C{str} 

        @param force: add files even if they would be ignored by .gitignore 

        @type force: C{bool} 

        @param index_file: alternative index file to use 

        @param work_tree: alternative working tree to use 

        """ 

        extra_env = {} 

 

        if isinstance(paths, basestring): 

            paths = [ paths ] 

 

        args = [ '-f' ] if force else [] 

 

        if index_file: 

            extra_env['GIT_INDEX_FILE'] =  index_file 

 

        if work_tree: 

            extra_env['GIT_WORK_TREE'] = work_tree 

 

        self._git_command("add", args + paths, extra_env) 

 

    def remove_files(self, paths, verbose=False): 

        """ 

        Remove files from the repository 

 

        @param paths: list of files to remove 

        @param paths: C{list} or C{str} 

        @param verbose: be verbose 

        @type verbose: C{bool} 

        """ 

        if isinstance(paths, basestring): 

            paths = [ paths ] 

 

        args =  [] if verbose else ['--quiet'] 

        self._git_command("rm", args + paths) 

 

    def list_files(self, types=['cached']): 

        """ 

        List files in index and working tree 

 

        @param types: list of types to show 

        @type types: C{list} 

        @return: list of files 

        @rtype: C{list} of C{str} 

        """ 

        all_types = [ 'cached', 'deleted', 'others', 'ignored',  'stage' 

                      'unmerged', 'killed', 'modified' ] 

        args = [ '-z' ] 

 

        for t in types: 

            if t in all_types: 

                args += [ '--%s' % t ] 

            else: 

                raise GitRepositoryError("Unknown type '%s'" % t) 

        out, ret = self._git_getoutput('ls-files', args) 

        if ret: 

            raise GitRepositoryError("Error listing files: '%d'" % ret) 

        if out: 

            return [ file for file in out[0].split('\0') if file ] 

        else: 

            return [] 

 

 

    def write_file(self, filename, filters=True): 

        """ 

        Hash a single file and write it into the object database 

 

        @param filename: the filename to the content of the file to hash 

        @type filename: C{str} 

        @param filters: whether to run filters 

        @type filters: C{bool} 

        @return: the hash of the file 

        @rtype: C{str} 

        """ 

        args = GitArgs('-w', '-t', 'blob') 

        args.add_false(filters, '--no-filters') 

        args.add(filename) 

 

        sha1, stderr, ret = self._git_inout('hash-object', 

                                            args.args, 

                                            capture_stderr=True) 

        if not ret: 

            return self.strip_sha1(sha1) 

        else: 

            raise GbpError("Failed to hash %s: %s" % (filename, stderr)) 

#} 

 

#{ Comitting 

 

    def _commit(self, msg, args=[], author_info=None): 

        extra_env = author_info.get_author_env() if author_info else None 

        self._git_command("commit", ['-q', '-m', msg] + args, extra_env=extra_env) 

 

    def commit_staged(self, msg, author_info=None, edit=False): 

        """ 

        Commit currently staged files to the repository 

 

        @param msg: commit message 

        @type msg: C{str} 

        @param author_info: authorship information 

        @type author_info: L{GitModifier} 

        @param edit: whether to spawn an editor to edit the commit info 

        @type edit: C{bool} 

        """ 

        args = GitArgs() 

        args.add_true(edit,  '--edit') 

        self._commit(msg=msg, args=args.args, author_info=author_info) 

 

    def commit_all(self, msg, author_info=None, edit=False): 

        """ 

        Commit all changes to the repository 

        @param msg: commit message 

        @type msg: C{str} 

        @param author_info: authorship information 

        @type author_info: L{GitModifier} 

        """ 

        args = GitArgs('-a') 

        args.add_true(edit,  '--edit') 

        self._commit(msg=msg, args=args.args, author_info=author_info) 

 

    def commit_files(self, files, msg, author_info=None): 

        """ 

        Commit the given files to the repository 

 

        @param files: file or files to commit 

        @type files: C{str} or C{list} 

        @param msg: commit message 

        @type msg: C{str} 

        @param author_info: authorship information 

        @type author_info: L{GitModifier} 

        """ 

        if isinstance(files, basestring): 

            files = [ files ] 

        self._commit(msg=msg, args=files, author_info=author_info) 

 

    def commit_dir(self, unpack_dir, msg, branch, other_parents=None, 

                   author={}, committer={}, create_missing_branch=False): 

        """ 

        Replace the current tip of branch I{branch} with the contents from I{unpack_dir} 

 

        @param unpack_dir: content to add 

        @type unpack_dir: C{str} 

        @param msg: commit message to use 

        @type msg: C{str} 

        @param branch: branch to add the contents of unpack_dir to 

        @type branch: C{str} 

        @param other_parents: additional parents of this commit 

        @type other_parents: C{list} of C{str} 

        @param author: author information to use for commit 

        @type author: C{dict} with keys I{name}, I{email}, I{date} 

        @param committer: committer information to use for commit 

        @type committer: C{dict} with keys I{name}, I{email}, I{date} 

            or L{GitModifier} 

        @param create_missing_branch: create I{branch} as detached branch if it 

            doesn't already exist. 

        @type create_missing_branch: C{bool} 

        """ 

 

        git_index_file = os.path.join(self.path, self._git_dir, 'gbp_index') 

        try: 

            os.unlink(git_index_file) 

        except OSError: 

            pass 

        self.add_files('.', force=True, index_file=git_index_file, 

                       work_tree=unpack_dir) 

        tree = self.write_tree(git_index_file) 

 

        if branch: 

            try: 

                cur = self.rev_parse(branch) 

            except GitRepositoryError: 

                if create_missing_branch: 

                    log.debug("Will create missing branch '%s'..." % branch) 

                    cur = None 

                else: 

                    raise 

        else: # emtpy repo 

            cur = None 

            branch = 'master' 

 

        # Build list of parents: 

        parents = [] 

        if cur: 

            parents = [ cur ] 

        if other_parents: 

            for parent in other_parents: 

                sha = self.rev_parse(parent) 

                if sha not in parents: 

                    parents += [ sha ] 

 

        commit = self.commit_tree(tree=tree, msg=msg, parents=parents, 

                                  author=author, committer=committer) 

        if not commit: 

            raise GbpError("Failed to commit tree") 

        self.update_ref("refs/heads/%s" % branch, commit, cur) 

        return commit 

 

    def commit_tree(self, tree, msg, parents, author={}, committer={}): 

        """ 

        Commit a tree with commit msg I{msg} and parents I{parents} 

 

        @param tree: tree to commit 

        @param msg: commit message 

        @param parents: parents of this commit 

        @param author: authorship information 

        @type author: C{dict} with keys 'name' and 'email' or L{GitModifier} 

        @param committer: comitter information 

        @type committer: C{dict} with keys 'name' and 'email' 

        """ 

        extra_env = {} 

        for key, val in author.items(): 

            if val: 

                extra_env['GIT_AUTHOR_%s' % key.upper()] = val 

        for key, val in committer.items(): 

            if val: 

                extra_env['GIT_COMMITTER_%s' % key.upper()] = val 

 

        args = [ tree ] 

        for parent in parents: 

            args += [ '-p' , parent ] 

        sha1, stderr, ret = self._git_inout('commit-tree', 

                                            args, 

                                            msg, 

                                            extra_env, 

                                            capture_stderr=True) 

        if not ret: 

            return self.strip_sha1(sha1) 

        else: 

            raise GbpError("Failed to commit tree: %s" % stderr) 

 

#{ Commit Information 

 

    def get_commits(self, since=None, until=None, paths=None, num=0, 

                    first_parent=False, options=None): 

        """ 

        Get commits from since to until touching paths 

 

        @param since: commit to start from 

        @type since: C{str} 

        @param until: last commit to get 

        @type until: C{str} 

        @param paths: only list commits touching paths 

        @type paths: C{list} of C{str} 

        @param num: maximum number of commits to fetch 

        @type num: C{int} 

        @param options: list of additional options passed to git log 

        @type  options: C{list} of C{str}ings 

        @param first_parent: only follow first parent when seeing a 

                             merge commit 

        @type first_parent: C{bool} 

        """ 

        args = GitArgs('--pretty=format:%H') 

        args.add_true(num, '-%d' % num) 

        args.add_true(first_parent, '--first-parent') 

        if since: 

            args.add("%s..%s" % (since, until or 'HEAD')) 

        elif until: 

            args.add(until) 

        args.add_cond(options, options) 

        args.add("--") 

        if isinstance(paths, basestring): 

            paths = [ paths ] 

        args.add_cond(paths, paths) 

 

        commits, ret = self._git_getoutput('log', args.args) 

        if ret: 

            where = " on %s" % paths if paths else "" 

            raise GitRepositoryError("Error getting commits %s..%s%s" % 

                        (since, until, where)) 

        return [ commit.strip() for commit in commits ] 

 

    def show(self, id): 

        """git-show id""" 

        commit, ret = self._git_getoutput('show', [ "--pretty=medium", id ]) 

        if ret: 

            raise GitRepositoryError("can't get %s" % id) 

        for line in commit: 

            yield line 

 

    def grep_log(self, regex, since=None): 

        """ 

        Get commmits matching I{regex} 

 

        @param regex: regular expression 

        @type regex: C{str} 

        @param since: where to start grepping (e.g. a branch) 

        @type since: C{str} 

        """ 

        args = ['--pretty=format:%H'] 

        args.append("--grep=%s" % regex) 

        if since: 

            args.append(since) 

        args.append('--') 

 

        commits, ret = self._git_getoutput('log', args) 

        if ret: 

            raise GitRepositoryError("Error grepping log for %s" % regex) 

        return [ commit.strip() for commit in commits[::-1] ] 

 

    def get_subject(self, commit): 

        """ 

        Gets the subject of a commit. 

 

        @param commit: the commit to get the subject from 

        @return: the commit's subject 

        @rtype: C{str} 

        """ 

        out, ret =  self._git_getoutput('log', ['-n1', '--pretty=format:%s',  commit]) 

        if ret: 

            raise GitRepositoryError("Error getting subject of commit %s" 

                                     % commit) 

        return out[0].strip() 

 

    def get_commit_info(self, commitish): 

        """ 

        Look up data of a specific commit-ish. Dereferences given commit-ish 

        to the commit it points to. 

 

        @param commitish: the commit-ish to inspect 

        @return: the commit's including id, author, email, subject and body 

        @rtype: dict 

        """ 

        commit_sha1 = self.rev_parse("%s^0" % commitish) 

        args = GitArgs('--pretty=format:%an%x00%ae%x00%ad%x00%cn%x00%ce%x00%cd%x00%s%x00%b%x00', 

                       '-z', '--date=raw', '--name-status', commit_sha1) 

        out, err, ret =  self._git_inout('show', args.args) 

        if ret: 

            raise GitRepositoryError("Unable to retrieve commit info for %s" 

                                     % commitish) 

 

        fields = out.split('\x00') 

 

        author = GitModifier(fields[0].strip(), 

                             fields[1].strip(), 

                             fields[2].strip()) 

        committer = GitModifier(fields[3].strip(), 

                                fields[4].strip(), 

                                fields[5].strip()) 

 

        files = defaultdict(list) 

        file_fields = fields[8:] 

        # For some reason git returns one extra empty field for merge commits 

        if file_fields[0] == '': file_fields.pop(0) 

        while len(file_fields) and file_fields[0] != '': 

            status = file_fields.pop(0).strip() 

            path = file_fields.pop(0) 

            files[status].append(path) 

 

        return {'id' : commitish, 

                'author' : author, 

                'committer' : committer, 

                'subject' : fields[6], 

                'body' : fields[7], 

                'files' : files} 

 

#{ Patches 

    def format_patches(self, start, end, output_dir, signature=True, thread=None): 

        """ 

        Output the commits between start and end as patches in output_dir 

        """ 

        options = GitArgs('-N', '-k', 

                          '-o', output_dir) 

        options.add_cond(not signature, '--no-signature') 

        options.add('%s...%s' % (start, end)) 

        options.add_cond(thread, '--thread=%s' % thread, '--no-thread') 

 

        output, ret = self._git_getoutput('format-patch', options.args) 

        return [ line.strip() for line in output ] 

 

    def apply_patch(self, patch, index=True, context=None, strip=None): 

        """Apply a patch using git apply""" 

        args = [] 

        if context: 

            args += [ '-C', context ] 

        if index: 

            args.append("--index") 

        if strip != None: 

            args += [ '-p', str(strip) ] 

        args.append(patch) 

        self._git_command("apply", args) 

 

    def diff(self, obj1, obj2, paths=None): 

        """ 

        Diff two git repository objects 

 

        @param obj1: first object 

        @type obj1: C{str} 

        @param obj2: second object 

        @type obj2: C{str} 

        @param paths: List of paths to diff 

        @type paths: C{list} 

        @return: diff 

        @rtype: C{str} 

        """ 

        options = GitArgs(obj1, obj2) 

        if paths: 

            options.add('--', paths) 

        output, stderr, ret = self._git_inout('diff', options.args) 

        if ret: 

            raise GitRepositoryError("Git diff failed") 

        return output 

#} 

 

    def archive(self, format, prefix, output, treeish, **kwargs): 

        """ 

        Create an archive from a treeish 

 

        @param format: the type of archive to create, e.g. 'tar.gz' 

        @type format: C{str} 

        @param prefix: prefix to prepend to each filename in the archive 

        @type prefix: C{str} 

        @param output: the name of the archive to create 

        @type output: C{str} 

        @param treeish: the treeish to create the archive from 

        @type treeish: C{str} 

        @param kwargs: additional commandline options passed to git-archive 

        """ 

        args = [ '--format=%s' % format, '--prefix=%s' % prefix, 

                 '--output=%s' % output, treeish ] 

        out, ret = self._git_getoutput('archive', args, **kwargs) 

        if ret: 

            raise GitRepositoryError("Unable to archive %s" % treeish) 

 

    def collect_garbage(self, auto=False): 

        """ 

        Cleanup unnecessary files and optimize the local repository 

 

        param auto: only cleanup if required 

        param auto: C{bool} 

        """ 

        args = [ '--auto' ] if auto else [] 

        self._git_command("gc", args) 

 

#{ Submodules 

 

    def has_submodules(self): 

        """ 

        Does the repo have any submodules? 

 

        @return: C{True} if the repository has any submodules, C{False} 

            otherwise 

        @rtype: C{bool} 

        """ 

        if os.path.exists(os.path.join(self.path, '.gitmodules')): 

            return True 

        else: 

            return False 

 

 

    def add_submodule(self, repo_path): 

        """ 

        Add a submodule 

 

        @param repo_path: path to submodule 

        @type repo_path: C{str} 

        """ 

        self._git_command("submodule", [ "add", repo_path ]) 

 

 

    def update_submodules(self, init=True, recursive=True, fetch=False): 

        """ 

        Update all submodules 

 

        @param init: whether to initialize the submodule if necessary 

        @type init: C{bool} 

        @param recursive: whether to update submodules recursively 

        @type recursive: C{bool} 

        @param fetch: whether to fetch new objects 

        @type fetch: C{bool} 

        """ 

 

        if not self.has_submodules(): 

            return 

        args = [ "update" ] 

        if recursive: 

            args.append("--recursive") 

        if init: 

            args.append("--init") 

        if not fetch: 

            args.append("--no-fetch") 

 

        self._git_command("submodule", args) 

 

 

    def get_submodules(self, treeish, path=None, recursive=True): 

        """ 

        List the submodules of treeish 

 

        @return: a list of submodule/commit-id tuples 

        @rtype: list of tuples 

        """ 

        # Note that we is lstree instead of submodule commands because 

        # there's no way to list the submodules of another branch with 

        # the latter. 

        submodules = [] 

        if path is None: 

            path = self.path 

 

        args = [ treeish ] 

        if recursive: 

            args += ['-r'] 

 

        out, ret =  self._git_getoutput('ls-tree', args, cwd=path) 

        for line in out: 

            mode, objtype, commit, name = line[:-1].split(None, 3) 

            # A submodules is shown as "commit" object in ls-tree: 

            if objtype == "commit": 

                nextpath = os.path.join(path, name) 

                submodules.append( (nextpath.replace(self.path,'').lstrip('/'), 

                                    commit) ) 

                if recursive: 

                    submodules += self.get_submodules(commit, path=nextpath, 

                                                      recursive=recursive) 

        return submodules 

 

#{ Repository Creation 

 

    @classmethod 

    def create(klass, path, description=None, bare=False): 

        """ 

        Create a repository at path 

 

        @param path: where to create the repository 

        @type path: C{str} 

        @param bare: whether to create a bare repository 

        @type bare: C{bool} 

        @return: git repository object 

        @rtype: L{GitRepository} 

        """ 

        args = GitArgs() 

        abspath = os.path.abspath(path) 

 

        args.add_true(bare, '--bare') 

        git_dir = '' if bare else '.git' 

 

        try: 

            if not os.path.exists(abspath): 

                os.makedirs(abspath) 

            try: 

                GitCommand("init", args.args, cwd=abspath)() 

            except CommandExecFailed as excobj: 

                raise GitRepositoryError("Error running git init: %s" % excobj) 

 

            if description: 

                with file(os.path.join(abspath, git_dir, "description"), 'w') as f: 

                    description += '\n' if description[-1] != '\n' else '' 

                    f.write(description) 

            return klass(abspath) 

        except OSError as err: 

            raise GitRepositoryError("Cannot create Git repository at '%s': %s" 

                                     % (abspath, err[1])) 

        return None 

 

    @classmethod 

    def clone(klass, path, remote, depth=0, recursive=False, mirror=False, 

              bare=False, auto_name=True): 

        """ 

        Clone a git repository at I{remote} to I{path}. 

 

        @param path: where to clone the repository to 

        @type path: C{str} 

        @param remote: URL to clone 

        @type remote: C{str} 

        @param depth: create a shallow clone of depth I{depth} 

        @type depth: C{int} 

        @param recursive: whether to clone submodules 

        @type recursive: C{bool} 

        @param mirror: whether to pass --mirror to git-clone 

        @type mirror: C{bool} 

        @param bare: whether to create a bare repository 

        @type bare: C{bool} 

        @param auto_name: If I{True} create a directory below I{path} based on 

            the I{remote}s name. Otherwise create the repo directly at I{path}. 

        @type auto_name: C{bool} 

        @return: git repository object 

        @rtype: L{GitRepository} 

        """ 

        abspath = os.path.abspath(path) 

        if auto_name: 

            name = None 

        else: 

            abspath, name = abspath.rsplit('/', 1) 

 

        args = GitArgs('--quiet') 

        args.add_true(depth,  '--depth', depth) 

        args.add_true(recursive, '--recursive') 

        args.add_true(mirror, '--mirror') 

        args.add_true(bare, '--bare') 

        args.add(remote) 

        args.add_true(name, name) 

        try: 

            if not os.path.exists(abspath): 

                os.makedirs(abspath) 

 

            try: 

                GitCommand("clone", args.args, cwd=abspath)() 

            except CommandExecFailed as excobj: 

                raise GitRepositoryError("Error running git clone: %s" % 

                                         excobj) 

 

            if not name: 

                name = remote.rstrip('/').rsplit('/',1)[1] 

                if (mirror or bare): 

                    if not name.endswith('.git'): 

                        name = "%s.git" % name 

                elif name.endswith('.git'): 

                    name = name[:-4] 

            return klass(os.path.join(abspath, name)) 

        except OSError as err: 

            raise GitRepositoryError("Cannot clone Git repository " 

                                     "'%s' to '%s': %s" 

                                     % (remote, abspath, err[1])) 

        return None 

#}