refactor + pass gitlab instance

Author: valfrancois

gitlab_submodule/__init__.py

@@ -3,16 +3,16 @@
 
 __version__ = '0.1.0'
 __all__ = [
-    'GitmodulesSubmodule', 'ProjectSubmodule',
-    'list_all_project_submodules',
-    'read_gitlab_submodule',
-    'iterate_gitlab_project_submodules', 'list_gitlab_project_submodules'
+    'Submodule', 'Subproject',
+    'list_submodules',
+    'submodule_to_subproject',
+    'iterate_subprojects', 'list_subprojects'
 ]
 
-from gitlab_submodule.objects import GitmodulesSubmodule, ProjectSubmodule
+from gitlab_submodule.objects import Submodule, Subproject
 from gitlab_submodule.gitlab_submodule import (
-    list_all_project_submodules,
-    read_gitlab_submodule,
-    iterate_gitlab_project_submodules,
-    list_gitlab_project_submodules
+    list_submodules,
+    submodule_to_subproject,
+    iterate_subprojects,
+    list_subprojects
 )

gitlab_submodule/gitlab_submodule.py

@@ -1,48 +1,60 @@
-from typing import List, Optional, Iterable
+from typing import List, Optional, Iterable, Union
 
-from gitlab.v4.objects import Project
+from gitlab import Gitlab
+from gitlab.v4.objects import Project, ProjectManager
 
-from gitlab_submodule.objects import GitmodulesSubmodule, ProjectSubmodule
+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_commit import get_submodule_commit
 
 
-def list_all_project_submodules(
-        project: Project,
-        ref: Optional[str] = None) -> List[GitmodulesSubmodule]:
-    return list_project_submodules(project, ref)
+list_submodules = list_project_submodules
+
+
+def _get_project_manager(
+        gitlab_object: Union[Gitlab, ProjectManager]) -> ProjectManager:
+    if isinstance(gitlab_object, ProjectManager):
+        return gitlab_object
+    elif isinstance(gitlab_object, Gitlab):
+        return gitlab_object.projects
+    else:
+        raise TypeError('Needs a Gitlab instance or its ProjectManager')
 
 
-def read_gitlab_submodule(
-        gitmodules_submodule: GitmodulesSubmodule,
+def submodule_to_subproject(
+        gitmodules_submodule: Submodule,
+        gitlab: Union[Gitlab, ProjectManager],
         get_latest_commit_possible_if_not_found: bool = True,
         get_latest_commit_possible_ref: Optional[str] = None
-) -> ProjectSubmodule:
-    submodule_project = gitmodules_to_project(gitmodules_submodule)
+) -> Subproject:
+    submodule_project = gitmodules_to_project(gitmodules_submodule,
+                                              _get_project_manager(gitlab))
     submodule_commit, commit_is_exact = get_submodule_commit(
         gitmodules_submodule,
         submodule_project,
         get_latest_commit_possible_if_not_found,
         get_latest_commit_possible_ref)
