cleaner code

Author: valfrancois

gitlab_submodule/__init__.py

@@ -14,5 +14,5 @@
     list_submodules,
     submodule_to_subproject,
     iterate_subprojects,
-    list_subprojects
+    list_subprojects,
 )

gitlab_submodule/gitlab_submodule.py

@@ -1,11 +1,11 @@
-from typing import List, Optional, Iterable, Union
+from typing import List, Optional, Generator, Union
 
 from gitlab import Gitlab
 from gitlab.v4.objects import Project, ProjectManager
 
 from gitlab_submodule.objects import Submodule, Subproject
 from gitlab_submodule.read_gitmodules import list_project_submodules
-from gitlab_submodule.gitmodules_to_project import gitmodules_to_project
+from gitlab_submodule.submodule_to_project import submodule_to_project
 from gitlab_submodule.submodule_commit import get_submodule_commit
 
 
@@ -24,12 +24,12 @@ def _get_project_manager(
 
 def submodule_to_subproject(
         gitmodules_submodule: Submodule,
-        gitlab: Union[Gitlab, ProjectManager],
-        get_latest_commit_possible_if_not_found: bool = True,
+        gl: Union[Gitlab, ProjectManager],
+        get_latest_commit_possible_if_not_found: bool = False,
         get_latest_commit_possible_ref: Optional[str] = None
 ) -> Subproject:
-    submodule_project = gitmodules_to_project(gitmodules_submodule,
-                                              _get_project_manager(gitlab))
+    submodule_project = submodule_to_project(gitmodules_submodule,
+                                             _get_project_manager(gl))
     submodule_commit, commit_is_exact = get_submodule_commit(
         gitmodules_submodule,
         submodule_project,
@@ -45,16 +45,16 @@ def submodule_to_subproject(
 
 def iterate_subprojects(
         project: Project,
-        gitlab: Union[Gitlab, ProjectManager],
+        gl: Union[Gitlab, ProjectManager],
         ref: Optional[str] = None,
-        get_latest_commit_possible_if_not_found: bool = True,
+        get_latest_commit_possible_if_not_found: bool = False,
         get_latest_commit_possible_ref: Optional[str] = None
-) -> Iterable[Subproject]:
+) -> Generator[Subproject, None, None]:
     for gitmodules_submodule in list_project_submodules(project, ref):
         try:
             yield submodule_to_subproject(
                 gitmodules_submodule,
-                _get_project_manager(gitlab),
+                _get_project_manager(gl),
                 get_latest_commit_possible_if_not_found,
                 get_latest_commit_possible_ref)
         except ValueError:

gitlab_submodule/submodule_commit.py

@@ -10,16 +10,16 @@
 def get_submodule_commit(
         submodule: Submodule,
         submodule_project: Project,
-        get_latest_commit_possible_if_not_found: bool = True,
-        get_latest_commit_possible_ref: Optional[str] = None
+        *args,
+        **kwargs
  ) -> Tuple[ProjectCommit, bool]:
     commit_id, is_exact = _get_submodule_commit_id(
         submodule.parent_project,
         submodule.path,
         submodule.parent_ref,
         submodule_project,
-        get_latest_commit_possible_if_not_found,
-        get_latest_commit_possible_ref
+        *args,
+        **kwargs
     )
     commit = submodule_project.commits.get(commit_id)
     return commit, is_exact
@@ -30,7 +30,7 @@ def _get_submodule_commit_id(
     submodule_path: str,
     ref: Optional[str] = None,
     submodule_project: Optional[Project] = None,
-    get_latest_commit_possible_if_not_found: bool = True,
+    get_latest_commit_possible_if_not_found: bool = False,
     get_latest_commit_possible_ref: Optional[str] = None
 ) -> Tuple[str, bool]:
     """This uses a trick:

gitlab_submodule/gitmodules_to_project.py renamed to gitlab_submodule/submodule_to_project.py

@@ -8,8 +8,8 @@
 from gitlab_submodule.objects import Submodule
 
 
-def gitmodules_to_project(submodule: Submodule,
-                          project_manager: ProjectManager) -> Project:
+def submodule_to_project(submodule: Submodule,
+                         project_manager: ProjectManager) -> Project:
     submodule_project_path_with_namespace = \
         _submodule_url_to_path_with_namespace(submodule.url,
                                               submodule.parent_project)

setup.py

@@ -15,7 +15,7 @@
     url='https://github.com/ValentinFrancois/python-gitlab-submodule',
     packages=['gitlab_submodule'],
     install_requires=[
-       'python-gitlab>=3.1.0',
+       'python-gitlab>=3.0.0',
        'giturlparse>=0.10.0'
     ]
 )

tests/test_gitlab_submodule.py

@@ -32,10 +32,12 @@ def test_read_inkscape_submodule_info(self):
     def test_list_all_inkscape_submodule_info(self):
         gl = Gitlab()
         inkscape = gl.projects.get('inkscape/inkscape')
-        submodule_info_list = list_subprojects(
+        subprojects = list_subprojects(
             inkscape,
             gl,
             ref='e371b2f826adcba316f2e64bbf2f697043373d0b')
-        for submodule_info in submodule_info_list:
-            print('- {} -> {}'.format(
-                submodule_info.submodule.path, submodule_info.commit.id))
+        for subproject in subprojects:
+            print('- {} ({}) -> {}'.format(
+                subproject.submodule.path,
+                subproject.project.ssh_url_to_repo,
+                subproject.commit.id))

tests/test_gitmodules_to_project.py

@@ -4,7 +4,7 @@
 from gitlab.v4.objects import Project
 
 from gitlab_submodule.read_gitmodules import list_project_submodules
-from gitlab_submodule.gitmodules_to_project import gitmodules_to_project
+from gitlab_submodule.submodule_to_project import submodule_to_project
 
 
 class TestGitmodulesToProject(unittest.TestCase):

tests/test_submodule_commit.py

@@ -4,7 +4,7 @@
 from gitlab.v4.objects import ProjectCommit
 
 from gitlab_submodule.read_gitmodules import list_project_submodules
-from gitlab_submodule.gitmodules_to_project import gitmodules_to_project
+from gitlab_submodule.submodule_to_project import submodule_to_project
 from gitlab_submodule.submodule_commit import (get_submodule_commit,
                                                _get_submodule_commit_id)