{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 998
Expand file tree
/
Copy pathbase.py
More file actions
1719 lines (1474 loc) · 66 KB
/
Copy pathbase.py
File metadata and controls
1719 lines (1474 loc) · 66 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
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
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
__all__ = ["Submodule", "UpdateProgress"]
import gc
from io import BytesIO
import logging
import ntpath
import os
import os.path as osp
import shlex
import stat
import sys
import uuid
import urllib
import git
from git.cmd import Git
from git.compat import defenc
from git.config import GitConfigParser, SectionConstraint, cp
from git.exc import (
BadName,
InvalidGitRepositoryError,
NoSuchPathError,
RepositoryDirtyError,
)
from git.objects.base import IndexObject, Object
from git.objects.util import TraversableIterableObj
from git.util import (
IterableList,
RemoteProgress,
_to_relative_path,
join_path_native,
rmtree,
to_native_path_linux,
unbare_repo,
)
from .util import (
SubmoduleConfigParser,
find_first_remote_branch,
mkhead,
sm_name,
sm_section,
)
# typing ----------------------------------------------------------------------
from typing import (
Any,
Callable,
Dict,
Iterator,
List,
Mapping,
Sequence,
TYPE_CHECKING,
Union,
cast,
)
if sys.version_info >= (3, 8):
from typing import Literal
else:
from typing_extensions import Literal
from git.types import Commit_ish, PathLike, TBD
if TYPE_CHECKING:
from git.index import IndexFile
from git.objects.commit import Commit
from git.refs import Head, RemoteReference
from git.repo import Repo
# -----------------------------------------------------------------------------
_logger = logging.getLogger(__name__)
class UpdateProgress(RemoteProgress):
"""Class providing detailed progress information to the caller who should
derive from it and implement the
:meth:`update(...) <git.util.RemoteProgress.update>` message."""
CLONE, FETCH, UPDWKTREE = [1 << x for x in range(RemoteProgress._num_op_codes, RemoteProgress._num_op_codes + 3)]
_num_op_codes: int = RemoteProgress._num_op_codes + 3
__slots__ = ()
BEGIN = UpdateProgress.BEGIN
END = UpdateProgress.END
CLONE = UpdateProgress.CLONE
FETCH = UpdateProgress.FETCH
UPDWKTREE = UpdateProgress.UPDWKTREE
# IndexObject comes via the util module. It's a 'hacky' fix thanks to Python's import
# mechanism, which causes plenty of trouble if the only reason for packages and modules
# is refactoring - subpackages shouldn't depend on parent packages.
class Submodule(IndexObject, TraversableIterableObj):
"""Implements access to a git submodule. They are special in that their sha
represents a commit in the submodule's repository which is to be checked out
at the path of this instance.
The submodule type does not have a string type associated with it, as it exists
solely as a marker in the tree and index.
All methods work in bare and non-bare repositories.
"""
_id_attribute_ = "name"
k_modules_file = ".gitmodules"
k_head_option = "branch"
k_head_default = "master"
k_default_mode = stat.S_IFDIR | stat.S_IFLNK
"""Submodule flags. Submodules are directories with link-status."""
type: Literal["submodule"] = "submodule" # type: ignore[assignment]
"""This is a bogus type string for base class compatibility."""
__slots__ = ("_parent_commit", "_url", "_branch_path", "_name", "__weakref__")
_cache_attrs = ("path", "_url", "_branch_path")
def __init__(
self,
repo: "Repo",
binsha: bytes,
mode: Union[int, None] = None,
path: Union[PathLike, None] = None,
name: Union[str, None] = None,
parent_commit: Union["Commit", None] = None,
url: Union[str, None] = None,
branch_path: Union[PathLike, None] = None,
) -> None:
"""Initialize this instance with its attributes.
We only document the parameters that differ from
:class:`~git.objects.base.IndexObject`.
:param repo:
Our parent repository.
:param binsha:
Binary sha referring to a commit in the remote repository.
See the `url` parameter.
:param parent_commit:
The :class:`~git.objects.commit.Commit` whose tree is supposed to contain
the ``.gitmodules`` blob, or ``None`` to always point to the most recent
commit. See :meth:`set_parent_commit` for details.
:param url:
The URL to the remote repository which is the submodule.
:param branch_path:
Full repository-relative path to ref to checkout when cloning the remote
repository.
"""
super().__init__(repo, binsha, mode, path)
self.size = 0
self._parent_commit = parent_commit
if url is not None:
self._url = url
if branch_path is not None:
self._branch_path = branch_path
if name is not None:
self._name = name
def _set_cache_(self, attr: str) -> None:
if attr in ("path", "_url", "_branch_path"):
reader: SectionConstraint = self.config_reader()
# Default submodule values.
try:
self.path = reader.get("path")
except cp.NoSectionError as e:
if self.repo.working_tree_dir is not None:
raise ValueError(
"This submodule instance does not exist anymore in '%s' file"
% osp.join(self.repo.working_tree_dir, ".gitmodules")
) from e
self._url = reader.get("url")
# GitPython extension values - optional.
self._branch_path = reader.get_value(self.k_head_option, git.Head.to_full_path(self.k_head_default))
elif attr == "_name":
raise AttributeError("Cannot retrieve the name of a submodule if it was not set initially")
else:
super()._set_cache_(attr)
# END handle attribute name
@classmethod
def _get_intermediate_items(cls, item: "Submodule") -> IterableList["Submodule"]:
""":return: All the submodules of our module repository"""
try:
return cls.list_items(item.module())
except InvalidGitRepositoryError:
return IterableList("")
# END handle intermediate items
@classmethod
def _need_gitfile_submodules(cls, git: Git) -> bool:
return git.version_info[:3] >= (1, 7, 5)
def __eq__(self, other: Any) -> bool:
"""Compare with another submodule."""
# We may only compare by name as this should be the ID they are hashed with.
# Otherwise this type wouldn't be hashable.
# return self.path == other.path and self.url == other.url and super().__eq__(other)
return self._name == other._name
def __ne__(self, other: object) -> bool:
"""Compare with another submodule for inequality."""
return not (self == other)
def __hash__(self) -> int:
"""Hash this instance using its logical id, not the sha."""
return hash(self._name)
def __str__(self) -> str:
return self._name
def __repr__(self) -> str:
return "git.%s(name=%s, path=%s, url=%s, branch_path=%s)" % (
type(self).__name__,
self._name,
self.path,
self.url,
self.branch_path,
)
@classmethod
def _config_parser(
cls, repo: "Repo", parent_commit: Union["Commit", None], read_only: bool
) -> SubmoduleConfigParser:
"""
:return:
Config parser constrained to our submodule in read or write mode
:raise IOError:
If the ``.gitmodules`` file cannot be found, either locally or in the
repository at the given parent commit. Otherwise the exception would be
delayed until the first access of the config parser.
"""
parent_matches_head = True
if parent_commit is not None:
try:
parent_matches_head = repo.head.commit == parent_commit
except ValueError:
# We are most likely in an empty repository, so the HEAD doesn't point
# to a valid ref.
pass
# END handle parent_commit
fp_module: Union[str, BytesIO]
if not repo.bare and parent_matches_head and repo.working_tree_dir:
fp_module = osp.join(repo.working_tree_dir, cls.k_modules_file)
else:
assert parent_commit is not None, "need valid parent_commit in bare repositories"
try:
fp_module = cls._sio_modules(parent_commit)
except KeyError as e:
raise IOError(
"Could not find %s file in the tree of parent commit %s" % (cls.k_modules_file, parent_commit)
) from e
# END handle exceptions
# END handle non-bare working tree
if not read_only and (repo.bare or not parent_matches_head):
raise ValueError("Cannot write blobs of 'historical' submodule configurations")
# END handle writes of historical submodules
return SubmoduleConfigParser(fp_module, read_only=read_only, merge_includes=False)
def _clear_cache(self) -> None:
"""Clear the possibly changed values."""
for name in self._cache_attrs:
try:
delattr(self, name)
except AttributeError:
pass
# END try attr deletion
# END for each name to delete
@classmethod
def _sio_modules(cls, parent_commit: "Commit") -> BytesIO:
"""
:return:
Configuration file as :class:`~io.BytesIO` - we only access it through the
respective blob's data
"""
sio = BytesIO(parent_commit.tree[cls.k_modules_file].data_stream.read())
sio.name = cls.k_modules_file
return sio
def _config_parser_constrained(self, read_only: bool) -> SectionConstraint:
""":return: Config parser constrained to our submodule in read or write mode"""
try:
pc = self.parent_commit
except ValueError:
pc = None
# END handle empty parent repository
parser = self._config_parser(self.repo, pc, read_only)
parser.set_submodule(self)
return SectionConstraint(parser, sm_section(self.name))
@classmethod
def _validated_name(cls, name: str) -> str:
if (
not name
or name.startswith(("/", "\\"))
or ntpath.splitdrive(name)[0]
or ".." in name.replace("\\", "/").split("/")
):
raise ValueError("Invalid submodule name %r" % name)
return name
@classmethod
def _module_abspath(cls, parent_repo: "Repo", path: PathLike, name: str) -> PathLike:
name = cls._validated_name(name)
if cls._need_gitfile_submodules(parent_repo.git):
return osp.join(parent_repo.git_dir, "modules", name)
if parent_repo.working_tree_dir:
return osp.join(parent_repo.working_tree_dir, path)
raise NotADirectoryError()
@classmethod
def _clone_repo(
cls,
repo: "Repo",
url: str,
path: PathLike,
name: str,
allow_unsafe_options: bool = False,
allow_unsafe_protocols: bool = False,
**kwargs: Any,
) -> "Repo":
"""
:return:
:class:`~git.repo.base.Repo` instance of newly cloned repository.
:param repo:
Our parent repository.
:param url:
URL to clone from.
:param path:
Repository-relative path to the submodule checkout location.
:param name:
Canonical name of the submodule.
:param allow_unsafe_protocols:
Allow unsafe protocols to be used, like ``ext``.
:param allow_unsafe_options:
Allow unsafe options to be used, like ``--upload-pack``.
:param kwargs:
Additional arguments given to :manpage:`git-clone(1)`.
"""
module_abspath = cls._module_abspath(repo, path, name)
module_checkout_path = module_abspath
if cls._need_gitfile_submodules(repo.git):
if not allow_unsafe_options:
Git.check_unsafe_options(Git._option_candidates([], kwargs), repo.unsafe_git_clone_options)
multi_options = kwargs.get("multi_options")
if multi_options:
Git.check_unsafe_options(
shlex.split(" ".join(cast("Sequence[str]", multi_options))),
repo.unsafe_git_clone_options,
)
allow_unsafe_options = True
kwargs["separate_git_dir"] = module_abspath
module_abspath_dir = osp.dirname(module_abspath)
if not osp.isdir(module_abspath_dir):
os.makedirs(module_abspath_dir)
module_checkout_path = osp.join(repo.working_tree_dir, path) # type: ignore[arg-type]
if url.startswith("../"):
remote_name = cast("RemoteReference", repo.active_branch.tracking_branch()).remote_name
repo_remote_url = repo.remote(remote_name).url
url = os.path.join(repo_remote_url, url)
clone = git.Repo.clone_from(
url,
module_checkout_path,
allow_unsafe_options=allow_unsafe_options,
allow_unsafe_protocols=allow_unsafe_protocols,
**kwargs,
)
if cls._need_gitfile_submodules(repo.git):
cls._write_git_file_and_module_config(module_checkout_path, module_abspath)
return clone
@classmethod
def _to_relative_path(cls, parent_repo: "Repo", path: PathLike) -> PathLike:
""":return: A path guaranteed to be relative to the given parent repository
:raise ValueError:
If path is not contained in the parent repository's working tree.
"""
if parent_repo.working_tree_dir:
path = _to_relative_path(parent_repo.working_tree_dir, path)
else:
path = to_native_path_linux(path)
if path.endswith("/"):
path = path[:-1]
if not path or path == ".":
raise ValueError("Submodule checkout path must not be the repository root")
return path
@property
def abspath(self) -> PathLike:
root = self.repo.working_tree_dir
if root is None:
return super().abspath
path = root
for component in os.fspath(self._to_relative_path(self.repo, self.path)).split("/"):
path = join_path_native(path, component)
if osp.islink(path):
raise ValueError("Submodule checkout path %r contains a symbolic link" % self.path)
return path
@classmethod
def _write_git_file_and_module_config(cls, working_tree_dir: PathLike, module_abspath: PathLike) -> None:
"""Write a ``.git`` file containing a (preferably) relative path to the actual
git module repository.
It is an error if the `module_abspath` cannot be made into a relative path,
relative to the `working_tree_dir`.
:note:
This will overwrite existing files!
:note:
As we rewrite both the git file as well as the module configuration, we
might fail on the configuration and will not roll back changes done to the
git file. This should be a non-issue, but may easily be fixed if it becomes
one.
:param working_tree_dir:
Directory to write the ``.git`` file into.
:param module_abspath:
Absolute path to the bare repository.
"""
git_file = osp.join(working_tree_dir, ".git")
rela_path = osp.relpath(module_abspath, start=working_tree_dir)
if sys.platform == "win32" and osp.isfile(git_file):
os.remove(git_file)
with open(git_file, "wb") as fp:
fp.write(("gitdir: %s" % rela_path).encode(defenc))
with GitConfigParser(osp.join(module_abspath, "config"), read_only=False, merge_includes=False) as writer:
writer.set_value(
"core",
"worktree",
to_native_path_linux(osp.relpath(working_tree_dir, start=module_abspath)),
)
# { Edit Interface
@classmethod
def add(
cls,
repo: "Repo",
name: str,
path: PathLike,
url: Union[str, None] = None,
branch: Union[str, None] = None,
no_checkout: bool = False,
depth: Union[int, None] = None,
env: Union[Mapping[str, str], None] = None,
clone_multi_options: Union[Sequence[TBD], None] = None,
allow_unsafe_options: bool = False,
allow_unsafe_protocols: bool = False,
) -> "Submodule":
"""Add a new submodule to the given repository. This will alter the index as
well as the ``.gitmodules`` file, but will not create a new commit. If the
submodule already exists, no matter if the configuration differs from the one
provided, the existing submodule will be returned.
:param repo:
Repository instance which should receive the submodule.
:param name:
The name/identifier for the submodule.
:param path:
Repository-relative or absolute path at which the submodule should be
located.
It will be created as required during the repository initialization.
:param url:
``git clone ...``-compatible URL. See :manpage:`git-clone(1)` for more
information. If ``None``, the repository is assumed to exist, and the URL of
the first remote is taken instead. This is useful if you want to make an
existing repository a submodule of another one.
:param branch:
Name of branch at which the submodule should (later) be checked out. The
given branch must exist in the remote repository, and will be checked out
locally as a tracking branch.
It will only be written into the configuration if it not ``None``, which is
when the checked out branch will be the one the remote HEAD pointed to.
The result you get in these situation is somewhat fuzzy, and it is
recommended to specify at least ``master`` here.
Examples are ``master`` or ``feature/new``.
:param no_checkout:
If ``True``, and if the repository has to be cloned manually, no checkout
will be performed.
:param depth:
Create a shallow clone with a history truncated to the specified number of
commits.
:param env:
Optional dictionary containing the desired environment variables.
Note: Provided variables will be used to update the execution environment
for ``git``. If some variable is not specified in `env` and is defined in
attr:`os.environ`, the value from attr:`os.environ` will be used. If you
want to unset some variable, consider providing an empty string as its
value.
:param clone_multi_options:
A list of clone options. Please see
:meth:`Repo.clone <git.repo.base.Repo.clone>` for details.
:param allow_unsafe_protocols:
Allow unsafe protocols to be used, like ``ext``.
:param allow_unsafe_options:
Allow unsafe options to be used, like ``--upload-pack``.
:return:
The newly created :class:`Submodule` instance.
:note:
Works atomically, such that no change will be done if, for example, the
repository update fails.
"""
if repo.bare:
raise InvalidGitRepositoryError("Cannot add submodules to bare repositories")
# END handle bare repos
cls._validated_name(name)
path = cls._to_relative_path(repo, path)
# Ensure we never put backslashes into the URL, as might happen on Windows.
if url is not None:
url = to_native_path_linux(url)
# END ensure URL correctness
# INSTANTIATE INTERMEDIATE SM
sm = cls(
repo,
cls.NULL_BIN_SHA,
cls.k_default_mode,
path,
name,
url="invalid-temporary",
)
if sm.exists():
# Reretrieve submodule from tree.
try:
sm = repo.head.commit.tree[os.fspath(path)]
sm._name = name
return sm
except KeyError:
# Could only be in index.
index = repo.index
entry = index.entries[index.entry_key(path, 0)]
sm.binsha = entry.binsha
return sm
# END handle exceptions
# END handle existing
# fake-repo - we only need the functionality on the branch instance.
br = git.Head(repo, git.Head.to_full_path(str(branch) or cls.k_head_default))
has_module = sm.module_exists()
branch_is_default = branch is None
if has_module and url is not None:
if url not in [r.url for r in sm.module().remotes]:
raise ValueError(
"Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.abspath)
)
# END check url
# END verify urls match
mrepo: Union[Repo, None] = None
if url is None:
if not has_module:
raise ValueError("A URL was not given and a repository did not exist at %s" % path)
# END check url
mrepo = sm.module()
# assert isinstance(mrepo, git.Repo)
urls = [r.url for r in mrepo.remotes]
if not urls:
raise ValueError("Didn't find any remote url in repository at %s" % sm.abspath)
# END verify we have url
url = urls[0]
else:
# Clone new repo.
kwargs: Dict[str, Union[bool, int, str, Sequence[TBD]]] = {"n": no_checkout}
if not branch_is_default:
kwargs["b"] = br.name
# END setup checkout-branch
if depth:
if isinstance(depth, int):
kwargs["depth"] = depth
else:
raise ValueError("depth should be an integer")
if clone_multi_options:
kwargs["multi_options"] = clone_multi_options
# _clone_repo(cls, repo, url, path, name, **kwargs):
mrepo = cls._clone_repo(
repo,
url,
path,
name,
env=env,
allow_unsafe_options=allow_unsafe_options,
allow_unsafe_protocols=allow_unsafe_protocols,
**kwargs,
)
# END verify url
## See #525 for ensuring git URLs in config-files are valid under Windows.
url = Git.polish_url(url, expand_vars=False)
# It's important to add the URL to the parent config, to let `git submodule` know.
# Otherwise there is a '-' character in front of the submodule listing:
# a38efa84daef914e4de58d1905a500d8d14aaf45 mymodule (v0.9.0-1-ga38efa8)
# -a38efa84daef914e4de58d1905a500d8d14aaf45 submodules/intermediate/one
writer: Union[GitConfigParser, SectionConstraint]
with sm.repo.config_writer() as writer:
writer.set_value(sm_section(name), "url", url)
# Update configuration and index.
index = sm.repo.index
with sm.config_writer(index=index, write=False) as writer:
writer.set_value("url", url)
writer.set_value("path", path)
sm._url = url
if not branch_is_default:
# Store full path.
writer.set_value(cls.k_head_option, br.path)
sm._branch_path = br.path
# We deliberately assume that our head matches our index!
if mrepo:
sm.binsha = mrepo.head.commit.binsha
index.add([sm], write=True)
return sm
def update(
self,
recursive: bool = False,
init: bool = True,
to_latest_revision: bool = False,
progress: Union["UpdateProgress", None] = None,
dry_run: bool = False,
force: bool = False,
keep_going: bool = False,
env: Union[Mapping[str, str], None] = None,
clone_multi_options: Union[Sequence[TBD], None] = None,
allow_unsafe_options: bool = False,
allow_unsafe_protocols: bool = False,
) -> "Submodule":
"""Update the repository of this submodule to point to the checkout we point at
with the binsha of this instance.
:param recursive:
If ``True``, we will operate recursively and update child modules as well.
:param init:
If ``True``, the module repository will be cloned into place if necessary.
:param to_latest_revision:
If ``True``, the submodule's sha will be ignored during checkout. Instead,
the remote will be fetched, and the local tracking branch updated. This only
works if we have a local tracking branch, which is the case if the remote
repository had a master branch, or if the ``branch`` option was specified
for this submodule and the branch existed remotely.
:param progress:
:class:`UpdateProgress` instance, or ``None`` if no progress should be
shown.
:param dry_run:
If ``True``, the operation will only be simulated, but not performed.
All performed operations are read-only.
:param force:
If ``True``, we may reset heads even if the repository in question is dirty.
Additionally we will be allowed to set a tracking branch which is ahead of
its remote branch back into the past or the location of the remote branch.
This will essentially 'forget' commits.
If ``False``, local tracking branches that are in the future of their
respective remote branches will simply not be moved.
:param keep_going:
If ``True``, we will ignore but log all errors, and keep going recursively.
Unless `dry_run` is set as well, `keep_going` could cause
subsequent/inherited errors you wouldn't see otherwise.
In conjunction with `dry_run`, it can be useful to anticipate all errors
when updating submodules.
:param env:
Optional dictionary containing the desired environment variables.
Note: Provided variables will be used to update the execution environment
for ``git``. If some variable is not specified in `env` and is defined in
attr:`os.environ`, value from attr:`os.environ` will be used.
If you want to unset some variable, consider providing the empty string as
its value.
:param clone_multi_options:
List of :manpage:`git-clone(1)` options.
Please see :meth:`Repo.clone <git.repo.base.Repo.clone>` for details.
They only take effect with the `init` option.
:param allow_unsafe_protocols:
Allow unsafe protocols to be used, like ``ext``.
:param allow_unsafe_options:
Allow unsafe options to be used, like ``--upload-pack``.
:note:
Does nothing in bare repositories.
:note:
This method is definitely not atomic if `recursive` is ``True``.
:return:
self
"""
if self.repo.bare:
return self
# END pass in bare mode
if progress is None:
progress = UpdateProgress()
# END handle progress
prefix = ""
if dry_run:
prefix = "DRY-RUN: "
# END handle prefix
mrepo = None
# END init mrepo
def fetch_remotes(module_repo: "Repo") -> None:
rmts = module_repo.remotes
len_rmts = len(rmts)
for i, remote in enumerate(rmts):
op = FETCH
if i == 0:
op |= BEGIN
# END handle start
progress.update(
op,
i,
len_rmts,
prefix + "Fetching remote %s of submodule %r" % (remote, self.name),
)
# ===============================
if not dry_run:
remote.fetch(progress=progress)
# END handle dry-run
# ===============================
if i == len_rmts - 1:
op |= END
# END handle end
progress.update(
op,
i,
len_rmts,
prefix + "Done fetching remote of submodule %r" % self.name,
)
# END fetch new data
try:
self._validated_name(self.name)
# ENSURE REPO IS PRESENT AND UP-TO-DATE
#######################################
try:
mrepo = self.module()
fetch_remotes(mrepo)
except InvalidGitRepositoryError:
mrepo = None
if not init:
return self
# END early abort if init is not allowed
checkout_module_abspath = self.abspath
module_abspath = self._module_abspath(self.repo, self.path, self.name)
# ``git submodule deinit`` leaves the repository in
# ``.git/modules`` and empties the checkout. Reconnect that retained
# repository instead of trying to clone over it.
if not dry_run and osp.isdir(module_abspath):
try:
git.Repo(module_abspath)
except InvalidGitRepositoryError:
pass
else:
if osp.lexists(checkout_module_abspath) and (
osp.islink(checkout_module_abspath)
or not osp.isdir(checkout_module_abspath)
or os.listdir(checkout_module_abspath)
):
raise OSError(
"Module directory at %r does already exist and is non-empty" % checkout_module_abspath
)
os.makedirs(checkout_module_abspath, exist_ok=True)
self._write_git_file_and_module_config(checkout_module_abspath, module_abspath)
mrepo = git.Repo(checkout_module_abspath)
mrepo.head.reset(mrepo.head.commit, index=True, working_tree=True)
fetch_remotes(mrepo)
with self.repo.config_writer() as writer:
writer.set_value(sm_section(self.name), "url", self.url)
if mrepo is None:
# There is no git-repository yet - but delete empty paths.
if not dry_run and osp.isdir(checkout_module_abspath):
try:
os.rmdir(checkout_module_abspath)
except OSError as e:
raise OSError(
"Module directory at %r does already exist and is non-empty" % checkout_module_abspath
) from e
# END handle directory removal
# Don't check it out at first - nonetheless it will create a local
# branch according to the remote-HEAD if possible.
progress.update(
BEGIN | CLONE,
0,
1,
prefix
+ "Cloning url '%s' to '%s' in submodule %r" % (self.url, checkout_module_abspath, self.name),
)
if not dry_run:
if self.url.startswith("."):
url = urllib.parse.urljoin(self.repo.remotes.origin.url + "/", self.url)
else:
url = self.url
mrepo = self._clone_repo(
self.repo,
url,
self.path,
self.name,
n=True,
env=env,
multi_options=clone_multi_options,
allow_unsafe_options=allow_unsafe_options,
allow_unsafe_protocols=allow_unsafe_protocols,
)
progress.update(END | CLONE, 0, 1, prefix + "Done cloning to %s" % checkout_module_abspath)
if not dry_run:
# See whether we have a valid branch to check out.
try:
mrepo = cast("Repo", mrepo)
remote_branch = find_first_remote_branch(mrepo.remotes, self.branch_name)
local_branch = mkhead(mrepo, self.branch_path)
local_branch.set_object(Object(mrepo, self.NULL_BIN_SHA))
mrepo.head.set_reference(
local_branch,
logmsg="submodule: attaching head to %s" % local_branch,
)
mrepo.head.reference.set_tracking_branch(remote_branch)
except (IndexError, InvalidGitRepositoryError):
_logger.warning("Failed to checkout tracking branch %s", self.branch_path)
with self.repo.config_writer() as writer:
writer.set_value(sm_section(self.name), "url", self.url)
# END handle initialization
# DETERMINE SHAS TO CHECK OUT
#############################
binsha = self.binsha
hexsha = self.hexsha
is_detached = False
if mrepo is not None:
# mrepo is only set if we are not in dry-run mode or if the module
# existed.
is_detached = mrepo.head.is_detached
# END handle dry_run
if mrepo is not None and to_latest_revision:
msg_base = "Cannot update to latest revision in repository at %r as " % mrepo.working_dir
if not is_detached:
rref = mrepo.head.reference.tracking_branch()
if rref is not None:
rcommit = rref.commit
binsha = rcommit.binsha
hexsha = rcommit.hexsha
else:
_logger.error(
"%s a tracking branch was not set for local branch '%s'",
msg_base,
mrepo.head.reference,
)
# END handle remote ref
else:
_logger.error("%s there was no local tracking branch", msg_base)
# END handle detached head
# END handle to_latest_revision option
# Update the working tree.
# Handles dry_run.
if mrepo is not None and mrepo.head.commit.binsha != binsha:
# We must ensure that our destination sha (the one to point to) is in
# the future of our current head. Otherwise, we will reset changes that
# might have been done on the submodule, but were not yet pushed. We
# also handle the case that history has been rewritten, leaving no
# merge-base. In that case we behave conservatively, protecting possible
# changes the user had done.
may_reset = True
if mrepo.head.commit.binsha != self.NULL_BIN_SHA:
base_commit = mrepo.merge_base(mrepo.head.commit, hexsha)
if len(base_commit) == 0 or (base_commit[0] is not None and base_commit[0].hexsha == hexsha):
if force:
msg = "Will force checkout or reset on local branch that is possibly in the future of"
msg += " the commit it will be checked out to, effectively 'forgetting' new commits"
_logger.debug(msg)
else:
msg = "Skipping %s on branch '%s' of submodule repo '%s' as it contains un-pushed commits"
msg %= (
is_detached and "checkout" or "reset",
mrepo.head,
mrepo,
)
_logger.info(msg)
may_reset = False
# END handle force
# END handle if we are in the future
if may_reset and not force and mrepo.is_dirty(index=True, working_tree=True, untracked_files=True):
raise RepositoryDirtyError(mrepo, "Cannot reset a dirty repository")
# END handle force and dirty state
# END handle empty repo
# END verify future/past
progress.update(
BEGIN | UPDWKTREE,
0,
1,
prefix
+ "Updating working tree at %s for submodule %r to revision %s" % (self.path, self.name, hexsha),
)
if not dry_run and may_reset:
if is_detached:
# NOTE: For now we force. The user is not supposed to change
# detached submodules anyway. Maybe at some point this becomes
# an option, to properly handle user modifications - see below
# for future options regarding rebase and merge.
mrepo.git.checkout(hexsha, force=force)
else:
mrepo.head.reset(hexsha, index=True, working_tree=True)
# END handle checkout
# If we may reset/checkout.
progress.update(
END | UPDWKTREE,
0,
1,
prefix + "Done updating working tree for submodule %r" % self.name,
)
# END update to new commit only if needed
except Exception as err:
if not keep_going:
raise
_logger.error(str(err))
# END handle keep_going
# HANDLE RECURSION
##################
if recursive:
# In dry_run mode, the module might not exist.
if mrepo is not None:
You can’t perform that action at this time.