GitPython/git/diff.py at main · bondbox/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

# This module is part of GitPython and is released under the

# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

import re

from git.cmd import handle_process_output

from git.compat import defenc

from git.util import finalize_process, hex_to_bin

from .objects.blob import Blob

from .objects.util import mode_str_to_int

# typing ------------------------------------------------------------------

from typing import (

Any,

Iterator,

List,

Match,

Optional,

Tuple,

Type,

TypeVar,

Union,

TYPE_CHECKING,

cast,

)

from git.types import PathLike, Literal

if TYPE_CHECKING:

from .objects.tree import Tree

from .objects import Commit

from git.repo.base import Repo

from git.objects.base import IndexObject

from subprocess import Popen

from git import Git

Lit_change_type = Literal["A", "D", "C", "M", "R", "T", "U"]

# def is_change_type(inp: str) -> TypeGuard[Lit_change_type]:

# # return True

# return inp in ['A', 'D', 'C', 'M', 'R', 'T', 'U']

# ------------------------------------------------------------------------

__all__ = ("Diffable", "DiffIndex", "Diff", "NULL_TREE")

NULL_TREE = object()

"""Special object to compare against the empty tree in diffs."""

_octal_byte_re = re.compile(rb"\\([0-9]{3})")

def _octal_repl(matchobj: Match) -> bytes:

value = matchobj.group(1)

value = int(value, 8)

value = bytes(bytearray((value,)))

return value

def decode_path(path: bytes, has_ab_prefix: bool = True) -> Optional[bytes]:

if path == b"/dev/null":

return None

if path.startswith(b'"') and path.endswith(b'"'):

path = path[1:-1].replace(b"\\n", b"\n").replace(b"\\t", b"\t").replace(b'\\"', b'"').replace(b"\\\\", b"\\")

path = _octal_byte_re.sub(_octal_repl, path)

if has_ab_prefix:

assert path.startswith(b"a/") or path.startswith(b"b/")

path = path[2:]

return path

class Diffable:

"""Common interface for all objects that can be diffed against another object of

compatible type.

:note:

Subclasses require a repo member as it is the case for Object instances, for

practical reasons we do not derive from Object.

"""

__slots__ = ()

class Index:

"""Stand-in indicating you want to diff against the index."""

def _process_diff_args(

self, args: List[Union[str, "Diffable", Type["Diffable.Index"], object]]

) -> List[Union[str, "Diffable", Type["Diffable.Index"], object]]:

"""

:return:

Possibly altered version of the given args list.

This method is called right before git command execution.

Subclasses can use it to alter the behaviour of the superclass.

"""

return args

def diff(

self,

other: Union[Type["Index"], "Tree", "Commit", None, str, object] = Index,

paths: Union[PathLike, List[PathLike], Tuple[PathLike, ...], None] = None,

create_patch: bool = False,

**kwargs: Any,

) -> "DiffIndex":

"""Create diffs between two items being trees, trees and index or an

index and the working tree. Detects renames automatically.

:param other:

This the item to compare us with.

* If None, we will be compared to the working tree.

* If :class:`~git.index.base.Treeish`, it will be compared against the

respective tree.

* If :class:`~Diffable.Index`, it will be compared against the index.

* If :attr:`git.NULL_TREE`, it will compare against the empty tree.

* It defaults to :class:`~Diffable.Index` so that the method will not by

default fail on bare repositories.

:param paths:

This a list of paths or a single path to limit the diff to. It will only

include at least one of the given path or paths.

:param create_patch:

If True, the returned :class:`Diff` contains a detailed patch that if

applied makes the self to other. Patches are somewhat costly as blobs have

to be read and diffed.

:param kwargs:

Additional arguments passed to git-diff, such as ``R=True`` to swap both

sides of the diff.

:return: git.DiffIndex

:note:

On a bare repository, 'other' needs to be provided as

:class:`~Diffable.Index`, or as :class:`~git.objects.tree.Tree` or

:class:`~git.objects.commit.Commit`, or a git command error will occur.

"""

