Skip to content

Commit ec92614

Browse files
aureleonaureleon
committed
[MINOR] Add support for the remainder of .gitmodules attributes
- Adds all remaining .gitmodules "submodule" attributes to objects.Submodule: update, branch, ignore, shallow, fetchRecurseSubmodules (keyed as recurse) - Modifies read_gitmodules._read_gitmodules_file_content to use configparser instead of regex to simplify matching optional keys - Modifies any tests requiring direct Submodule instantiation, and adds a few extra arguments to test the extension
1 parent c56b453 commit ec92614

File tree

3 files changed

+73
-39
lines changed

3 files changed

+73
-39
lines changed

‎gitlab_submodule/objects.py‎

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,27 @@ def __init__(self,
1212
parent_ref: str,
1313
name: str,
1414
path: str,
15-
url: str):
15+
url: str,
16+
branch: Optional[str]=None,
17+
ignore: Optional[str]=None,
18+
update: Optional[str]=None,
19+
recurse: bool=False,
20+
shallow: bool=False):
21+
1622
self.parent_project = parent_project
1723
self.parent_ref = parent_ref
1824
self.name = name
1925
self.path = path
2026
self.url = url
27+
self.branch = branch
28+
self.ignore = ignore
29+
self.update = update
30+
self.recurse = recurse
31+
self.shallow = shallow
2132

2233
def keys(self):
23-
return {'parent_project', 'parent_ref', 'name', 'path', 'url'}
34+
return {'parent_project', 'parent_ref', 'name', 'path', 'url',
35+
'update', 'branch', 'ignore', 'shallow', 'recurse'}
2436

2537
def __getitem__(self, key):
2638
if key in self.keys():
@@ -31,24 +43,29 @@ def __getitem__(self, key):
3143
def __str__(self):
3244
keys = sorted(self.keys())
3345
class_part = f"<class '{self.__class__.__name__}'>"
34-
3546
def to_str(key):
3647
if isinstance(self[key], str):
3748
return f"'{self[key]}'"
3849
else:
3950
return str(self[key])
40-
4151
attributes = [f"'{key}': {to_str(key)}" for key in keys]
4252
return class_part + ' => {' + ', '.join(attributes) + '}'
4353

