Error while listing submodules

[lungothrin]

GitPython has a problem while listing submodules.

As '.gitmodules' contains all the modules have ever been registered, it becomes problematic when some of them are removed. 'repo.submodules' will fail to work in this situation, though, 'repo.iter_submodules()' still works. But when 'repo' itself is a submodule, 'repo.iter_submodules()' does not yield any result.

[Byron]

Thanks for letting me know. Would you post code or any other means to help me reproducing this issue? This will make a fix so much easier.
Also: Which version of GitPython are you using ? It should be v0.3.6 or above.
Thank you

[lungothrin]

GitPython v1.0.0

To reproduce it, just add a submodule, commit, then remove it, remove git directory is '.git/modules', too. keep the entry is '.gitmdoules'. commit again.

when the repository is a normal repository, 'repo.submodules' fail, 'repo.iter_submodules()' still works.
when the repository is a sbumodule in another repository, both will fail

from git import Repo

repo = Repo('path')
repo.submodules
for mod in repo.iter_submodules():
print mod.path

just some code like this will do the trick

[Byron]

Thank you !
It seems that 'iter_submodules()' is depending on the submodule's repository to exist. Therefore, if .git/modules is removed, this will not have the required information.
iter_submodules() will read information from .gitmodules only, and it doesn't care if the sub-module repositories are actually there.

The statements above are just my preliminary opinion, I don't know the code underneath good enough to know if this behaviour is good or not.

Can you also state which behaviour you would expect ?

[lungothrin]

It seems that 'iter_submodules()' is depending on the submodule's repository to exist. Therefore, if > > .git/modules is removed, this will not have the required information.

'.gitmodules' may contains entries of already removed submodules, when someone clone it, these repository are naturally not exist in '.git/modules'. this when the problem occurs.
'iter_submodules()' should rely on content of '.git/config'. I believe this file is always up to date.

I encounter this problem on this repository https://github.com/lungothrin/android.git, It tremendous big.
I will try to create a smaller one and get back to you

[Byron]

Thanks for the clarification. GitPython currently entirely ignores the information in .git/config regarding submodules, as I consider it redundant. From your previous explanation I should be able to reproduce the issue and better handle this case, another example will help nonetheless even though it shouldn't strictly be required.

[lungothrin]

clone this project you will get what you need to reproduce the problem. It is about 350MiB
run it against submodule 'external/chromium_org'