args: List[Union[PathLike, Diffable, Type["Diffable.Index"], object]] = []

args.append("--abbrev=40") # We need full shas.

args.append("--full-index") # Get full index paths, not only filenames.

# Remove default '-M' arg (check for renames) if user is overriding it.

if not any(x in kwargs for x in ("find_renames", "no_renames", "M")):

args.append("-M")

if create_patch:

args.append("-p")

else:

args.append("--raw")

args.append("-z")

# Ensure we never see colored output.

# Fixes: https://github.com/gitpython-developers/GitPython/issues/172

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

if paths is not None and not isinstance(paths, (tuple, list)):

paths = [paths]

if hasattr(self, "Has_Repo"):

self.repo: "Repo" = self.repo

diff_cmd = self.repo.git.diff

if other is self.Index:

args.insert(0, "--cached")

elif other is NULL_TREE:

args.insert(0, "-r") # Recursive diff-tree.

args.insert(0, "--root")

diff_cmd = self.repo.git.diff_tree

elif other is not None:

args.insert(0, "-r") # Recursive diff-tree.

args.insert(0, other)

diff_cmd = self.repo.git.diff_tree

args.insert(0, self)

# paths is list here, or None.

if paths:

args.append("--")

args.extend(paths)

# END paths handling

kwargs["as_process"] = True

proc = diff_cmd(*self._process_diff_args(args), **kwargs)

diff_method = Diff._index_from_patch_format if create_patch else Diff._index_from_raw_format

index = diff_method(self.repo, proc)

proc.wait()

return index

T_Diff = TypeVar("T_Diff", bound="Diff")

class DiffIndex(List[T_Diff]):

"""An Index for diffs, allowing a list of Diffs to be queried by the diff

properties.

The class improves the diff handling convenience.

"""

change_type = ("A", "C", "D", "R", "M", "T")

"""Change type invariant identifying possible ways a blob can have changed:

* ``A`` = Added

* ``D`` = Deleted

* ``R`` = Renamed

* ``M`` = Modified

* ``T`` = Changed in the type

"""

def iter_change_type(self, change_type: Lit_change_type) -> Iterator[T_Diff]:

"""

:return:

Iterator yielding :class:`Diff` instances that match the given `change_type`

:param change_type:

Member of :attr:`DiffIndex.change_type`, namely:

* 'A' for added paths

* 'D' for deleted paths

* 'R' for renamed paths

* 'M' for paths with modified data

* 'T' for changed in the type paths

"""

if change_type not in self.change_type:

raise ValueError("Invalid change type: %s" % change_type)

for diffidx in self:

if diffidx.change_type == change_type:

yield diffidx

elif change_type == "A" and diffidx.new_file:

yield diffidx

elif change_type == "D" and diffidx.deleted_file:

yield diffidx

elif change_type == "C" and diffidx.copied_file:

yield diffidx

elif change_type == "R" and diffidx.renamed:

yield diffidx

elif change_type == "M" and diffidx.a_blob and diffidx.b_blob and diffidx.a_blob != diffidx.b_blob:

yield diffidx

# END for each diff

class Diff:

"""A Diff contains diff information between two Trees.

It contains two sides a and b of the diff, members are prefixed with

"a" and "b" respectively to indicate that.

Diffs keep information about the changed blob objects, the file mode, renames,

deletions and new files.

There are a few cases where None has to be expected as member variable value:

``New File``::

a_mode is None

a_blob is None

a_path is None

``Deleted File``::

b_mode is None

b_blob is None

b_path is None

``Working Tree Blobs``

When comparing to working trees, the working tree blob will have a null hexsha

as a corresponding object does not yet exist. The mode will be null as well.

The path will be available, though.

If it is listed in a diff, the working tree version of the file must

differ from the version in the index or tree, and hence has been modified.

"""

# Precompiled regex.

re_header = re.compile(

rb"""

^diff[ ]--git

[ ](?P<a_path_fallback>"?[ab]/.+?"?)[ ](?P<b_path_fallback>"?[ab]/.+?"?)\n

(?:^old[ ]mode[ ](?P<old_mode>\d+)\n

^new[ ]mode[ ](?P<new_mode>\d+)(?:\n|$))?

(?:^similarity[ ]index[ ]\d+%\n

^rename[ ]from[ ](?P<rename_from>.*)\n

^rename[ ]to[ ](?P<rename_to>.*)(?:\n|$))?

(?:^new[ ]file[ ]mode[ ](?P<new_file_mode>.+)(?:\n|$))?

(?:^deleted[ ]file[ ]mode[ ](?P<deleted_file_mode>.+)(?:\n|$))?

(?:^similarity[ ]index[ ]\d+%\n

^copy[ ]from[ ].*\n

^copy[ ]to[ ](?P<copied_file_name>.*)(?:\n|$))?

(?:^index[ ](?P<a_blob_id>[0-9A-Fa-f]+)

\.\.(?P<b_blob_id>[0-9A-Fa-f]+)[ ]?(?P<b_mode>.+)?(?:\n|$))?

(?:^---[ ](?P<a_path>[^\t\n\r\f\v]*)[\t\r\f\v]*(?:\n|$))?

(?:^\+\+\+[ ](?P<b_path>[^\t\n\r\f\v]*)[\t\r\f\v]*(?:\n|$))?

""",

re.VERBOSE | re.MULTILINE,

)

# These can be used for comparisons.

NULL_HEX_SHA = "0" * 40

NULL_BIN_SHA = b"\0" * 20

__slots__ = (

"a_blob",

"b_blob",

"a_mode",

"b_mode",

"a_rawpath",

"b_rawpath",

"new_file",

"deleted_file",

"copied_file",

"raw_rename_from",

"raw_rename_to",

"diff",

"change_type",

"score",

)

def __init__(

self,

repo: "Repo",

a_rawpath: Optional[bytes],

b_rawpath: Optional[bytes],

a_blob_id: Union[str, bytes, None],

b_blob_id: Union[str, bytes, None],

a_mode: Union[bytes, str, None],

b_mode: Union[bytes, str, None],

new_file: bool,

deleted_file: bool,

copied_file: bool,

raw_rename_from: Optional[bytes],

raw_rename_to: Optional[bytes],

diff: Union[str, bytes, None],

change_type: Optional[Lit_change_type],

score: Optional[int],

) -> None:

assert a_rawpath is None or isinstance(a_rawpath, bytes)

assert b_rawpath is None or isinstance(b_rawpath, bytes)

self.a_rawpath = a_rawpath

self.b_rawpath = b_rawpath

self.a_mode = mode_str_to_int(a_mode) if a_mode else None

self.b_mode = mode_str_to_int(b_mode) if b_mode else None

# Determine whether this diff references a submodule. If it does then

# we need to overwrite "repo" to the corresponding submodule's repo instead.

if repo and a_rawpath:

for submodule in repo.submodules:

if submodule.path == a_rawpath.decode(defenc, "replace"):

if submodule.module_exists():

repo = submodule.module()

break

self.a_blob: Union["IndexObject", None]

if a_blob_id is None or a_blob_id == self.NULL_HEX_SHA:

self.a_blob = None

else:

self.a_blob = Blob(repo, hex_to_bin(a_blob_id), mode=self.a_mode, path=self.a_path)

self.b_blob: Union["IndexObject", None]

if b_blob_id is None or b_blob_id == self.NULL_HEX_SHA:

self.b_blob = None

else:

self.b_blob = Blob(repo, hex_to_bin(b_blob_id), mode=self.b_mode, path=self.b_path)

self.new_file: bool = new_file

self.deleted_file: bool = deleted_file

self.copied_file: bool = copied_file

# Be clear and use None instead of empty strings.

assert raw_rename_from is None or isinstance(raw_rename_from, bytes)

assert raw_rename_to is None or isinstance(raw_rename_to, bytes)

self.raw_rename_from = raw_rename_from or None

self.raw_rename_to = raw_rename_to or None

self.diff = diff

self.change_type: Union[Lit_change_type, None] = change_type

self.score = score

