1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#!/usr/bin/env python3
"""
This script is aimed to automate repositories.xml file formatting.
<repo> nodes are sorted by name field value as a part of the process.
python version >= 3.5 is required
Copyright (C) 2018 Eugene Bright <eugene@bright.gdn>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
import sys
import argparse
from lxml import etree
import typing
parser = argparse.ArgumentParser(
"Sort overlay repos list by name")
parser.add_argument(
"path",
help="path to repositories.xml")
def find_repositories_node(
etree: etree.ElementTree
) -> etree.Element:
return repo_etree.xpath("/repositories")[0]
def find_repo_nodes(
repositories_node: etree.Element
) -> typing.List[etree.Element]:
"""
This function is designed to work
on <repositories> node, returned
by `find_repositories_node()` function.
"""
return repositories_node.xpath("./repo")
name_xpath = etree.XPath("./name/text()")
def extract_repo_name(
repo_node: etree.Element
) -> str:
"""
Extract repo name from repo node.
"""
return name_xpath(repo_node)[0]
def sort_repo_nodes(
repo_nodes: typing.List[etree.Element]
) -> None:
"""
Sort nodes list by name case insensitively.
It does work in-place on the list provided.
Python sorting algorithm is stable,
so original order must be preserved
if appropriate.
"""
repo_nodes.sort(
key=lambda node:
extract_repo_name(node)
.lower())
def reinsert_repo_nodes(
repositories_node: etree.Element,
repo_nodes: typing.List[etree.Element]
) -> None:
"""
Remove all <repo> node from <repositories>
and reinsert them back in the order
provided in the list.
"""
for repo_node in repo_nodes:
repositories_node.remove(repo_node)
for repo_node in repo_nodes:
repositories_node.append(repo_node)
def vim_modelines_fixup(
repositories_node: etree.Element
) -> None:
"""
Find, remove and reinsert modeline comment
to the end of the file.
"""
vim_comments = []
for node in repositories_node:
if (
isinstance(node, etree._Comment)
and node.text.startswith(" vim:")
):
vim_comments.append(node)
for vim_comment in vim_comments:
repositories_node.remove(vim_comment)
repositories_node.append(vim_comment)
def format_xml(
repo_etree: etree.Element
) -> str:
"""
Return text pretty-printed representation
of chosen XML node.
Works best on document root as it preserves <!DOCTYPE>.
"""
return (
etree.tostring(
repo_etree,
xml_declaration=True,
encoding="utf-8",
pretty_print=2)
.decode())
if __name__ == "__main__":
args = parser.parse_args()
repo_file = open(args.path, "rb")
repo_etree = etree.parse(
repo_file,
etree.XMLParser(remove_blank_text=True))
repositories_node = find_repositories_node(repo_etree)
repo_nodes = find_repo_nodes(repositories_node)
sort_repo_nodes(repo_nodes)
reinsert_repo_nodes(
repositories_node,
repo_nodes)
vim_modelines_fixup(repositories_node)
sys.stdout.write(
format_xml(repo_etree))
|
GitWeb