systemd/tools/xml_helper.py

#!/usr/bin/env python3
# SPDX-License-Identifier: LGPL-2.1-or-later

from lxml import etree as tree


class CustomResolver(tree.Resolver):
    def resolve(self, url, _id, context):
        if 'custom-entities.ent' in url:
            return self.resolve_filename('man/custom-entities.ent', context)
        if 'ethtool-link-mode' in url:
            return self.resolve_filename('src/shared/ethtool-link-mode.xml', context)

        return None

_parser = tree.XMLParser()
# pylint: disable=no-member
_parser.resolvers.add(CustomResolver())

def xml_parse(page):
    doc = tree.parse(page, _parser)
    doc.xinclude()
    return doc

def xml_print(xml):
    return tree.tostring(xml, pretty_print=True, encoding='utf-8')
more portable python shebangs (#5816) This is useful on systems like NixOS, where python3 is not in /usr/bin/python3 as well as for people using alternative ways to install python such as virtualenv/pyenv. 2017-05-01 00:26:56 +00:00			`#!/usr/bin/env python3`
license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 04:23:58 +00:00			`# SPDX-License-Identifier: LGPL-2.1-or-later`
build-sys,man: use XML entities to substite strings This makes it easier to add substitutions to man pages, avoiding the separate transformation step. mkdir -p's are removed from the rule, because xsltproc will will create directories on it's own. All in all, two or three forks per man page are avoided, which should make things marginally faster. Unfortunately python parsers must too be tweaked to handle entities. This isn't particularly easy: with lxml a custom Resolver can be used, but the stdlib etree doesn't support external entities at all. So when running without lxml, the entities are just removed. Right now it doesn't matter, since the entities are not indexed anyway. But I intend to add indexing of filenames in the near future, and then the index generated without lxml might be missing a few lines. Oh well. 2013-03-29 18:22:27 +00:00
man: use xinclude to de-deduplicate common text I only tested with python-lxml. I'm not sure if xml.etree should be deprecated. 2014-02-12 05:55:38 +00:00			`from lxml import etree as tree`
build-sys,man: use XML entities to substite strings This makes it easier to add substitutions to man pages, avoiding the separate transformation step. mkdir -p's are removed from the rule, because xsltproc will will create directories on it's own. All in all, two or three forks per man page are avoided, which should make things marginally faster. Unfortunately python parsers must too be tweaked to handle entities. This isn't particularly easy: with lxml a custom Resolver can be used, but the stdlib etree doesn't support external entities at all. So when running without lxml, the entities are just removed. Right now it doesn't matter, since the entities are not indexed anyway. But I intend to add indexing of filenames in the near future, and then the index generated without lxml might be missing a few lines. Oh well. 2013-03-29 18:22:27 +00:00
tools: pylint xml_helper.py 2023-07-17 20:51:19 +00:00
man: use xinclude to de-deduplicate common text I only tested with python-lxml. I'm not sure if xml.etree should be deprecated. 2014-02-12 05:55:38 +00:00			`class CustomResolver(tree.Resolver):`
tools: pylint xml_helper.py 2023-07-17 20:51:19 +00:00			`def resolve(self, url, _id, context):`
man: use xinclude to de-deduplicate common text I only tested with python-lxml. I'm not sure if xml.etree should be deprecated. 2014-02-12 05:55:38 +00:00			`if 'custom-entities.ent' in url:`
			`return self.resolve_filename('man/custom-entities.ent', context)`
man: generate link mode list dynamically The entries are sorted by speed. Some fields are left empty when there is no clear value to use. The table is much longer now, but I think it's better to document the allowed values, even if some are not terribly useful. Fixes #26256. 2023-05-30 11:02:57 +00:00			`if 'ethtool-link-mode' in url:`
			`return self.resolve_filename('src/shared/ethtool-link-mode.xml', context)`
build-sys,man: use XML entities to substite strings This makes it easier to add substitutions to man pages, avoiding the separate transformation step. mkdir -p's are removed from the rule, because xsltproc will will create directories on it's own. All in all, two or three forks per man page are avoided, which should make things marginally faster. Unfortunately python parsers must too be tweaked to handle entities. This isn't particularly easy: with lxml a custom Resolver can be used, but the stdlib etree doesn't support external entities at all. So when running without lxml, the entities are just removed. Right now it doesn't matter, since the entities are not indexed anyway. But I intend to add indexing of filenames in the near future, and then the index generated without lxml might be missing a few lines. Oh well. 2013-03-29 18:22:27 +00:00
tools: pylint xml_helper.py 2023-07-17 20:51:19 +00:00			`return None`

build-sys: make lxml required when generating indices Since the manpage indices generated without lxml would be missing some parts, it doesn't make sense to keep lxml optional anymore. 2014-02-12 07:58:41 +00:00			`_parser = tree.XMLParser()`
tools: pylint xml_helper.py 2023-07-17 20:51:19 +00:00			`# pylint: disable=no-member`
build-sys: make lxml required when generating indices Since the manpage indices generated without lxml would be missing some parts, it doesn't make sense to keep lxml optional anymore. 2014-02-12 07:58:41 +00:00			`_parser.resolvers.add(CustomResolver())`
Add SPDX license headers to python scripts 2017-11-18 16:32:46 +00:00
build-sys: make lxml required when generating indices Since the manpage indices generated without lxml would be missing some parts, it doesn't make sense to keep lxml optional anymore. 2014-02-12 07:58:41 +00:00			`def xml_parse(page):`
			`doc = tree.parse(page, _parser)`
			`doc.xinclude()`
			`return doc`
Add SPDX license headers to python scripts 2017-11-18 16:32:46 +00:00
build-sys: make lxml required when generating indices Since the manpage indices generated without lxml would be missing some parts, it doesn't make sense to keep lxml optional anymore. 2014-02-12 07:58:41 +00:00			`def xml_print(xml):`
			`return tree.tostring(xml, pretty_print=True, encoding='utf-8')`