-    return ProjectSubmodule(
+    return Subproject(
         gitmodules_submodule,
         submodule_project,
         submodule_commit,
         commit_is_exact
     )
 
 
-def iterate_gitlab_project_submodules(
+def iterate_subprojects(
         project: Project,
+        gitlab: Union[Gitlab, ProjectManager],
         ref: Optional[str] = None,
         get_latest_commit_possible_if_not_found: bool = True,
         get_latest_commit_possible_ref: Optional[str] = None
-) -> Iterable[ProjectSubmodule]:
-    for gitmodules_submodule in list_all_project_submodules(project, ref):
+) -> Iterable[Subproject]:
+    for gitmodules_submodule in list_project_submodules(project, ref):
         try:
-            yield read_gitlab_submodule(
+            yield submodule_to_subproject(
                 gitmodules_submodule,
+                _get_project_manager(gitlab),
                 get_latest_commit_possible_if_not_found,
                 get_latest_commit_possible_ref)
         except ValueError:
@@ -51,5 +63,5 @@ def iterate_gitlab_project_submodules(
             raise
 
 
-def list_gitlab_project_submodules(*args, **kwargs) -> List[ProjectSubmodule]:
-    return list(iterate_gitlab_project_submodules(*args, **kwargs))
+def list_subprojects(*args, **kwargs) -> List[Subproject]:
+    return list(iterate_subprojects(*args, **kwargs))

gitlab_submodule/gitmodules_to_project.py

@@ -3,21 +3,21 @@
 from posixpath import join, normpath
 from giturlparse import parse
 
-from gitlab import Gitlab
-from gitlab.v4.objects import Project
+from gitlab.v4.objects import Project, ProjectManager
 
-from gitlab_submodule.objects import GitmodulesSubmodule
+from gitlab_submodule.objects import Submodule
 
 
-def gitmodules_to_project(submodule: GitmodulesSubmodule) -> Project:
+def gitmodules_to_project(submodule: Submodule,
+                          project_manager: ProjectManager) -> Project:
     submodule_project_path_with_namespace = \
         _submodule_url_to_path_with_namespace(submodule.url,
                                               submodule.parent_project)
     if not submodule_project_path_with_namespace:
         raise ValueError(
             f'submodule at {submodule.url} is not hosted on Gitlab')
-    gl = Gitlab()
-    submodule_project = gl.projects.get(submodule_project_path_with_namespace)
+    submodule_project = project_manager.get(
+        submodule_project_path_with_namespace)
     return submodule_project
 
 
@@ -38,8 +38,7 @@ def _submodule_url_to_path_with_namespace(
             to_join = [parsed.owner, parsed.repo]
         path_with_namespace = join(*to_join)
         return path_with_namespace
-    except Exception as e:
-        print(e)
+    except Exception:
         # check if the submodule url is a relative path to the project path
         if url.startswith('./') or url.startswith('../'):
             # we build the path of the submodule project using the path of

gitlab_submodule/objects.py

@@ -1,7 +1,7 @@
 from gitlab.v4.objects import Project, ProjectCommit
 
 
-class GitmodulesSubmodule:
+class Submodule:
 
     def __init__(self,
                  parent_project: Project,
@@ -55,9 +55,9 @@ def lstrip(string: str, pattern: str) -> str:
         return string
 
 
-class ProjectSubmodule:
+class Subproject:
     def __init__(self,
-                 submodule: GitmodulesSubmodule,
+                 submodule: Submodule,
                  project: Project,
                  commit: ProjectCommit,
                  commit_is_exact: bool):

gitlab_submodule/read_gitmodules.py

@@ -4,24 +4,24 @@
 
 from gitlab.v4.objects import Project
 
-from gitlab_submodule.objects import GitmodulesSubmodule
+from gitlab_submodule.objects import Submodule
 
 
 def list_project_submodules(
         project: Project,
-        ref: Optional[str] = None) -> List[GitmodulesSubmodule]:
+        ref: Optional[str] = None) -> List[Submodule]:
     return list(_get_project_submodules(project, ref))
 
 
 def _get_project_submodules(
         project: Project,
-        ref: Optional[str] = None) -> Iterable[GitmodulesSubmodule]:
+        ref: Optional[str] = None) -> Iterable[Submodule]:
     gitmodules_file_content = _get_gitmodules_file_content(project, ref)
     if not gitmodules_file_content:
         return []
     for (name, url, path) in _read_gitmodules_file_content(
             gitmodules_file_content):
-        yield GitmodulesSubmodule(
+        yield Submodule(
             parent_project=project,
             parent_ref=ref if ref else project.default_branch,
             name=name,

gitlab_submodule/submodule_commit.py

@@ -4,11 +4,11 @@
 
 from gitlab.v4.objects import Project, ProjectCommit
 
-from gitlab_submodule.objects import GitmodulesSubmodule
+from gitlab_submodule.objects import Submodule
 
 
 def get_submodule_commit(
-        submodule: GitmodulesSubmodule,
+        submodule: Submodule,
         submodule_project: Project,
         get_latest_commit_possible_if_not_found: bool = True,
         get_latest_commit_possible_ref: Optional[str] = None

tests/test_gitlab_submodule.py

@@ -2,10 +2,10 @@
 
 from gitlab import Gitlab
 
-from gitlab_submodule.objects import ProjectSubmodule
-from gitlab_submodule.gitlab_submodule import (list_all_project_submodules,
-                                               read_gitlab_submodule,
-                                               list_gitlab_project_submodules)
+from gitlab_submodule.objects import Subproject
+from gitlab_submodule.gitlab_submodule import (list_submodules,
+                                               submodule_to_subproject,
+                                               list_subprojects)
 
 
 class TestSubmoduleCommit(unittest.TestCase):
@@ -14,12 +14,12 @@ def test_read_inkscape_submodule_info(self):
 
         gl = Gitlab()
         inkscape = gl.projects.get('inkscape/inkscape')
-        submodules = list_all_project_submodules(
+        submodules = list_submodules(
             inkscape,
             ref='e371b2f826adcba316f2e64bbf2f697043373d0b')
         submodule = [sub for sub in submodules if
                      sub.url == 'https://gitlab.com/inkscape/lib2geom.git'][0]
-        submodule_info: ProjectSubmodule = read_gitlab_submodule(submodule)
+        submodule_info: Subproject = submodule_to_subproject(submodule, gl)
         self.assertEqual(submodule_info.submodule, submodule)
 
         submodule_project = gl.projects.get('inkscape/lib2geom')
@@ -32,8 +32,9 @@ 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_gitlab_project_submodules(
+        submodule_info_list = list_subprojects(
             inkscape,
+            gl,
             ref='e371b2f826adcba316f2e64bbf2f697043373d0b')
         for submodule_info in submodule_info_list:
             print('- {} -> {}'.format(

tests/test_gitmodules_to_project.py

@@ -17,7 +17,7 @@ def test_get_inkscape_submodules_as_projects(self):
             ref='e371b2f826adcba316f2e64bbf2f697043373d0b'
         )
         submodule_projects = [
-            gitmodules_to_project(submodule)
+            gitmodules_to_project(submodule, gl.projects)
             for submodule in submodules
         ]
         self.assertTrue(all(