/usr/lib/python3/dist-packages/checkbox/report.py is in python3-checkbox 0.17.6-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | #
# This file is part of Checkbox.
#
# Copyright 2008 Canonical Ltd.
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox 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 Checkbox. If not, see <http://www.gnu.org/licenses/>.
#
import posixpath
from lxml import etree
from xml.dom.minidom import Document, Element, parseString
class ReportManager:
"""The central point for dumping and loading information.
This keeps references to all reports which have been added to the
instance of this manager. These reports will be able to register
handlers to understand the formats for dumping and loading actions.
"""
def __init__(self, name, version=None, stylesheet=None, schema=None):
self.name = name
self.version = version
self.stylesheet = stylesheet
self.schema = schema
self.dumps_table = {}
self.loads_table = {}
def handle_dumps(self, type, handler):
"""
Call back method for reports to register dump handlers.
"""
if type in self.dumps_table:
raise Exception("Dumps type already handled: %s" % type)
self.dumps_table[type] = handler
def handle_loads(self, type, handler):
"""
Call back method for reports to register load handlers.
"""
if type in self.loads_table:
raise Exception("Loads type already handled: %s" % type)
self.loads_table[type] = handler
def call_dumps(self, obj, node):
"""
Convenience method for reports to call the dump handler
corresponding to the type of the given object.
"""
return self.dumps_table[type(obj)](obj, node)
def call_loads(self, node):
"""
Convenience method for reports to call the load handler
corresponding to the content of the given node.
"""
if node.localName in self.loads_table:
ret = self.loads_table[node.localName](node)
elif isinstance(node, Element) and node.hasAttribute("type"):
type = node.getAttribute("type")
ret = self.loads_table[type](node)
else:
ret = self.loads_table["default"](node)
return ret
def add(self, report):
"""
Add a new report to the manager.
"""
report.register(self)
def dumps(self, obj):
"""
Dump the given object which may be a container of any objects
supported by the reports added to the manager.
"""
document = Document()
if self.stylesheet:
type = "text/xsl"
href = "file://%s" % posixpath.abspath(self.stylesheet)
style = document.createProcessingInstruction("xml-stylesheet",
"type=\"%s\" href=\"%s\"" % (type, href))
document.appendChild(style)
node = document.createElement(self.name)
document.appendChild(node)
if self.version:
node.setAttribute("version", self.version)
try:
self.call_dumps(obj, node)
except KeyError as e:
raise ValueError("Unsupported type: %s" % e)
return document
def loads(self, string):
"""
Load the given string which may be a container of any nodes
supported by the reports added to the manager.
"""
document = parseString(string)
node = document.childNodes[0]
assert(node.localName == self.name)
try:
ret = self.call_loads(document)
except KeyError as e:
raise ValueError("Unsupported type: %s" % e)
return ret
def validate(self, string):
"""
Validate the given string
"""
if not self.schema:
return False
file = open(self.schema)
try:
schema = file.read()
finally:
file.close()
relaxng_doc = etree.fromstring(schema)
relaxng = etree.RelaxNG(relaxng_doc)
doc = etree.fromstring(string)
return relaxng.validate(doc)
class Report:
"""A convenience for writing reports.
This provides a register method which will set the manager attribute
and optionally call the C{register_dumps} and C{register_loads}
methods.
"""
def _create_element(self, name, parent):
element = parent.ownerDocument.createElement(name)
parent.appendChild(element)
return element
def _create_text_node(self, text, parent):
text_node = parent.ownerDocument.createTextNode(text)
parent.appendChild(text_node)
return text_node
def register(self, manager):
self._manager = manager
if hasattr(self, "register_dumps"):
self.register_dumps()
if hasattr(self, "register_loads"):
self.register_loads()
|