Compare commits

...
3 Commits
Author SHA1 Message Date
arcanis d3b569bfa2 Release 2.23.6 2026-10-30 16:33:14 +02:00
arcanis 64a7e9b288 docs: take note on parametrized tests 2026-10-30 16:17:07 +02:00
arcanis 5ad8a2a7d0 fix: improve parsing of escaped symbols inside string 2026-10-30 16:16:50 +02:00
9 changed files with 77 additions and 42 deletions

No files matched your search

+1
View File
@@ -222,6 +222,7 @@ Again, the most checks can be performed by `tox` command, though some additional
* On the other hand, it is allowed to change method signatures, however, it is recommended to add new parameters as optional if possible. Deprecated API can be dropped during major release.
* Enumerations (`Enum` classes) are allowed and recommended. However, it is recommended to use `StrEnum` class if there are from/to string conversions and `IntEnum` otherwise.
* `Generator` return type is not allowed. Generator functions must return generic `Iterator` object. Documentation should be described as `Yields`, however, because of pylint checks. Unfortunately, `Iterable` return type is not available for generators also, because of specific `contextlib.contextmanager` case.
* Tests must not be parametrized. It is better to write separate test, which covers specific line of code rather than testing all over again.
### Other checks
@@ -1,4 +1,4 @@
.TH AHRIMAN "1" "2026\-10\-25" "ahriman 2.23.5" "ArcH linux ReposItory MANager"
.TH AHRIMAN "1" "2026\-10\-30" "ahriman 2.23.6" "ArcH linux ReposItory MANager"
.SH NAME
ahriman \- ArcH linux ReposItory MANager
.SH SYNOPSIS
+1 -1
View File
@@ -17,4 +17,4 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
__version__ = "2.23.5"
__version__ = "2.23.6"
@@ -113,6 +113,13 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
... print(patch.key, patch.value)
"""
_ESCAPED_CHARACTERS = {
"\\$": "$",
"\\`": "`",
"\\\"": "\"",
"\\\n": "",
}
def __init__(self, stream: IO[bytes]) -> None:
"""
Args:
@@ -121,7 +128,7 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
self._content = stream.read()
@staticmethod
def _text(node: Node) -> str:
def text(node: Node) -> str:
"""
read the original source text represented by a syntax tree node
@@ -134,7 +141,7 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
return cast(bytes, node.text).decode("utf8", errors="backslashreplace")
@staticmethod
def _unquote(value: str) -> str:
def unquote(value: str) -> str:
"""
remove shell quotes and escapes from a single value
@@ -146,6 +153,37 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
"""
return "".join(shlex.split(value, comments=False, posix=True))
@staticmethod
def value(node: Node) -> str:
"""
extract a string value from a syntax tree node
Args:
node(Node): syntax tree node to extract
Returns:
str: extracted string value
"""
def unescape(source: str) -> str:
for original, replacement in PkgbuildParser._ESCAPED_CHARACTERS.items():
source = source.replace(original, replacement)
return source
if node.type == PkgbuildNodeType.Concatenation:
return "".join(PkgbuildParser.value(child) for child in node.named_children)
value = PkgbuildParser.text(node)
match node.type:
case PkgbuildNodeType.String | PkgbuildNodeType.StringContent:
if node.type == PkgbuildNodeType.String:
value = PkgbuildParser.unquote(value)
# protect escaped backslashes from being interpreted a second time.
return "\\".join(unescape(part) for part in value.split("\\\\"))
case PkgbuildNodeType.Number | PkgbuildNodeType.RawString | PkgbuildNodeType.Word:
return PkgbuildParser.unquote(value)
case _:
return value
def _assignment(self, node: Node) -> PkgbuildPatch:
"""
convert an assignment node
@@ -156,10 +194,8 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
Returns:
PkgbuildPatch: parsed assignment
"""
name = cast(Node, node.child_by_field_name(PkgbuildNodeField.Name))
value = cast(Node, node.child_by_field_name(PkgbuildNodeField.Value))
key = self._text(name)
key = self.text(cast(Node, node.child_by_field_name(PkgbuildNodeField.Name)))
value = node.child_by_field_name(PkgbuildNodeField.Value)
# bash permits assignments without a value (for example ``IFS=``).
# tree-sitter represents those assignments without a value node.
if value is None:
@@ -173,7 +209,7 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
return PkgbuildPatch(key, values)
case _:
return PkgbuildPatch(key, self._value(value))
return PkgbuildPatch(key, self.value(value))
def _expand_array(self, node: Node) -> list[str]:
"""
@@ -186,7 +222,7 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
list[str]: expanded element values
"""
if node.type != PkgbuildNodeType.Concatenation:
return [self._value(node)]
return [self.value(node)]
values = [""]
children = node.named_children
@@ -196,15 +232,15 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
Node(type=PkgbuildNodeType.Word, text=b"{"),
Node(type=PkgbuildNodeType.Word) as content,
Node(type=PkgbuildNodeType.Word, text=b"}"),
] if "," in (escaped := self._text(content).replace("\\,", ShellInterpolator.DATA_LINK_ESCAPE)):
] if "," in (escaped := self.text(content).replace("\\,", ShellInterpolator.DATA_LINK_ESCAPE)):
parts = [
self._unquote(part).replace(ShellInterpolator.DATA_LINK_ESCAPE, ",")
self.unquote(part).replace(ShellInterpolator.DATA_LINK_ESCAPE, ",")
for part in escaped.split(",")
]
children = children[3:]
case _:
parts = [self._value(children.pop(0))]
parts = [self.value(children.pop(0))]
values = [prefix + part for prefix in values for part in parts]
@@ -242,7 +278,7 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
case PkgbuildNodeType.FunctionDefinition:
name = cast(Node, node.child_by_field_name(PkgbuildNodeField.Name))
body = cast(Node, node.child_by_field_name(PkgbuildNodeField.Body))
yield PkgbuildPatch(f"{self._text(name)}()", self._text(body))
yield PkgbuildPatch(f"{self.text(name)}()", self.text(body))
case _:
# descend into statements, but skip command arguments and values
@@ -256,30 +292,6 @@ class PkgbuildParser(Iterable[PkgbuildPatch]):
):
yield from self._read(child, values)
def _value(self, node: Node) -> str:
"""
extract a string value from a syntax tree node
Args:
node(Node): syntax tree node to extract
Returns:
str: extracted string value
"""
if node.type in (PkgbuildNodeType.Concatenation, PkgbuildNodeType.String):
return "".join(self._value(child) for child in node.named_children)
value = self._text(node)
match node.type:
case PkgbuildNodeType.StringContent:
value = f'"{value}"'
case PkgbuildNodeType.Number | PkgbuildNodeType.RawString | PkgbuildNodeType.Word:
pass
case _:
return value
return self._unquote(value)
def parse(self) -> Iterator[PkgbuildPatch]:
"""
parse source and yield extracted entries
@@ -282,4 +282,12 @@ def test_parse(resource_path_root: Path) -> None:
_ver="$(cat CMakeLists.txt | grep -e SO_MAJOR_VERSION -e SO_MINOR_VERSION -e SO_BUILD_VERSION | cut -d '"' -f2 | head -n3)"
echo "$(echo ${_ver} | tr ' ' .).r$(git rev-list --count HEAD).$(git rev-parse --short HEAD)"
}"""),
PkgbuildPatch("var", "say \"hello\""),
PkgbuildPatch("var", "a\\b"),
PkgbuildPatch("var", "$name"),
PkgbuildPatch("var", "`date`"),
PkgbuildPatch("var", "firstsecond"),
PkgbuildPatch("var", "a\\qb"),
PkgbuildPatch("var", "\\$name"),
PkgbuildPatch("var", "first\nsecond"),
]
+1 -1
View File
@@ -2,7 +2,7 @@
pkgbase='ahriman'
pkgname=('ahriman' 'ahriman-core' 'ahriman-triggers' 'ahriman-web')
pkgver=2.23.5
pkgver=2.23.6
pkgrel=1
pkgdesc="ArcH linux ReposItory MANager"
arch=('any')
+4 -2
View File
@@ -65,7 +65,7 @@ digraph G {
ahriman_core_alpm_pacman [fillcolor="#9f2b04",fontcolor="#ffffff",label="ahriman\.\ncore\.\nalpm\.\npacman"];
ahriman_core_alpm_pacman_database [fillcolor="#a15035",fontcolor="#ffffff",label="ahriman\.\ncore\.\nalpm\.\npacman_database"];
ahriman_core_alpm_pacman_handle [fillcolor="#cc5933",fontcolor="#ffffff",label="ahriman\.\ncore\.\nalpm\.\npacman_handle"];
ahriman_core_alpm_pkgbuild_parser [fillcolor="#a15035",fontcolor="#ffffff",label="ahriman\.\ncore\.\nalpm\.\npkgbuild_parser"];
ahriman_core_alpm_pkgbuild_parser [fillcolor="#914830",fontcolor="#ffffff",label="ahriman\.\ncore\.\nalpm\.\npkgbuild_parser"];
ahriman_core_alpm_remote [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nalpm\.\nremote",shape="box"];
ahriman_core_alpm_remote_aur [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nalpm\.\nremote\.\naur",shape="box"];
ahriman_core_alpm_remote_official [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nalpm\.\nremote\.\nofficial",shape="box"];
@@ -567,7 +567,7 @@ digraph G {
ahriman_core_alpm_pacman_database -> ahriman_core_alpm_pacman [fillcolor="#a15035",weight="3"];
ahriman_core_alpm_pacman_handle -> ahriman_core_alpm_pacman [fillcolor="#cc5933",weight="3"];
ahriman_core_alpm_pacman_handle -> ahriman_models_package [fillcolor="#cc5933",minlen="3"];
ahriman_core_alpm_pkgbuild_parser -> ahriman_models_pkgbuild [fillcolor="#a15035",minlen="3"];
ahriman_core_alpm_pkgbuild_parser -> ahriman_models_pkgbuild [fillcolor="#914830",minlen="3"];
ahriman_core_alpm_remote -> ahriman_application_handlers_search [fillcolor="blue",minlen="3"];
ahriman_core_alpm_remote -> ahriman_core_build_tools_package_archive [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_alpm_remote -> ahriman_core_repository_repository [fillcolor="blue",minlen="2",weight="2"];
@@ -667,6 +667,7 @@ digraph G {
ahriman_core_configuration -> ahriman_application_lock [fillcolor="blue",minlen="2"];
ahriman_core_configuration -> ahriman_core_alpm_pacman [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration -> ahriman_core_alpm_pacman_database [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration -> ahriman_core_alpm_pkgbuild_parser [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration -> ahriman_core_archive_archive_trigger [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration -> ahriman_core_auth_auth [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration -> ahriman_core_auth_mapping [fillcolor="blue",minlen="2",weight="2"];
@@ -734,6 +735,7 @@ digraph G {
ahriman_core_configuration_configuration_multi_dict -> ahriman_core_configuration_configuration [fillcolor="#b85c3d",weight="3"];
ahriman_core_configuration_schema -> ahriman_application_handlers_validate [fillcolor="#ce603b",minlen="3"];
ahriman_core_configuration_schema -> ahriman_core_triggers_trigger [fillcolor="#ce603b",minlen="2",weight="2"];
ahriman_core_configuration_shell_interpolator -> ahriman_core_alpm_pkgbuild_parser [fillcolor="blue",minlen="2",weight="2"];
ahriman_core_configuration_shell_interpolator -> ahriman_core_configuration_configuration [fillcolor="blue",weight="3"];
ahriman_core_configuration_shell_template -> ahriman_core_configuration_shell_interpolator [fillcolor="#ce603b",weight="3"];
ahriman_core_configuration_shell_template -> ahriman_models_pkgbuild_patch [fillcolor="#ce603b",minlen="3"];
+1 -1
View File
@@ -42,5 +42,5 @@
"preview": "vite preview"
},
"type": "module",
"version": "2.23.5"
"version": "2.23.6"
}
+12
View File
@@ -113,3 +113,15 @@ pkgver() {
_ver="$(cat CMakeLists.txt | grep -e SO_MAJOR_VERSION -e SO_MINOR_VERSION -e SO_BUILD_VERSION | cut -d '"' -f2 | head -n3)"
echo "$(echo ${_ver} | tr ' ' .).r$(git rev-list --count HEAD).$(git rev-parse --short HEAD)"
}
# escapes and newlines inside double-quoted assignments
var="say \"hello\""
var="a\\b"
var="\$name"
var="\`date\`"
var="first\
second"
var="a\qb"
var="\\\\$name"
var="first
second"