Repository navigation
Expand file tree
/
Copy path_pygit2.pyi
More file actions
889 lines (841 loc) · 26 KB
/
Copy path_pygit2.pyi
File metadata and controls
889 lines (841 loc) · 26 KB
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
from collections.abc import Iterator, Sequence
from io import DEFAULT_BUFFER_SIZE, IOBase
from pathlib import Path
from queue import Queue
from threading import Event
from typing import ( # noqa: UP035
Generic,
Literal,
Optional,
Type,
TypedDict,
TypeVar,
final,
overload,
)
from typing_extensions import disjoint_base
from . import Index
from ._libgit2.ffi import (
GitCommitC,
GitObjectC,
GitSignatureC,
_Pointer,
)
from .enums import (
ApplyLocation,
BlobFilter,
BranchType,
DeltaStatus,
DiffFind,
DiffFlag,
DiffOption,
DiffStatsFormat,
FileMode,
MergeAnalysis,
MergePreference,
ObjectType,
ReferenceFilter,
ReferenceType,
ResetMode,
SortMode,
)
from .filter import Filter
LIBGIT2_VER_MAJOR: int
LIBGIT2_VER_MINOR: int
LIBGIT2_VER_REVISION: int
LIBGIT2_VERSION: str
GIT_OID_RAWSZ: int
GIT_OID_HEXSZ: int
GIT_OID_HEX_ZERO: str
GIT_OID_MINPREFIXLEN: int
GIT_OBJECT_ANY: int
GIT_OBJECT_INVALID: int
GIT_OBJECT_COMMIT: int
GIT_OBJECT_TREE: int
GIT_OBJECT_BLOB: int
GIT_OBJECT_TAG: int
GIT_OBJECT_OFS_DELTA: int
GIT_OBJECT_REF_DELTA: int
GIT_FILEMODE_UNREADABLE: int
GIT_FILEMODE_TREE: int
GIT_FILEMODE_BLOB: int
GIT_FILEMODE_BLOB_EXECUTABLE: int
GIT_FILEMODE_LINK: int
GIT_FILEMODE_COMMIT: int
GIT_SORT_NONE: int
GIT_SORT_TOPOLOGICAL: int
GIT_SORT_TIME: int
GIT_SORT_REVERSE: int
GIT_RESET_SOFT: int
GIT_RESET_MIXED: int
GIT_RESET_HARD: int
GIT_REFERENCES_ALL: int
GIT_REFERENCES_BRANCHES: int
GIT_REFERENCES_TAGS: int
GIT_REVSPEC_SINGLE: int
GIT_REVSPEC_RANGE: int
GIT_REVSPEC_MERGE_BASE: int
GIT_BRANCH_LOCAL: int
GIT_BRANCH_REMOTE: int
GIT_BRANCH_ALL: int
GIT_STATUS_CURRENT: int
GIT_STATUS_INDEX_NEW: int
GIT_STATUS_INDEX_MODIFIED: int
GIT_STATUS_INDEX_DELETED: int
GIT_STATUS_INDEX_RENAMED: int
GIT_STATUS_INDEX_TYPECHANGE: int
GIT_STATUS_WT_NEW: int
GIT_STATUS_WT_MODIFIED: int
GIT_STATUS_WT_DELETED: int
GIT_STATUS_WT_TYPECHANGE: int
GIT_STATUS_WT_RENAMED: int
GIT_STATUS_WT_UNREADABLE: int
GIT_STATUS_IGNORED: int
GIT_STATUS_CONFLICTED: int
GIT_CHECKOUT_NONE: int
GIT_CHECKOUT_SAFE: int
GIT_CHECKOUT_FORCE: int
GIT_CHECKOUT_RECREATE_MISSING: int
GIT_CHECKOUT_ALLOW_CONFLICTS: int
GIT_CHECKOUT_REMOVE_UNTRACKED: int
GIT_CHECKOUT_REMOVE_IGNORED: int
GIT_CHECKOUT_UPDATE_ONLY: int
GIT_CHECKOUT_DONT_UPDATE_INDEX: int
GIT_CHECKOUT_NO_REFRESH: int
GIT_CHECKOUT_SKIP_UNMERGED: int
GIT_CHECKOUT_USE_OURS: int
GIT_CHECKOUT_USE_THEIRS: int
GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH: int
GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES: int
GIT_CHECKOUT_DONT_OVERWRITE_IGNORED: int
GIT_CHECKOUT_CONFLICT_STYLE_MERGE: int
GIT_CHECKOUT_CONFLICT_STYLE_DIFF3: int
GIT_CHECKOUT_DONT_REMOVE_EXISTING: int
GIT_CHECKOUT_DONT_WRITE_INDEX: int
GIT_CHECKOUT_DRY_RUN: int
GIT_CHECKOUT_CONFLICT_STYLE_ZDIFF3: int
GIT_DIFF_NORMAL: int
GIT_DIFF_REVERSE: int
GIT_DIFF_INCLUDE_IGNORED: int
GIT_DIFF_RECURSE_IGNORED_DIRS: int
GIT_DIFF_INCLUDE_UNTRACKED: int
GIT_DIFF_RECURSE_UNTRACKED_DIRS: int
GIT_DIFF_INCLUDE_UNMODIFIED: int
GIT_DIFF_INCLUDE_TYPECHANGE: int
GIT_DIFF_INCLUDE_TYPECHANGE_TREES: int
GIT_DIFF_IGNORE_FILEMODE: int
GIT_DIFF_IGNORE_SUBMODULES: int
GIT_DIFF_IGNORE_CASE: int
GIT_DIFF_INCLUDE_CASECHANGE: int
GIT_DIFF_DISABLE_PATHSPEC_MATCH: int
GIT_DIFF_SKIP_BINARY_CHECK: int
GIT_DIFF_ENABLE_FAST_UNTRACKED_DIRS: int
GIT_DIFF_UPDATE_INDEX: int
GIT_DIFF_INCLUDE_UNREADABLE: int
GIT_DIFF_INCLUDE_UNREADABLE_AS_UNTRACKED: int
GIT_DIFF_INDENT_HEURISTIC: int
GIT_DIFF_IGNORE_BLANK_LINES: int
GIT_DIFF_FORCE_TEXT: int
GIT_DIFF_FORCE_BINARY: int
GIT_DIFF_IGNORE_WHITESPACE: int
GIT_DIFF_IGNORE_WHITESPACE_CHANGE: int
GIT_DIFF_IGNORE_WHITESPACE_EOL: int
GIT_DIFF_SHOW_UNTRACKED_CONTENT: int
GIT_DIFF_SHOW_UNMODIFIED: int
GIT_DIFF_PATIENCE: int
GIT_DIFF_MINIMAL: int
GIT_DIFF_SHOW_BINARY: int
GIT_DIFF_STATS_NONE: int
GIT_DIFF_STATS_FULL: int
GIT_DIFF_STATS_SHORT: int
GIT_DIFF_STATS_NUMBER: int
GIT_DIFF_STATS_INCLUDE_SUMMARY: int
GIT_DIFF_FIND_BY_CONFIG: int
GIT_DIFF_FIND_RENAMES: int
GIT_DIFF_FIND_RENAMES_FROM_REWRITES: int
GIT_DIFF_FIND_COPIES: int
GIT_DIFF_FIND_COPIES_FROM_UNMODIFIED: int
GIT_DIFF_FIND_REWRITES: int
GIT_DIFF_BREAK_REWRITES: int
GIT_DIFF_FIND_AND_BREAK_REWRITES: int
GIT_DIFF_FIND_FOR_UNTRACKED: int
GIT_DIFF_FIND_ALL: int
GIT_DIFF_FIND_IGNORE_LEADING_WHITESPACE: int
GIT_DIFF_FIND_IGNORE_WHITESPACE: int
GIT_DIFF_FIND_DONT_IGNORE_WHITESPACE: int
GIT_DIFF_FIND_EXACT_MATCH_ONLY: int
GIT_DIFF_BREAK_REWRITES_FOR_RENAMES_ONLY: int
GIT_DIFF_FIND_REMOVE_UNMODIFIED: int
GIT_DIFF_FLAG_BINARY: int
GIT_DIFF_FLAG_NOT_BINARY: int
GIT_DIFF_FLAG_VALID_ID: int
GIT_DIFF_FLAG_EXISTS: int
GIT_DIFF_FLAG_VALID_SIZE: int
GIT_DELTA_UNMODIFIED: int
GIT_DELTA_ADDED: int
GIT_DELTA_DELETED: int
GIT_DELTA_MODIFIED: int
GIT_DELTA_RENAMED: int
GIT_DELTA_COPIED: int
GIT_DELTA_IGNORED: int
GIT_DELTA_UNTRACKED: int
GIT_DELTA_TYPECHANGE: int
GIT_DELTA_UNREADABLE: int
GIT_DELTA_CONFLICTED: int
GIT_CONFIG_LEVEL_PROGRAMDATA: int
GIT_CONFIG_LEVEL_SYSTEM: int
GIT_CONFIG_LEVEL_XDG: int
GIT_CONFIG_LEVEL_GLOBAL: int
GIT_CONFIG_LEVEL_LOCAL: int
GIT_CONFIG_LEVEL_WORKTREE: int
GIT_CONFIG_LEVEL_APP: int
GIT_CONFIG_HIGHEST_LEVEL: int
GIT_BLAME_NORMAL: int
GIT_BLAME_TRACK_COPIES_SAME_FILE: int
GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES: int
GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES: int
GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES: int
GIT_BLAME_FIRST_PARENT: int
GIT_BLAME_USE_MAILMAP: int
GIT_BLAME_IGNORE_WHITESPACE: int
GIT_MERGE_ANALYSIS_NONE: int
GIT_MERGE_ANALYSIS_NORMAL: int
GIT_MERGE_ANALYSIS_UP_TO_DATE: int
GIT_MERGE_ANALYSIS_FASTFORWARD: int
GIT_MERGE_ANALYSIS_UNBORN: int
GIT_MERGE_PREFERENCE_NONE: int
GIT_MERGE_PREFERENCE_NO_FASTFORWARD: int
GIT_MERGE_PREFERENCE_FASTFORWARD_ONLY: int
GIT_DESCRIBE_DEFAULT: int
GIT_DESCRIBE_TAGS: int
GIT_DESCRIBE_ALL: int
GIT_STASH_DEFAULT: int
GIT_STASH_KEEP_INDEX: int
GIT_STASH_INCLUDE_UNTRACKED: int
GIT_STASH_INCLUDE_IGNORED: int
GIT_STASH_KEEP_ALL: int
GIT_STASH_APPLY_DEFAULT: int
GIT_STASH_APPLY_REINSTATE_INDEX: int
GIT_APPLY_LOCATION_WORKDIR: int
GIT_APPLY_LOCATION_INDEX: int
GIT_APPLY_LOCATION_BOTH: int
GIT_SUBMODULE_IGNORE_UNSPECIFIED: int
GIT_SUBMODULE_IGNORE_NONE: int
GIT_SUBMODULE_IGNORE_UNTRACKED: int
GIT_SUBMODULE_IGNORE_DIRTY: int
GIT_SUBMODULE_IGNORE_ALL: int
GIT_SUBMODULE_STATUS_IN_HEAD: int
GIT_SUBMODULE_STATUS_IN_INDEX: int
GIT_SUBMODULE_STATUS_IN_CONFIG: int
GIT_SUBMODULE_STATUS_IN_WD: int
GIT_SUBMODULE_STATUS_INDEX_ADDED: int
GIT_SUBMODULE_STATUS_INDEX_DELETED: int
GIT_SUBMODULE_STATUS_INDEX_MODIFIED: int
GIT_SUBMODULE_STATUS_WD_UNINITIALIZED: int
GIT_SUBMODULE_STATUS_WD_ADDED: int
GIT_SUBMODULE_STATUS_WD_DELETED: int
GIT_SUBMODULE_STATUS_WD_MODIFIED: int
GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED: int
GIT_SUBMODULE_STATUS_WD_WD_MODIFIED: int
GIT_SUBMODULE_STATUS_WD_UNTRACKED: int
GIT_BLOB_FILTER_CHECK_FOR_BINARY: int
GIT_BLOB_FILTER_NO_SYSTEM_ATTRIBUTES: int
GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD: int
GIT_BLOB_FILTER_ATTRIBUTES_FROM_COMMIT: int
GIT_FILTER_DRIVER_PRIORITY: int
GIT_FILTER_TO_WORKTREE: int
GIT_FILTER_SMUDGE: int
GIT_FILTER_TO_ODB: int
GIT_FILTER_CLEAN: int
GIT_FILTER_DEFAULT: int
GIT_FILTER_ALLOW_UNSAFE: int
GIT_FILTER_NO_SYSTEM_ATTRIBUTES: int
GIT_FILTER_ATTRIBUTES_FROM_HEAD: int
GIT_FILTER_ATTRIBUTES_FROM_COMMIT: int
_T = TypeVar('_T')
class _ObjectBase(Generic[_T]):
_pointer: _Pointer[_T]
filemode: FileMode
id: Oid
name: str | None
raw_name: bytes | None
short_id: str
type: 'Literal[ObjectType.COMMIT] | Literal[ObjectType.TREE] | Literal[ObjectType.TAG] | Literal[ObjectType.BLOB]'
type_str: "Literal['commit'] | Literal['tree'] | Literal['tag'] | Literal['blob']"
author: Signature
committer: Signature
tree: Tree
@overload
def peel(
self, target_type: 'Literal[ObjectType.COMMIT] | Type[Commit]', /
) -> 'Commit': ...
@overload
def peel(
self, target_type: 'Literal[ObjectType.TREE] | Type[Tree]', /
) -> 'Tree': ...
@overload
def peel(self, target_type: 'Literal[ObjectType.TAG] | Type[Tag]', /) -> 'Tag': ...
@overload
def peel(
self, target_type: 'Literal[ObjectType.BLOB] | Type[Blob]', /
) -> 'Blob': ...
@overload
def peel(self, target_type: 'None', /) -> 'Commit|Tree|Tag|Blob': ...
def read_raw(self) -> bytes: ...
def __eq__(self, other, /) -> bool: ...
def __ge__(self, other, /) -> bool: ...
def __gt__(self, other, /) -> bool: ...
def __hash__(self) -> int: ...
def __le__(self, other, /) -> bool: ...
def __lt__(self, other, /) -> bool: ...
def __ne__(self, other, /) -> bool: ...
@disjoint_base
class Object(_ObjectBase[GitObjectC]):
pass
@final
class Reference:
name: str
raw_name: bytes
raw_shorthand: bytes
raw_target: Oid | bytes
shorthand: str
target: Oid | str
type: ReferenceType
def __init__(self, *args) -> None: ...
def delete(self) -> None: ...
def log(self) -> Iterator[RefLogEntry]: ...
@overload
def peel(self, type: 'Literal[ObjectType.COMMIT] | Type[Commit]') -> 'Commit': ...
@overload
def peel(self, type: 'Literal[ObjectType.TREE] | Type[Tree]') -> 'Tree': ...
@overload
def peel(self, type: 'Literal[ObjectType.TAG] | Type[Tag]') -> 'Tag': ...
@overload
def peel(self, type: 'Literal[ObjectType.BLOB] | Type[Blob]') -> 'Blob': ...
@overload
def peel(self, type: 'None' = None) -> 'Commit|Tree|Tag|Blob': ...
def rename(self, new_name: str, /) -> None: ...
def resolve(self) -> Reference: ...
def set_target(self, target: _OidArg, message: str = ...) -> None: ...
def __eq__(self, other, /) -> bool: ...
def __ge__(self, other, /) -> bool: ...
def __gt__(self, other, /) -> bool: ...
def __le__(self, other, /) -> bool: ...
def __lt__(self, other, /) -> bool: ...
def __ne__(self, other, /) -> bool: ...
class AlreadyExistsError(GitError, ValueError): ...
class AmbiguousError(GitError, ValueError): ...
class AuthError(GitError): ...
class InvalidError(GitError, ValueError): ...
@final
class Blob(Object):
data: bytes
is_binary: bool
size: int
def diff(
self,
blob: Blob = ...,
flag: int = ...,
old_as_path: str = ...,
new_as_path: str = ...,
) -> Patch: ...
def diff_to_buffer(
self,
buffer: Optional[bytes | str] = None,
flag: DiffOption = DiffOption.NORMAL,
old_as_path: str = ...,
buffer_as_path: str = ...,
) -> Patch: ...
def _write_to_queue(
self,
queue: Queue[bytes],
ready: Event,
done: Event,
chunk_size: int = DEFAULT_BUFFER_SIZE,
as_path: Optional[str] = None,
flags: BlobFilter = BlobFilter.CHECK_FOR_BINARY,
commit_id: Optional[Oid] = None,
) -> None: ...
def __buffer__(self, flags: int, /) -> memoryview: ...
@final
class Branch(Reference): # type: ignore[misc]
branch_name: str
raw_branch_name: bytes
remote_name: str
upstream: Branch
upstream_name: str
def delete(self) -> None: ...
def is_checked_out(self) -> bool: ...
def is_head(self) -> bool: ...
def rename(self, name: str, force: bool = False) -> 'Branch': ... # type: ignore[override]
class CertificateError(GitError): ...
@final
class Commit(_ObjectBase[GitCommitC]):
_pointer: _Pointer[GitCommitC]
author: Signature
commit_time: int
commit_time_offset: int
committer: Signature
gpg_signature: tuple[bytes, bytes]
message: str
message_encoding: str
message_trailers: dict[str, str]
parent_ids: list[Oid]
parents: list[Commit]
raw_message: bytes
tree: Tree
tree_id: Oid
@disjoint_base
class Diff:
deltas: Iterator[DiffDelta]
patch: str | None
patchid: Oid
stats: DiffStats
text: str
def find_similar(
self,
flags: DiffFind = DiffFind.FIND_BY_CONFIG,
rename_threshold: int = 50,
copy_threshold: int = 50,
rename_from_rewrite_threshold: int = 50,
break_rewrite_threshold: int = 60,
rename_limit: int = 1000,
) -> None: ...
def merge(self, diff: Diff) -> None: ...
@staticmethod
def from_c(diff, repo) -> Diff: ...
@staticmethod
def parse_diff(git_diff: str | bytes, /) -> Diff: ...
def __getitem__(self, index: int, /) -> Patch | None: ... # Diff_getitem
def __iter__(self) -> Iterator[Patch | None]: ... # -> DiffIter
def __len__(self) -> int: ...
@final
class DiffDelta:
flags: DiffFlag
is_binary: bool | None
nfiles: int
new_file: DiffFile
old_file: DiffFile
similarity: int
status: DeltaStatus
def status_char(self) -> str: ...
@final
class DiffFile:
flags: DiffFlag
id: Oid
mode: FileMode
path: str
raw_path: bytes
size: int
@staticmethod
def from_c(bytes, /) -> DiffFile: ...
@disjoint_base
class DiffHunk:
header: str
lines: list[DiffLine]
new_lines: int
new_start: int
old_lines: int
old_start: int
@final
class DiffLine:
content: str
content_offset: int
new_lineno: int
num_lines: int
old_lineno: int
origin: str
raw_content: bytes
@disjoint_base
class DiffStats:
deletions: int
files_changed: int
insertions: int
def format(self, format: DiffStatsFormat, width: int) -> str: ...
@final
class FilterSource:
repo: object
path: str
filemode: int
oid: Oid | None
mode: int
flags: int
class GitError(Exception): ...
class InvalidSpecError(GitError, ValueError): ...
@final
class Mailmap:
def __init__(self, *args) -> None: ...
def add_entry(
self,
real_name: str | None = ...,
real_email: str | None = ...,
replace_name: str | None = ...,
replace_email: str = ...,
) -> None: ...
@staticmethod
def from_buffer(buffer: str | bytes) -> Mailmap: ...
@staticmethod
def from_repository(repository: Repository) -> Mailmap: ...
def resolve(self, name: str, email: str) -> tuple[str, str]: ...
def resolve_signature(self, sig: Signature) -> Signature: ...
@final
class Note:
annotated_id: Oid
id: Oid
message: str
data: bytes
def remove(
self, author: Signature, committer: Signature, ref: str = 'refs/notes/commits'
) -> None: ...
class NotFoundError(GitError, KeyError): ...
@final
class Odb:
backends: Iterator[OdbBackend]
def __init__(self, *args, **kwargs) -> None: ...
def add_backend(self, backend: OdbBackend, priority: int) -> None: ...
def add_disk_alternate(self, path: str | Path, /) -> None: ...
def exists(self, oid: _OidArg, /) -> bool: ...
def read(self, oid: _OidArg, /) -> tuple[ObjectType, bytes]: ...
def read_header(self, oid: _OidArg, /) -> tuple[ObjectType, int]: ...
def write(self, type: int, data: bytes | str) -> Oid: ...
def __contains__(self, other: _OidArg, /) -> bool: ...
def __iter__(self) -> Iterator[Oid]: ... # Odb_as_iter
@disjoint_base
class OdbBackend:
def __init__(self, *args, **kwargs) -> None: ...
def exists(self, oid: _OidArg, /) -> bool: ...
def exists_prefix(self, partial_id: _OidArg, /) -> Oid: ...
def read(self, oid: _OidArg, /) -> tuple[int, bytes]: ...
def read_header(self, oid: _OidArg, /) -> tuple[int, int]: ...
def read_prefix(self, oid: _OidArg, /) -> tuple[int, bytes, Oid]: ...
def refresh(self) -> None: ...
def __iter__(self) -> Iterator[Oid]: ... # OdbBackend_as_iter
@final
class OdbBackendLoose(OdbBackend):
def __init__(self, *args, **kwargs) -> None: ...
@final
class OdbBackendPack(OdbBackend):
def __init__(self, *args, **kwargs) -> None: ...
@final
class Oid:
raw: bytes
def __init__(self, raw: bytes = ..., hex: str = ...) -> None: ...
def __eq__(self, other, /) -> bool: ...
def __ge__(self, other, /) -> bool: ...
def __gt__(self, other, /) -> bool: ...
def __hash__(self) -> int: ...
def __le__(self, other, /) -> bool: ...
def __lt__(self, other, /) -> bool: ...
def __ne__(self, other, /) -> bool: ...
def __bool__(self) -> bool: ...
@final
class Patch:
data: bytes
delta: DiffDelta
hunks: list[DiffHunk]
line_stats: tuple[int, int, int] # context, additions, deletions
text: str | None
@staticmethod
def create_from(
old: Blob | bytes | None,
new: Blob | bytes | None,
old_as_path: str = ...,
new_as_path: str = ...,
flag: DiffOption = DiffOption.NORMAL,
context_lines: int = 3,
interhunk_lines: int = 0,
) -> Patch: ...
@final
class RefLogEntry:
committer: Signature
message: str
oid_new: Oid
oid_old: Oid
def __init__(self, *args, **kwargs) -> None: ...
@final
class Refdb:
def __init__(self) -> None: ...
def compress(self) -> None: ...
@staticmethod
def new(repo: Repository, /) -> Refdb: ...
@staticmethod
def open(repo: Repository, /) -> Refdb: ...
def set_backend(self, backend: RefdbBackend, /) -> None: ...
@disjoint_base
class RefdbBackend:
def __init__(self, *args, **kwargs) -> None: ...
def compress(self) -> None: ...
def delete(
self, ref_name: str, old_id: _OidArg, old_target: str | None
) -> None: ...
def ensure_log(self, ref_name: str, /) -> bool: ...
def exists(self, refname: str, /) -> bool: ...
def has_log(self, ref_name: str, /) -> bool: ...
def lookup(self, refname: str, /) -> Reference: ...
def rename(
self,
old_name: str,
new_name: str,
force: bool,
who: Signature,
message: str | None,
) -> Reference: ...
def write(
self,
ref: Reference,
force: bool,
who: Signature,
message: str,
old: None | _OidArg,
old_target: None | str,
) -> None: ...
@final
class RefdbFsBackend(RefdbBackend):
def __init__(self, *args, **kwargs) -> None: ...
_Proxy = None | Literal[True] | str
class _StrArray:
# incomplete
count: int
class _LsRemotesDict(TypedDict):
local: bool
loid: Oid | None
name: str | None
symref_target: str | None
oid: Oid
@disjoint_base
class Repository:
def TreeBuilder(self, src: Tree | _OidArg = ...) -> TreeBuilder: ...
def __init__(self, /, *args, **kwargs) -> None: ...
def _disown(self) -> None: ...
default_signature: Signature
head: Reference
head_is_detached: bool
head_is_unborn: bool
is_bare: bool
is_empty: bool
is_shallow: bool
odb: Odb
path: str | None
refdb: Refdb
workdir: str | None
def add_worktree(
self, name: str, path: str | Path, ref: Reference = ...
) -> Worktree: ...
def applies(
self,
diff: Diff,
location: ApplyLocation = ApplyLocation.INDEX,
raise_error: bool = False,
) -> bool: ...
def apply(
self, diff: Diff, location: ApplyLocation = ApplyLocation.WORKDIR
) -> None: ...
def cherrypick(self, id: _OidArg, /) -> None: ...
def compress_references(self) -> None: ...
def create_blob(self, data: str | bytes) -> Oid: ...
def create_blob_fromdisk(self, path: str, /) -> Oid: ...
def create_blob_fromiobase(self, iobase: IOBase, /) -> Oid: ...
def create_blob_fromworkdir(self, path: str | Path, /) -> Oid: ...
def create_branch(self, name: str, commit: Commit, force=False) -> Branch: ...
def create_commit(
self,
reference_name: Optional[str],
author: Signature,
committer: Signature,
message: str | bytes,
tree: _OidArg,
parents: Sequence[_OidArg],
encoding: str = ...,
) -> Oid: ...
def create_commit_string(
self,
author: Signature,
committer: Signature,
message: str | bytes,
tree: _OidArg,
parents: list[_OidArg],
encoding: str = ...,
) -> Oid: ...
def create_commit_with_signature(
self, content: str, signature: str, signature_field: Optional[str] = None
) -> Oid: ...
def create_note(
self,
message: str,
author: Signature,
committer: Signature,
annotated_id: str,
ref: str = 'refs/notes/commits',
force: bool = False,
) -> Oid: ...
def create_reference_direct(
self, name: str, target: _OidArg, force: bool, message: Optional[str] = None
) -> Reference: ...
def create_reference_symbolic(
self, name: str, target: str, force: bool, message: Optional[str] = None
) -> Reference: ...
def create_tag(
self, name: str, oid: _OidArg, type: ObjectType, tagger: Signature, message: str
) -> Oid: ...
def descendant_of(self, oid1: _OidArg, oid2: _OidArg) -> bool: ...
def expand_id(self, hex: str, /) -> Oid: ...
def free(self) -> None: ...
def git_object_lookup_prefix(self, oid: _OidArg, /) -> Object: ...
def list_worktrees(self) -> list[str]: ...
def listall_branches(self, flag: BranchType = BranchType.LOCAL) -> list[str]: ...
def listall_mergeheads(self) -> list[Oid]: ...
def listall_stashes(self) -> list[Stash]: ...
def listall_submodules(self) -> list[str]: ...
def lookup_branch(
self, branch_name: str | bytes, branch_type: BranchType = BranchType.LOCAL
) -> Branch: ...
def lookup_note(
self, annotated_id: str, ref: str = 'refs/notes/commits'
) -> Note: ...
def lookup_reference(self, name: str, /) -> Reference: ...
def lookup_reference_dwim(self, name: str, /) -> Reference: ...
def lookup_worktree(self, name: str) -> Worktree: ...
def merge_analysis(
self, their_head: _OidArg, our_ref: str = 'HEAD'
) -> tuple[MergeAnalysis, MergePreference]: ...
def merge_base(self, oid1: _OidArg, oid2: _OidArg) -> Oid: ...
def merge_base_many(self, oids: list[_OidArg]) -> Oid: ...
def merge_base_octopus(self, oids: list[_OidArg]) -> Oid: ...
def notes(self) -> Iterator[Note]: ...
def path_is_ignored(self, path: str) -> bool: ...
def raw_listall_branches(
self, flag: BranchType = BranchType.LOCAL
) -> list[bytes]: ...
def raw_listall_references(self) -> list[bytes]: ...
def references_iterator_init(self) -> Iterator[Reference]: ...
def references_iterator_next(
self,
iter: Iterator[_T],
references_return_type: ReferenceFilter = ReferenceFilter.ALL,
) -> Reference: ...
def reset(self, oid: _OidArg, reset_type: ResetMode) -> None: ...
def revparse(self, revspec: str, /) -> RevSpec: ...
def revparse_ext(self, revision: str, /) -> tuple[Object, Reference]: ...
def revparse_single(self, revision: str, /) -> Object: ...
def set_odb(self, odb: Odb, /) -> None: ...
def set_refdb(self, refdb: Refdb, /) -> None: ...
def status(
self, untracked_files: str = 'all', ignored: bool = False
) -> dict[str, int]: ...
def status_file(self, path: str | bytes, /) -> int: ...
def walk(
self, oid: _OidArg | None, sort_mode: SortMode = SortMode.NONE
) -> Walker: ...
@disjoint_base
class RevSpec:
flags: int
from_object: Object
to_object: Object
@final
class Signature:
_encoding: str | None
_pointer: _Pointer[GitSignatureC]
email: str
name: str
offset: int
raw_email: bytes
raw_name: bytes
time: int
def __init__(
self,
name: str | bytes,
email: str,
time: int = -1,
offset: int = 0,
encoding: Optional[str] = None,
) -> None: ...
def __eq__(self, other, /) -> bool: ...
def __ge__(self, other, /) -> bool: ...
def __gt__(self, other, /) -> bool: ...
def __le__(self, other, /) -> bool: ...
def __lt__(self, other, /) -> bool: ...
def __ne__(self, other, /) -> bool: ...
@final
class Stash:
commit_id: Oid
message: str
raw_message: bytes
def __eq__(self, other, /) -> bool: ...
def __ge__(self, other, /) -> bool: ...
def __gt__(self, other, /) -> bool: ...
def __le__(self, other, /) -> bool: ...
def __lt__(self, other, /) -> bool: ...
def __ne__(self, other, /) -> bool: ...
@final
class Tag(Object):
message: str
name: str
raw_message: bytes
raw_name: bytes
tagger: Signature
target: Oid
def get_object(self) -> Object: ...
class Tree(Object):
def diff_to_index(
self,
index: Index,
flags: DiffOption = DiffOption.NORMAL,
context_lines: int = 3,
interhunk_lines: int = 0,
) -> Diff: ...
def diff_to_tree(
self,
tree: Tree = ...,
flags: DiffOption = DiffOption.NORMAL,
context_lines: int = 3,
interhunk_lines: int = 3,
swap: bool = False,
) -> Diff: ...
def diff_to_workdir(
self,
flags: DiffOption = DiffOption.NORMAL,
context_lines: int = 3,
interhunk_lines: int = 0,
) -> Diff: ...
def __contains__(self, other: str | bytes, /) -> bool: ... # Tree_contains
def __getitem__(
self, index: str | bytes | int, /
) -> Tree | Blob: ... # Tree_subscript
def __iter__(self) -> Iterator[Object]: ...
def __len__(self) -> int: ... # Tree_len
def __rtruediv__(self, other: str | bytes, /) -> Tree | Blob: ...
def __truediv__(self, other: str | bytes, /) -> Tree | Blob: ... # Tree_divide
@disjoint_base
class TreeBuilder:
def clear(self) -> None: ...
def get(self, name: str | bytes, /) -> Object: ...
def insert(self, name: str | bytes, oid: _OidArg, attr: int) -> None: ...
def remove(self, name: str | bytes, /) -> None: ...
def write(self) -> Oid: ...
def __len__(self) -> int: ...
@final
class Walker:
def hide(self, oid: _OidArg, /) -> None: ...
def push(self, oid: _OidArg, /) -> None: ...
def reset(self) -> None: ...
def simplify_first_parent(self) -> None: ...
def sort(self, mode: SortMode, /) -> None: ...
def __iter__(self) -> Iterator[Commit]: ... # Walker: ...
def __next__(self) -> Commit: ...
@final
class Worktree:
is_prunable: bool
name: str
path: str
def prune(self, force=False) -> None: ...
def discover_repository(
path: str | Path, across_fs: bool = False, ceiling_dirs: str = ...
) -> str | None: ...
def hash(data: bytes | str) -> Oid: ...
def hashfile(path: str) -> Oid: ...
def init_file_backend(path: str, flags: int = 0) -> object: ...
def reference_is_valid_name(refname: str, /) -> bool: ...
def tree_entry_cmp(a: Object, b: Object) -> int: ...
def _cache_enums() -> None: ...
def filter_register(name: str, filter: type[Filter]) -> None: ...
_OidArg = str | Oid