def __eq__(self, other: object) -> bool:

for name in self.__slots__:

if getattr(self, name) != getattr(other, name):

return False

# END for each name

return True

def __ne__(self, other: object) -> bool:

return not (self == other)

def __hash__(self) -> int:

return hash(tuple(getattr(self, n) for n in self.__slots__))

def __str__(self) -> str:

h = "%s"

if self.a_blob:

h %= self.a_blob.path

elif self.b_blob:

h %= self.b_blob.path

msg = ""

line = None

line_length = 0

for b, n in zip((self.a_blob, self.b_blob), ("lhs", "rhs")):

if b:

line = "\n%s: %o | %s" % (n, b.mode, b.hexsha)

else:

line = "\n%s: None" % n

# END if blob is not None

line_length = max(len(line), line_length)

msg += line

# END for each blob

# Add headline.

h += "\n" + "=" * line_length

if self.deleted_file:

msg += "\nfile deleted in rhs"

if self.new_file:

msg += "\nfile added in rhs"

if self.copied_file:

msg += "\nfile %r copied from %r" % (self.b_path, self.a_path)

if self.rename_from:

msg += "\nfile renamed from %r" % self.rename_from

if self.rename_to:

msg += "\nfile renamed to %r" % self.rename_to

if self.diff:

msg += "\n---"

try:

msg += self.diff.decode(defenc) if isinstance(self.diff, bytes) else self.diff

except UnicodeDecodeError:

msg += "OMITTED BINARY DATA"

# END handle encoding

msg += "\n---"

# END diff info

return h + msg

@property

def a_path(self) -> Optional[str]:

return self.a_rawpath.decode(defenc, "replace") if self.a_rawpath else None

@property

def b_path(self) -> Optional[str]:

return self.b_rawpath.decode(defenc, "replace") if self.b_rawpath else None

@property

def rename_from(self) -> Optional[str]:

return self.raw_rename_from.decode(defenc, "replace") if self.raw_rename_from else None

@property

def rename_to(self) -> Optional[str]:

return self.raw_rename_to.decode(defenc, "replace") if self.raw_rename_to else None

@property

def renamed(self) -> bool:

"""

:return: True if the blob of our diff has been renamed

:note: This property is deprecated.

Please use the :attr:`renamed_file` property instead.

"""

return self.renamed_file

@property

def renamed_file(self) -> bool:

""":return: True if the blob of our diff has been renamed"""

return self.rename_from != self.rename_to

@classmethod

def _pick_best_path(cls, path_match: bytes, rename_match: bytes, path_fallback_match: bytes) -> Optional[bytes]:

if path_match:

return decode_path(path_match)

if rename_match:

return decode_path(rename_match, has_ab_prefix=False)

if path_fallback_match:

return decode_path(path_fallback_match)

return None

@classmethod

def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoInterrupt"]) -> DiffIndex:

"""Create a new DiffIndex from the given process output which must be in patch format.

:param repo: The repository we are operating on

:param proc: ``git diff`` process to read from (supports :class:`Git.AutoInterrupt` wrapper)

:return: git.DiffIndex

"""

# FIXME: Here SLURPING raw, need to re-phrase header-regexes linewise.

text_list: List[bytes] = []

handle_process_output(proc, text_list.append, None, finalize_process, decode_streams=False)

# For now, we have to bake the stream.

text = b"".join(text_list)

index: "DiffIndex" = DiffIndex()

previous_header: Union[Match[bytes], None] = None

header: Union[Match[bytes], None] = None

a_path, b_path = None, None # For mypy.

a_mode, b_mode = None, None # For mypy.

for _header in cls.re_header.finditer(text):

(

a_path_fallback,

b_path_fallback,

old_mode,

new_mode,

rename_from,

rename_to,

new_file_mode,

deleted_file_mode,

copied_file_name,

a_blob_id,

b_blob_id,

b_mode,

a_path,

b_path,

) = _header.groups()

new_file, deleted_file, copied_file = (

bool(new_file_mode),

bool(deleted_file_mode),

bool(copied_file_name),

)

