1# Licensed to the Apache Software Foundation (ASF) under one or more
2# contributor license agreements.  See the NOTICE file distributed with
3# this work for additional information regarding copyright ownership.
4# The ASF licenses this file to You under the Apache License, Version 2.0
5# (the "License"); you may not use this file except in compliance with
6# the License.  You may obtain a copy of the License at
7#
8#     http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16__all__ = [
17    'fixxpath',
18    'findtext',
19    'findattr',
20    'findall'
21]
22
23
24def fixxpath(xpath, namespace=None):
25    # ElementTree wants namespaces in its xpaths, so here we add them.
26    if not namespace:
27        return xpath
28    return '/'.join(['{%s}%s' % (namespace, e) for e in xpath.split('/')])
29
30
31def findtext(element, xpath, namespace=None, no_text_value=''):
32    """
33    :param no_text_value: Value to return if the provided element has no text
34                          value.
35    :type no_text_value: ``object``
36    """
37    value = element.findtext(fixxpath(xpath=xpath, namespace=namespace))
38
39    if value == '':
40        return no_text_value
41    return value
42
43
44def findattr(element, xpath, namespace=None):
45    return element.findtext(fixxpath(xpath=xpath, namespace=namespace))
46
47
48def findall(element, xpath, namespace=None):
49    return element.findall(fixxpath(xpath=xpath, namespace=namespace))
50