File: serialization_xml.py

package info (click to toggle)
jack-mixer 17-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 940 kB
  • sloc: python: 4,371; ansic: 3,089; sh: 35; xml: 3; makefile: 3
file content (95 lines) | stat: -rw-r--r-- 3,210 bytes parent folder | download | duplicates (2)
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
# This file is part of jack_mixer
#
# Copyright (C) 2006 Nedko Arnaudov <nedko@arnaudov.name>
#
# 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; version 2 of the License
#
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

import xml.dom
import xml.dom.minidom

from .serialization import SerializationBackend


class XmlSerializationError(Exception):
    pass


class InvalidDocumentTypeError(XmlSerializationError):
    pass


class XmlSerialization(SerializationBackend):
    def get_root_serialization_object(self, name):
        self.doc = xml.dom.getDOMImplementation().createDocument(
            xml.dom.EMPTY_NAMESPACE, name, None
        )
        return XmlSerializationObject(self.doc, self.doc.documentElement)

    def get_root_unserialization_object(self, name):
        if name != self.doc.documentElement.nodeName:
            return None
        return XmlSerializationObject(self.doc, self.doc.documentElement)

    def get_child_serialization_object(self, name, backend_object):
        child = self.doc.createElement(name)
        backend_object.element.appendChild(child)
        return XmlSerializationObject(self.doc, child)

    def save(self, file):
        file.write(self.doc.toprettyxml())

    def load(self, file, name):
        self.doc = xml.dom.minidom.parse(file)

        document_type = self.doc.documentElement.nodeName
        if document_type != name:
            raise InvalidDocumentTypeError(
                _("Document type '{type}' not supported.").format(type=document_type)
            )


class XmlSerializationObject:
    def __init__(self, doc, element):
        self.doc = doc
        self.element = element

    def add_property(self, name, value):
        self.add_property_as_attribute(name, value)

    def add_property_as_attribute(self, name, value):
        self.element.setAttribute(name, value)

    # def add_property_as_child_element(self, name, value):
    #    child = self.doc.createElement(name)
    #    value = self.doc.createTextNode(value)
    #    child.appendChild(value)
    #    self.element.appendChild(child)

    def get_childs(self):
        child_elements = self.element.childNodes
        childs = []
        for child in child_elements:
            if child.nodeType == child.ELEMENT_NODE:
                childs.append(XmlSerializationObject(self.doc, child))
        return childs

    def get_properties(self):
        properties = self.element.attributes
        dictionary = {}
        for i in range(properties.length):
            dictionary[properties.item(i).name] = properties.item(i).nodeValue
        return dictionary

    def serialization_name(self):
        return self.element.nodeName