FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(submodule): add deinit method to Submodule (#2014) by mvanhorn · Pull Request #2129 · gitpython-developers/GitPython · GitHub

/ GitPython Public

feat(submodule): add deinit method to Submodule (#2014) #2129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Byron merged 2 commits into from
Jul 16, 2026
Conversation 7 Commits 2 Checks 30 Files changed
Merged

feat(submodule): add deinit method to Submodule (#2014) #2129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d702d9a
feat(submodule): add deinit method to Submodule (#2014)
mvanhorn Apr 20, 2026
0c0cc8a
review
Byron Jul 16, 2026
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
31 changes: 31 additions & 0 deletions git/objects/submodule/base.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
Callable,
Dict,
Iterator,
List,
Mapping,
Sequence,
TYPE_CHECKING,
Expand Down Expand Up @@ -1267,6 +1268,36 @@ def remove(

return self

@unbare_repo
def deinit(self, force: bool = False) -> "Submodule":
"""Run ``git submodule deinit`` on this submodule.

This is a thin wrapper around ``git submodule deinit <path>``,
which unregisters the submodule (removes its entry from
``.git/config`` and empties the working-tree directory)
without deleting the submodule from ``.gitmodules``
or its checked-out repository under ``.git/modules/``.
A subsequent :meth:`update` will re-initialize the
submodule from the retained contents.

:param force:
If ``True``, pass ``--force`` to ``git submodule deinit``. This
allows deinitialization even when the submodule's working tree has
local modifications that would otherwise block the command.

:return:
self

:note:
Doesn't work in bare repositories.
"""
args: List[str] = []
if force:
args.append("--force")
args.extend(["--", str(self.path)])
self.repo.git.submodule("deinit", *args)
return self
Comment on lines +1271 to +1299

Copilot AI Apr 20, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The new public API Submodule.deinit() isn't covered by tests. Please add a targeted unit test that asserts the underlying git invocation (e.g., by mocking submodule.repo.git.submodule) for both force=False and force=True, including verifying the -- separator and the provided path argument.

Copilot uses AI. Check for mistakes.

def set_parent_commit(self, commit: Union[Commit_ish, str, None], check: bool = True) -> "Submodule":
"""Set this instance to use the given commit whose tree is supposed to
contain the ``.gitmodules`` blob.
Expand Down
15 changes: 15 additions & 0 deletions test/test_submodule.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,21 @@ def test_iter_items_from_invalid_hash(self):
next(it)
self.assertIsNone(ctx.exception.value)

@with_rw_directory
def test_deinit_calls_git_submodule(self, rwdir):
repo = git.Repo.init(rwdir)
submodule = Submodule(repo, b"\0" * 20, name="module", path="module")

with mock.patch.object(Git, "submodule", create=True) as git_submodule:
submodule.deinit()

git_submodule.assert_called_once_with("deinit", "--", submodule.path)
git_submodule.reset_mock()

submodule.deinit(force=True)

git_submodule.assert_called_once_with("deinit", "--force", "--", submodule.path)

@with_rw_repo(k_no_subm_tag, bare=False)
def test_first_submodule(self, rwrepo):
assert len(list(rwrepo.iter_submodules())) == 0
Expand Down
Loading
Back | FazBrowse Home | New Git URL