Source code for poco.sdk.Selector

# coding=utf-8
from .DefaultMatcher import DefaultMatcher
from .exceptions import NoSuchTargetException

__author__ = 'lxn3032'
__all__ = ['ISelector', 'Selector']


[docs]class ISelector(object): """ This interface defines the standard selector behavior. Selector is used for selecting the specific UI element(s) by given query expression (formal definitions are in specific implementation classes). """
[docs] def select(self, cond, multiple=False): """ Args: cond (:obj:`tuple`): query expressiom multiple (:obj:`bool`): whether or not to select the multiple elements. If set to True, the method terminates immediately once the node is found, otherwise it traverses through all nodes and then exists Returns: :obj:`list`: list <inherited from :py:class:`AbstractNode <poco.sdk.AbstractNode>`> """ raise NotImplementedError
[docs]class Selector(ISelector): """ This class implements the standard Selector interface that uses DFS algorithm to travers through tree-like hierarchy structure. It supports flexible query expressions such as parental relationship, attribute predicate, etc. Any combinations of expressions mentioned above are also allowed as the query conditions. The query expression can be defined as follows:: expr := (op0, (expr0, expr1)) expr := ('index', (expr, :obj:`int`)) expr := <other query condition> See implementation of Matcher. - ``op0`` can be one of the following ('>', '/', '-'), each operator stands for as follows:: '>': offsprings, select all offsprings matched expr1 from all roots matched expr0. '/': children, select all children matched expr1 from all roots matched expr0. '-': siblings, select all siblings matched expr1 from all roots matched expr0. '^': parent, select the parent of 1st UI element matched expr0. expr1 is always None. - ``'index'``: select specific n-th UI element from the previous results - ``others``: passes the expression to matcher Args: dumper (any implementation of :py:class:`IDumper <poco.sdk.AbstractDumper.IDumper>`): dumper for the selector matcher (any implementation of :py:class:`IMatcher <poco.sdk.DefaultMatcher.IMatcher>`): :py:class:`DefaultMatcher <poco.sdk.DefaultMatcher.DefaultMatcher>` instance by default. """ def __init__(self, dumper, matcher=None): self.dumper = dumper self.matcher = matcher or DefaultMatcher()
[docs] def getRoot(self): """ Get a default root node. Returns: default root node from the dumper. """ return self.dumper.getRoot()
[docs] def select(self, cond, multiple=False): """ See Also: :py:meth:`select <poco.sdk.Selector.ISelector.select>` method in ``ISelector``. """ return self.selectImpl(cond, multiple, self.getRoot(), 9999, True, True)
[docs] def selectImpl(self, cond, multiple, root, maxDepth, onlyVisibleNode, includeRoot): """ Selector internal implementation. TODO: add later. .. note:: This doc shows only the outline of the algorithm. Do not call this method in your code as this is an internal method. Args: cond (:obj:`tuple`): query expression multiple (:obj:`bool`): whether or not to select multiple nodes. If true, all nodes that matches the given condition will return, otherwise, only the first node matches will. root (inherited from :py:class:`AbstractNode <poco.sdk.AbstractNode>`): start traversing from the given root node maxDepth (:obj:`bool`): max traversing depth onlyVisibleNode (:obj:`bool`): If True, skip those node which visibility (the value of visible attribute) is False. includeRoot (:obj:`bool`): whether not not to include the root node if its child(ren) match(es) the node Returns: :obj:`list` <inherited from :py:class:`AbstractNode <poco.sdk.AbstractNode>`>: The same as :py:meth:`select <poco.sdk.Selector.ISelector.select>`. """ result = [] if not root: return result op, args = cond if op in ('>', '/'): # children or offsprings # 父子直系相对节点选择 parents = [root] for index, arg in enumerate(args): midResult = [] for parent in parents: if op == '/' and index != 0: _maxDepth = 1 else: _maxDepth = maxDepth # 按路径进行遍历一定要multiple为true才不会漏掉 _res = self.selectImpl(arg, True, parent, _maxDepth, onlyVisibleNode, False) [midResult.append(r) for r in _res if r not in midResult] parents = midResult result = parents elif op == '-': # sibling # 兄弟节点选择 query1, query2 = args result1 = self.selectImpl(query1, multiple, root, maxDepth, onlyVisibleNode, includeRoot) for n in result1: sibling_result = self.selectImpl(query2, multiple, n.getParent(), 1, onlyVisibleNode, includeRoot) [result.append(r) for r in sibling_result if r not in result] elif op == 'index': cond, i = args try: result = [self.selectImpl(cond, multiple, root, maxDepth, onlyVisibleNode, includeRoot)[i]] except IndexError: raise NoSuchTargetException( u'Query results index out of range. Index={} condition "{}" from root "{}".'.format(i, cond, root)) elif op == '^': # parent # only select parent of the first matched UI element query1, _ = args result1 = self.selectImpl(query1, False, root, maxDepth, onlyVisibleNode, includeRoot) if result1: parent_node = result1[0].getParent() if parent_node is not None: result = [parent_node] else: self._selectTraverse(cond, root, result, multiple, maxDepth, onlyVisibleNode, includeRoot) return result
def _selectTraverse(self, cond, node, outResult, multiple, maxDepth, onlyVisibleNode, includeRoot): # exclude invisible UI element if onlyVisibleNode specified # 剪掉不可见节点branch if onlyVisibleNode and not node.getAttr('visible'): return False if self.matcher.match(cond, node): # To select node from parent or ancestor, the parent or ancestor are excluded. # 父子/祖先后代节点选择时,默认是不包含父节点/祖先节点的 # 在下面的children循环中则需要包含,因为每个child在_selectTraverse中就当做是root if includeRoot: if node not in outResult: outResult.append(node) if not multiple: return True # When maximum search depth reached, children of this node is still require to travers. # 最大搜索深度耗尽并不表示遍历结束,其余child节点仍需遍历 if maxDepth == 0: return False maxDepth -= 1 for child in node.getChildren(): finished = self._selectTraverse(cond, child, outResult, multiple, maxDepth, onlyVisibleNode, True) if finished: return True return False