Source code for logilab.common.xmlutils

# copyright 2003-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of logilab-common.
#
# logilab-common is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option) any
# later version.
#
# logilab-common 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with logilab-common.  If not, see <http://www.gnu.org/licenses/>.
"""XML utilities.

This module contains useful functions for parsing and using XML data. For the
moment, there is only one function that can parse the data inside a processing
instruction and return a Python dictionary.




"""
__docformat__ = "restructuredtext en"

import re
from typing import Dict, Optional

RE_DOUBLE_QUOTE = re.compile(r'([\w\-\.]+)="([^"]+)"')
RE_SIMPLE_QUOTE = re.compile(r"([\w\-\.]+)='([^']+)'")


def parse_pi_data(pi_data: str) -> Dict[str, Optional[str]]:
    """
    Utility function that parses the data contained in an XML
    processing instruction and returns a dictionary of keywords and their
    associated values (most of the time, the processing instructions contain
    data like ``keyword="value"``, if a keyword is not associated to a value,
    for example ``keyword``, it will be associated to ``None``).

    :param pi_data: data contained in an XML processing instruction.
    :type pi_data: unicode

    :returns: Dictionary of the keywords (Unicode strings) associated to
              their values (Unicode strings) as they were defined in the
              data.
    :rtype: dict
    """
    results = {}
    for elt in pi_data.split():
        val: Optional[str]
        double_match = RE_DOUBLE_QUOTE.match(elt)
        simple_match = RE_SIMPLE_QUOTE.match(elt)
        if double_match:
            kwd, val = double_match.groups()
        elif simple_match:
            kwd, val = simple_match.groups()
        else:
            kwd, val = elt, None
        results[kwd] = val
    return results