a_path = cls._pick_best_path(a_path, rename_from, a_path_fallback)

b_path = cls._pick_best_path(b_path, rename_to, b_path_fallback)

# Our only means to find the actual text is to see what has not been matched by our regex,

# and then retro-actively assign it to our index.

if previous_header is not None:

index[-1].diff = text[previous_header.end() : _header.start()]

# END assign actual diff

# Make sure the mode is set if the path is set. Otherwise the resulting blob is invalid.

# We just use the one mode we should have parsed.

a_mode = old_mode or deleted_file_mode or (a_path and (b_mode or new_mode or new_file_mode))

b_mode = b_mode or new_mode or new_file_mode or (b_path and a_mode)

index.append(

Diff(

repo,

a_path,

b_path,

a_blob_id and a_blob_id.decode(defenc),

b_blob_id and b_blob_id.decode(defenc),

a_mode and a_mode.decode(defenc),

b_mode and b_mode.decode(defenc),

new_file,

deleted_file,

copied_file,

rename_from,

rename_to,

None,

)

previous_header = _header

header = _header

# END for each header we parse

if index and header:

index[-1].diff = text[header.end() :]

# END assign last diff

return index

@staticmethod

def _handle_diff_line(lines_bytes: bytes, repo: "Repo", index: DiffIndex) -> None:

lines = lines_bytes.decode(defenc)

# Discard everything before the first colon, and the colon itself.

_, _, lines = lines.partition(":")

for line in lines.split("\x00:"):

if not line:

# The line data is empty, skip.

continue

meta, _, path = line.partition("\x00")

path = path.rstrip("\x00")

a_blob_id: Optional[str]

b_blob_id: Optional[str]

old_mode, new_mode, a_blob_id, b_blob_id, _change_type = meta.split(None, 4)

# Change type can be R100

# R: status letter

# 100: score (in case of copy and rename)

# assert is_change_type(_change_type[0]), f"Unexpected value for change_type received: {_change_type[0]}"

change_type: Lit_change_type = cast(Lit_change_type, _change_type[0])

score_str = "".join(_change_type[1:])

score = int(score_str) if score_str.isdigit() else None

path = path.strip()

a_path = path.encode(defenc)

b_path = path.encode(defenc)

deleted_file = False

new_file = False

copied_file = False

rename_from = None

rename_to = None

# NOTE: We cannot conclude from the existence of a blob to change type

# as diffs with the working do not have blobs yet.

if change_type == "D":

b_blob_id = None # Optional[str]

deleted_file = True

elif change_type == "A":

a_blob_id = None

new_file = True

elif change_type == "C":

copied_file = True

a_path_str, b_path_str = path.split("\x00", 1)

a_path = a_path_str.encode(defenc)

b_path = b_path_str.encode(defenc)

elif change_type == "R":

a_path_str, b_path_str = path.split("\x00", 1)

a_path = a_path_str.encode(defenc)

b_path = b_path_str.encode(defenc)

rename_from, rename_to = a_path, b_path

elif change_type == "T":

# Nothing to do.

pass

# END add/remove handling

diff = Diff(

repo,

a_path,

b_path,

a_blob_id,

b_blob_id,

old_mode,

new_mode,

new_file,

deleted_file,

copied_file,

rename_from,

rename_to,

"",

change_type,

score,

)

index.append(diff)

@classmethod

def _index_from_raw_format(cls, repo: "Repo", proc: "Popen") -> "DiffIndex":

"""Create a new DiffIndex from the given process output which must be in raw format.

:param repo: The repository we are operating on

:param proc: Process to read output from

:return: git.DiffIndex

"""

# handles

# :100644 100644 687099101... 37c5e30c8... M .gitignore

index: "DiffIndex" = DiffIndex()

handle_process_output(

proc,

lambda byt: cls._handle_diff_line(byt, repo, index),

None,

finalize_process,

decode_streams=False,

)

return index

GitPython/git/diff.py at main · bondbox/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

diff.py

Latest commit

History

Breadcrumbs

diff.py

File metadata and controls