4454
def __repr__(self):
45-
return '{} ({}, {}, {}, {}, {})'.format(
55+
return '{} ({})'.format(
4656
self.__class__.__name__,
47-
repr(self.parent_project),
48-
f"'{self.parent_ref}'",
49-
f"'{self.name}'",
50-
f"'{self.path}'",
51-
f"'{self.url}'",
57+
", ".join((
58+
repr(self.parent_project),
59+
repr(self.parent_ref),
60+
repr(self.name),
61+
repr(self.path),
62+
repr(self.url),
63+
repr(self.branch),
64+
repr(self.ignore),
65+
repr(self.update),
66+
repr(self.recurse),
67+
repr(self.shallow),
68+
))
5269
)
5370

5471

‎gitlab_submodule/read_gitmodules.py‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
import configparser
12
import re
2-
from typing import Iterable, List, Optional, Tuple
3+
from typing import Iterable, List, Optional, Union
34

45
from gitlab.v4.objects import Project
56

@@ -18,14 +19,12 @@ def iterate_project_submodules(
1819
gitmodules_file_content = _get_gitmodules_file_content(project, ref)
1920
if not gitmodules_file_content:
2021
return []
21-
for (name, url, path) in _read_gitmodules_file_content(
22+
for kwargs in _read_gitmodules_file_content(
2223
gitmodules_file_content):
2324
yield Submodule(
2425
parent_project=project,
2526
parent_ref=ref if ref else project.default_branch,
26-
name=name,
27-
url=url,
28-
path=path)
27+
**kwargs)
2928

3029

3130
def _get_gitmodules_file_content(project: Project,
@@ -38,17 +37,24 @@ def _get_gitmodules_file_content(project: Project,
3837
except Exception:
3938
return None
4039

41-
4240
def _read_gitmodules_file_content(
43-
gitmodules_file_content: str) -> Iterable[Tuple[str, str, str]]:
44-
"""Some basic regex extractions to parse content of .gitmodules file
45-
"""
46-
name_regex = r'\[submodule "([a-zA-Z0-9\.\-/_]+)"\]'
47-
path_regex = r'path ?= ?([a-zA-Z0-9\.\-/_]+)'
48-
url_regex = r'url ?= ?([a-zA-Z0-9\.\-/_:@]+)'
49-
names = re.findall(name_regex, gitmodules_file_content)
50-
paths = re.findall(path_regex, gitmodules_file_content)
51-
urls = re.findall(url_regex, gitmodules_file_content)
52-
if not (len(names) == len(paths) == len(urls)):
53-
raise RuntimeError('Failed parsing the .gitmodules content')
54-
return zip(names, urls, paths)
41+
gitmodules_file_content: str) -> Iterable[dict[str, Union[None, bool, str]]]:
42+
"""Parses contents of .gitmodule file using configparser"""
43+
config = configparser.ConfigParser()
44+
config.optionxform = str
45+
config.read_string(gitmodules_file_content)
46+
stropts = ('branch', 'ignore', 'update')
47+
boolopts = ('recurse', 'shallow')
48+
name_regex = r'submodule "([a-zA-Z0-9\.\-/_]+)"'
49+
for section in config.sections():
50+
try:
51+
kwargs = {
52+
'name': re.match(name_regex, section).group(1),
53+
'path': config.get(section, 'path'),
54+
'url': config.get(section, 'url')
55+
}
56+
except (AttributeError, KeyError):
57+
raise RuntimeError('Failed parsing the .gitmodules contnet')
58+
kwargs.update((opt, config.get(section, opt, fallback=None)) for opt in stropts)
59+
kwargs.update((opt, config.getboolean(section, opt, fallback=False)) for opt in boolopts)
60+
yield kwargs

‎tests/test_objects.py‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,15 @@ def test_Submodule_as_dict(self):
3838
parent_ref='main',
3939
name='test_submodule',
4040
url='git@gitlab.com:test/submodule',
41-
path='include/test_submodule'
41+
path='include/test_submodule',
42+
update='rebase'
4243
)
4344
submodule_dict = dict(submodule)
44-
self.assertEqual(len(submodule_dict.keys()), 5)
45+
self.assertEqual(len(submodule_dict.keys()), 10)
4546
self.assertEqual(submodule_dict['parent_ref'], 'main')
4647
self.assertEqual(submodule_dict['name'], 'test_submodule')
48+
self.assertEqual(submodule_dict['update'], 'rebase')
49+
self.assertEqual(submodule_dict['branch'], None)
4750

4851
def test_Submodule_str(self):
4952
mock_project = DictMock()
@@ -57,11 +60,13 @@ def test_Submodule_str(self):
5760
)
5861
self.assertEqual(
5962
"<class 'Submodule'> => {"
63+
"'branch': None, 'ignore': None, "
6064
"'name': 'test_submodule', "
6165
"'parent_project': <class 'DictMock'> => {'id': 123456789}, "
6266
"'parent_ref': 'main', "
6367
"'path': 'include/test_submodule', "
64-
"'url': 'git@gitlab.com:test/submodule'}",
68+
"'recurse': False, 'shallow': False, "
69+
"'update': None, 'url': 'git@gitlab.com:test/submodule'}",
6570
str(submodule)
6671
)
6772

@@ -73,11 +78,13 @@ def test_Submodule_repr(self):
7378
parent_ref='main',
7479
name='test_submodule',
7580
url='git@gitlab.com:test/submodule',
76-
path='include/test_submodule'
81+
path='include/test_submodule',
82+
branch='development'
7783
)
7884
self.assertEqual(
7985
"Submodule ({'id': 123456789}, 'main', 'test_submodule',"
80-
" 'include/test_submodule', 'git@gitlab.com:test/submodule')",
86+
" 'include/test_submodule', 'git@gitlab.com:test/submodule',"
87+
" 'development', None, None, False, False)",
8188
repr(submodule)
8289
)
8390

@@ -157,7 +164,8 @@ def test_Subproject_str(self):
157164
parent_ref='main',
158165
name='test_submodule',
159166
url='git@gitlab.com:test/submodule',
160-
path='include/test_submodule'
167+
path='include/test_submodule',
168+
branch = "development"
161169
)
162170
mock_project = DictMock()
163171
mock_project.name = 'project'
@@ -175,11 +183,13 @@ def test_Subproject_str(self):
175183
)
176184
self.assertEqual(
177185
" 'submodule': <class 'Submodule'> => {"
186+
"'branch': 'development', 'ignore': None, "
178187
"'name': 'test_submodule', "
179188
"'parent_project': <class 'DictMock'> => {'id': '123456789'}, "
180189
"'parent_ref': 'main', "
181190
"'path': 'include/test_submodule', "
182-
"'url': 'git@gitlab.com:test/submodule'},",
191+
"'recurse': False, 'shallow': False, "
192+
"'update': None, 'url': 'git@gitlab.com:test/submodule'},",
183193
str_lines[1]
184194
)
185195
self.assertEqual(
@@ -201,7 +211,8 @@ def test_Subproject_repr(self):
201211
parent_ref='main',
202212
name='test_submodule',
203213
url='git@gitlab.com:test/submodule',
204-
path='include/test_submodule'
214+
path='include/test_submodule',
215+
branch = "development"
205216
)
206217
mock_project = DictMock()
207218
mock_project.name = 'project'
@@ -218,9 +229,9 @@ def test_Subproject_repr(self):
218229
str_lines[0]
219230
)
220231
self.assertEqual(
221-
" Submodule ({'id': '123456789'}, 'main', "
222-
"'test_submodule', 'include/test_submodule', "
223-
"'git@gitlab.com:test/submodule'),",
232+
" Submodule ({'id': '123456789'}, 'main', 'test_submodule',"
233+
" 'include/test_submodule', 'git@gitlab.com:test/submodule',"
234+
" 'development', None, None, False, False),",
224235
str_lines[1]
225236
)
226237
self.assertEqual(

0 commit comments

Comments
 (0)