Revision: 2976
Author: pekka.klarck
Date: Wed Apr 14 04:57:11 2010
Log: merged abstractdomwrapper with the only remaining concrete
implementation
http://code.google.com/p/robotframework/source/detail?r=2976
Deleted:
/trunk/src/robot/utils/abstractdomwrapper.py
Modified:
/trunk/src/robot/utils/domwrapper.py
=======================================
--- /trunk/src/robot/utils/abstractdomwrapper.py Wed Feb 24 23:46:06 2010
+++ /dev/null
@@ -1,107 +0,0 @@
-# Copyright 2008-2009 Nokia Siemens Networks Oyj
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-from types import StringTypes
-
-
-class AbstractDomWrapper:
-
- """Base class for pydomwrapper.DomWrapper and
jydomwrapper.DomWrapper"""
-
- def __init__(self, path):
- """Public attributes. These must be set by extending classes."""
- self.source = path
- self.name = ''
- self.attrs = {}
- self.text = ''
- self.children = []
-
- def _get_root(self, path, string):
- node = self._get_dom(path, string).firstChild
- # Ignore comments, doctypes, etc. before root node
- while node.nodeType != node.ELEMENT_NODE:
- node = node.nextSibling
- return node
-
- def get_nodes(self, path):
- """Returns a list of descendants matching given 'path'.
-
- Path must be a string in format 'child_name/grandchild_name/etc'.
No
- slash is allowed at the beginning or end of the path string.
Returns an
- empty list if no matching descendants found and raises
AttributeError
- if path is invalid.
- """
- if type(path) not in StringTypes or path == '' or path[0] == '/'
or path[-1] == '/':
- raise AttributeError("Invalid path '%s'" % path)
- matches = []
- for child in self.children:
- matches += child._get_matching_elements(path.split('/'))
- return matches
-
- def get_node(self, path):
- """Similar as get_nodes but checks that exactly one node is found.
-
- Node is returned as is (i.e. not in a list) and AttributeError
risen if
- no match or more than one match found.
- """
- nodes = self.get_nodes(path)
- if len(nodes) == 0:
- raise AttributeError("No nodes matching path '%s' found" %
path)
- if len(nodes) > 1:
- raise AttributeError("Multiple nodes matching path '%s'
found" % path)
- return nodes[0]
-
- def get_attr(self, name, default=None):
- """Helper for getting node's attributes.
-
- Otherwise equivalent to 'node.attrs.get(name, default)' but raises
- an AttributeError if no value found and no default given.
- """
- ret = self.attrs.get(name, default)
- if ret is None:
- raise AttributeError("No attribute '%s' found" % name)
- return ret
-
- def __getattr__(self, name):
- """Syntactic sugar for get_nodes (e.g. dom.elem[0].subelem).
-
- Differs from get_nodes so that if not matching nodes are found an
- AttributeError is risen instead of returning an empty list."""
- nodes = self.get_nodes(name)
- if len(nodes) == 0:
- raise AttributeError("No nodes matching path '%s' found" %
name)
- return nodes
-
- def __getitem__(self, name):
- """Syntactic sugar for get_node (e.g. dom['elem/subelem'])"""
- try:
- return self.get_node(name)
- except AttributeError:
- raise IndexError("No node '%s' found" % name)
-
- def __repr__(self):
- """Return node name. Mainly for debugging purposes."""
- return self.name
-
- def _get_matching_elements(self, tokens):
- if self.name != tokens[0]:
- return []
- elif len(tokens) == 1:
- return [ self ]
- else:
- matches = []
- for child in self.children:
- matches += child._get_matching_elements(tokens[1:])
- return matches
=======================================
--- /trunk/src/robot/utils/domwrapper.py Wed Apr 14 04:42:43 2010
+++ /trunk/src/robot/utils/domwrapper.py Wed Apr 14 04:57:11 2010
@@ -24,10 +24,8 @@
except ImportError:
import elementtree.ElementTree as ET
-from abstractdomwrapper import AbstractDomWrapper
-
-
-class DomWrapper(AbstractDomWrapper):
+
+class DomWrapper(object):
"""A wrapper for Python's XML DOM for simplifying reading data from it.
@@ -41,18 +39,18 @@
internally. 'path' may actually also be an already opened file
object
(or anything accepted by ElementTree.parse).
"""
- AbstractDomWrapper.__init__(self, path)
- # This should NOT be changed to 'if node:'. See chapter Truth
Testing
- # from http://effbot.org/zone/element.htm#the-element-type
- if node is None:
- node = self._get_root(path, string)
+ node = self._get_node(path, string, node)
+ self.source = path
self.name = node.tag
self.attrs = dict(node.items())
self.text = node.text or ''
- for child in list(node):
- self.children.append(DomWrapper(path, node=child))
-
- def _get_root(self, path, string):
+ self.children = [ DomWrapper(path, node=child) for child in
list(node) ]
+
+ def _get_node(self, path, string, node):
+ # This should NOT be changed to 'if not node:'. See chapter Truth
Testing
+ # from http://effbot.org/zone/element.htm#the-element-type
+ if node is not None:
+ return node
# Cannot give path to ET.parse because it doesn't close files it
opens
# http://bugs.jython.org/issue1598
if path:
@@ -62,3 +60,76 @@
node = ET.parse(source).getroot()
source.close()
return node
+
+ def get_nodes(self, path):
+ """Returns a list of descendants matching given 'path'.
+
+ Path must be a string in format 'child_name/grandchild_name/etc'.
No
+ slash is allowed at the beginning or end of the path string.
Returns an
+ empty list if no matching descendants found and raises
AttributeError
+ if path is invalid.
+ """
+ if not isinstance(path, basestring) \
+ or path == '' or path[0] == '/' or path[-1] == '/':
+ raise AttributeError("Invalid path '%s'" % path)
+ matches = []
+ for child in self.children:
+ matches += child._get_matching_elements(path.split('/'))
+ return matches
+
+ def _get_matching_elements(self, tokens):
+ if self.name != tokens[0]:
+ return []
+ elif len(tokens) == 1:
+ return [self]
+ else:
+ matches = []
+ for child in self.children:
+ matches += child._get_matching_elements(tokens[1:])
+ return matches
+
+ def get_node(self, path):
+ """Similar as get_nodes but checks that exactly one node is found.
+
+ Node is returned as is (i.e. not in a list) and AttributeError
risen if
+ no match or more than one match found.
+ """
+ nodes = self.get_nodes(path)
+ if len(nodes) == 0:
+ raise AttributeError("No nodes matching path '%s' found" %
path)
+ if len(nodes) > 1:
+ raise AttributeError("Multiple nodes matching path '%s'
found" % path)
+ return nodes[0]
+
+ def get_attr(self, name, default=None):
+ """Helper for getting node's attributes.
+
+ Otherwise equivalent to 'node.attrs.get(name, default)' but raises
+ an AttributeError if no value found and no default given.
+ """
+ ret = self.attrs.get(name, default)
+ if ret is None:
+ raise AttributeError("No attribute '%s' found" % name)
+ return ret
+
+ def __getattr__(self, name):
+ """Syntactic sugar for get_nodes (e.g. dom.elem[0].subelem).
+
+ Differs from get_nodes so that if not matching nodes are found an
+ AttributeError is risen instead of returning an empty list.
+ """
+ nodes = self.get_nodes(name)
+ if not nodes:
+ raise AttributeError("No nodes matching path '%s' found" %
name)
+ return nodes
+
+ def __getitem__(self, name):
+ """Syntactic sugar for get_node (e.g. dom['elem/subelem'])"""
+ try:
+ return self.get_node(name)
+ except AttributeError:
+ raise IndexError("No node '%s' found" % name)
+
+ def __repr__(self):
+ """Return node name. Mainly for debugging purposes."""
+ return self.name
--
To unsubscribe, reply using "remove me" as the subject.
