Lib.sikuli.Region.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sikulixapi Show documentation

... for visual testing and automation

There is a newer version: 2.0.5

# Copyright 2010-2016, Sikuli.org, sikulix.com
# Released under the MIT License.
# modified RaiMan 2016

import org.sikuli.script.Region as JRegion
from org.sikuli.script.Constants import FOREVER
import sys
import inspect

from org.sikuli.basics import Debug as JDebug

import Sikuli

class Debug(JDebug):
  pass

class Region(JRegion):
  # support for with:
  # override all global sikuli functions by this region's methods.
  def __enter__(self):
    Debug.logj("Region: with __enter__: %s", self.toStringShort())
    Sikuli.use(self, fromWith=True)
    return self

    # exclude_list = ['ROI']
    # self._global_funcs = {}
    # dict = sys.modules['__main__'].__dict__
    # for name in dir(self):
    #   if name in exclude_list: continue
    #   try:
    #     if not inspect.ismethod(getattr(self, name)):
    #       continue
    #   except:
    #     continue
    #   if dict.has_key(name):
    #     self._global_funcs[name] = dict[name]
    #   dict[name] = eval("self." + name)
    # return self

  def __exit__(self, type, value, traceback):
    Debug.logj("Region: with __exit__: %s", self.toStringShort())
    Sikuli.use(fromWith=True)
    return

    # dict = sys.modules['__main__'].__dict__
    # for name in self._global_funcs.keys():
    #   dict[name] = self._global_funcs[name]
    # self._global_funcs = None

  #######################################################################
  # ---- SIKULI  PUBLIC  API
  #######################################################################

  # the new Region.text() feature (Tesseract 3) returns utf8
  def text(self):
    return JRegion.text(self).encode("utf8")

  # still needed, to be backwards compatible
  def observe(self, waitTime=FOREVER, background=False):
    if background :
      return self.observeInBackground(waitTime)
    else:
      return self.observeInLine(waitTime);