6a6f15707a
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a pre-PEP8 code, to use the same coding style as in Twisted. However, snake_case is more readable and it's better to follow PEP8 best practices, so it has been decided to move on full snake_case. Because Libervia has a huge codebase, this ended with a ugly mix of camelCase and snake_case. To fix that, this patch does a big refactoring by renaming every function and method (including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case. This is a massive change, and may result in some bugs.
66 lines
2.4 KiB
Python
66 lines
2.4 KiB
Python
#!/usr/bin/env python3
|
|
|
|
|
|
# jp: a SàT command line tool
|
|
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from sat.core.i18n import _
|
|
from sat_frontends.jp.constants import Const as C
|
|
|
|
def etree_parse(cmd, raw_xml, reraise=False):
|
|
"""import lxml and parse raw XML
|
|
|
|
@param cmd(CommandBase): current command instance
|
|
@param raw_xml(file, str): an XML bytestring, string or file-like object
|
|
@param reraise(bool): if True, re raise exception on parse error instead of doing a
|
|
parser.error (which terminate the execution)
|
|
@return (tuple(etree.Element, module): parsed element, etree module
|
|
"""
|
|
try:
|
|
from lxml import etree
|
|
except ImportError:
|
|
cmd.disp(
|
|
'lxml module must be installed, please install it with "pip install lxml"',
|
|
error=True,
|
|
)
|
|
cmd.host.quit(C.EXIT_ERROR)
|
|
try:
|
|
if isinstance(raw_xml, str):
|
|
parser = etree.XMLParser(remove_blank_text=True)
|
|
element = etree.fromstring(raw_xml, parser)
|
|
else:
|
|
element = etree.parse(raw_xml).getroot()
|
|
except Exception as e:
|
|
if reraise:
|
|
raise e
|
|
cmd.parser.error(
|
|
_("Can't parse the payload XML in input: {msg}").format(msg=e)
|
|
)
|
|
return element, etree
|
|
|
|
def get_payload(cmd, element):
|
|
"""Retrieve payload element and exit with and error if not found
|
|
|
|
@param element(etree.Element): root element
|
|
@return element(etree.Element): payload element
|
|
"""
|
|
if element.tag in ("item", "{http://jabber.org/protocol/pubsub}item"):
|
|
if len(element) > 1:
|
|
cmd.disp(_("<item> can only have one child element (the payload)"),
|
|
error=True)
|
|
cmd.host.quit(C.EXIT_DATA_ERROR)
|
|
element = element[0]
|
|
return element
|