Package dogtail :: Module config :: Class _Config
[hide private]
[frames] | no frames]

Class _Config

source code

object --+
         |
        _Config

Contains configuration parameters for the dogtail run.

scratchDir(str): Directory where things like screenshots are stored.

dataDir(str): Directory where related data files are located.

logDir(str): Directory where dogtail.tc.TC*-generated logs are stored.

scriptName(str) [Read-Only]: The name of the script being run.

encoding(str) The encoding for text, used by dogtail.tc.TCString .

actionDelay(float): The delay after an action is executed.

typingDelay(float): The delay after a character is typed on the keyboard.

runInterval(float): The interval at which dogtail.utils.run() and dogtail.procedural.run() check to see if the application has started up.

runTimeout(int): The timeout after which dogtail.utils.run() and dogtail.procedural.run() give up on looking for the newly-started application.

searchBackoffDuration (float): Time in seconds for which to delay when a search fails.

searchWarningThreshold (int): Number of retries before logging the individual attempts at a search.

searchCutoffCount (int): Number of times to retry when a search fails.

defaultDelay (float): Default time in seconds to sleep when delaying.

childrenLimit (int): When there are a very large number of children of a node, only return this many, starting with the first.

debugSearching (boolean): Whether to write info on search backoff and retry to the debug log.

debugSleep (boolean): Whether to log whenever we sleep to the debug log.

debugSearchPaths (boolean): Whether we should write out debug info when running the SearchPath routines.

absoluteNodePaths (boolean): Whether we should identify nodes in the logs with long 'abcolute paths', or merely with a short 'relative path'. FIXME: give examples

ensureSensitivity (boolean): Should we check that ui nodes are sensitive (not 'greyed out') before performing actions on them? If this is True (the default) it will raise an exception if this happens. Can set to False as a workaround for apps and toolkits that don't report sensitivity properly.

debugTranslation (boolean): Whether we should write out debug information from the translation/i18n subsystem.

blinkOnActions (boolean): Whether we should blink a rectangle around a Node when an action is performed on it.

fatalErrors (boolean): Whether errors encountered in dogtail.procedural should be considered fatal. If True, exceptions will be raised. If False, warnings will be passed to the debug logger.

checkForA11y (boolean): Whether to check if accessibility is enabled. If not, just assume it is (default True).

logDebugToFile (boolean): Whether to write debug output to a log file.

logDebugToStdOut (boolean): Whether to print log output to console or not (default True).

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__setattr__(self, name, value)
x.__setattr__('name', value) <==> x.name = value
source code
 
__getattr__(self, name) source code
 
load(self, dict)
Loads values from dict, preserving any options already set that are not overridden.
source code
 
reset(self)
Resets all settings to their defaults.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
__createDir(cls, dirName, perms=0o777)
Creates a directory (if it doesn't currently exist), creating any parent directories it needs.
source code
 
_Config__createDir(cls, dirName, perms=511)
Creates a directory (if it doesn't currently exist), creating any parent directories it needs.
source code
Class Variables [hide private]
  defaults = {'absoluteNodePaths': False, 'actionDelay': 1.0, 'b...
  options = {}
  invalidValue = '__INVALID__'
Properties [hide private]
  scriptName
  encoding

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__setattr__(self, name, value)

source code 

x.__setattr__('name', value) <==> x.name = value

Overrides: object.__setattr__
(inherited documentation)

__createDir(cls, dirName, perms=0o777)
Class Method

source code 

Creates a directory (if it doesn't currently exist), creating any parent directories it needs.

If perms is None, create with python's default permissions.

_Config__createDir(cls, dirName, perms=511)
Class Method

source code 

Creates a directory (if it doesn't currently exist), creating any parent directories it needs.

If perms is None, create with python's default permissions.


Class Variable Details [hide private]

defaults

Value:
{'absoluteNodePaths': False,
 'actionDelay': 1.0,
 'baseFile': None,
 'blinkOnActions': False,
 'checkForA11y': True,
 'childrenLimit': 100,
 'configFile': None,
 'dataDir': '/tmp/dogtail-vhumpa/data/',
...

Property Details [hide private]

scriptName

Get Method:
unreachable.scriptName(self)

encoding

Get Method:
unreachable.encoding(self)