Return type mismatch in repo.submodule_update()

Hello everyone! repo.submodule_update is annotated to return an Iterator[Submodule] (and I hoped it might return an iterator of modified modules or something similar).

GitPython/git/repo/base.py

Lines 523 to 531 in ba5c10d

    
               def submodule_update(self, *args: Any, **kwargs: Any) -> Iterator[Submodule]: 
        
                   """Update the submodules, keeping the repository consistent as it will 
        
                   take the previous state into consideration. 
        
                   :note: 
        
                       For more information, please see the documentation of 
        
                       :meth:`RootModule.update <git.objects.submodule.root.RootModule.update>`. 
        
                   """ 
        
                   return RootModule(self).update(*args, **kwargs)

However, RootModule.update just returns self (type RootModule):

GitPython/git/objects/submodule/root.py

Lines 79 to 90 in ba5c10d

    
           def update(  # type: ignore[override] 
        
               self, 
        
               previous_commit: Union[Commit_ish, str, None] = None, 
        
               recursive: bool = True, 
        
               force_remove: bool = False, 
        
               init: bool = True, 
        
               to_latest_revision: bool = False, 
        
               progress: Union[None, "RootUpdateProgress"] = None, 
        
               dry_run: bool = False, 
        
               force_reset: bool = False, 
        
               keep_going: bool = False, 
        
           ) -> "RootModule":

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Return type mismatch in repo.submodule_update() #2077

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

	def submodule_update(self, args: Any, *kwargs: Any) -> Iterator[Submodule]:
	"""Update the submodules, keeping the repository consistent as it will
	take the previous state into consideration.

	:note:
	For more information, please see the documentation of
	:meth:`RootModule.update <git.objects.submodule.root.RootModule.update>`.
	"""
	return RootModule(self).update(args, *kwargs)

	def update( # type: ignore[override]
	self,
	previous_commit: Union[Commit_ish, str, None] = None,
	recursive: bool = True,
	force_remove: bool = False,
	init: bool = True,
	to_latest_revision: bool = False,
	progress: Union[None, "RootUpdateProgress"] = None,
	dry_run: bool = False,
	force_reset: bool = False,
	keep_going: bool = False,
	) -> "RootModule":

Search code, repositories, users, issues, pull requests...

Uh oh!

Return type mismatch in repo.submodule_update() #2077

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions