lackey classes

lackey.Region class

class lackey.Region(*args)

Bases: object

ABORT = 'ABORT'

BB = 211

CREATE_X_DIRECTION_LEFT = 0

CREATE_X_DIRECTION_RIGHT = 1

CREATE_Y_DIRECTION_BOTTOM = 1

CREATE_Y_DIRECTION_TOP = 0

EAST = 220

EAST_MID = 310

LL = 210

MID_BIG = 'MID_HALF'

MID_HORIZONTAL = 'MID_HORZ'

MID_THIRD = 311

MID_VERTICAL = 'MID_VERT'

NORTH = 202

NORTH_EAST = 302

NORTH_MID = 301

NORTH_WEST = 300

PROMPT = 'PROMPT'

RETRY = 'RETRY'

RR = 201

SKIP = 'SKIP'

SOUTH = 212

SOUTH_EAST = 322

SOUTH_MID = 321

SOUTH_WEST = 320

TT = 200

WEST = 221

WEST_MID = 312

above(expand=None)

Returns a new Region above the current region with a height of expand pixels.

Does not include the current region. If range is omitted, it reaches to the top of the screen. The new region has the same width and x-position as the current region.

aboveAt(offset=0)

Returns point in the center of the region’s top side (offset to the top by negative offset)

add(l, r, t, b)

asOffset()

Returns bottom right corner as offset from top left corner

atMouse()

below(expand=None)

Returns a new Region below the current region with a height of expand pixels.

Does not include the current region. If range is omitted, it reaches to the bottom of the screen. The new region has the same width and x-position as the current region.

bottomAt(offset=0)

Returns point in the center of the region’s bottom side (offset to the bottom by offset)

click(target=None, modifiers='')

Moves the cursor to the target location and clicks the default mouse button.

clipRegionToScreen()

Returns the part of the region that is visible on a screen

If the region equals to all visible screens, returns Screen(-1). If the region is visible on multiple screens, returns the screen with the smallest ID. Returns None if the region is outside the screen.

compare(image)

Compares the region to the specified image

contains(point_or_region)

Checks if point_or_region is within this region

containsMouse()

copyTo(screen)

classmethod create(*args)

debugPreview(title='Debug')

Displays the region in a preview window.

If the region is a Match, circles the target area. If the region is larger than half the primary screen in either dimension, scales it down to half size.

delayType()

doubleClick(target=None, modifiers='')

Moves the cursor to the target location and double-clicks the default mouse button.

drag(dragFrom=None)

Starts a dragDrop operation.

Moves the cursor to the target location and clicks the mouse in preparation to drag a screen element

dragDrop(target, target2=None, modifiers='')

Performs a dragDrop operation.

Holds down the mouse button on dragFrom, moves the mouse to dragTo, and releases the mouse button.

modifiers may be a typeKeys() compatible string. The specified keys will be held during the drag-drop operation.

dropAt(dragTo=None, delay=None)

Completes a dragDrop operation

Moves the cursor to the target location, waits delay seconds, and releases the mouse button

exists(pattern, seconds=None)

Searches for an image pattern in the given region

Returns Match if pattern exists, None otherwise (does not throw exception) Sikuli supports OCR search with a text parameter. This does not (yet).

find(pattern)

Searches for an image pattern in the given region

Throws FindFailed exception if the image could not be found. Sikuli supports OCR search with a text parameter. This does not (yet).

findAll(pattern)

Searches for an image pattern in the given region

Returns Match object if pattern exists, empty array otherwise (does not throw exception). Sikuli supports OCR search with a text parameter. This does not (yet).

findAllByRow(target)

Returns an array of rows in the region (defined by the raster), each row containing all matches in that row for the target pattern.

findAllBycolumn(target)

Returns an array of columns in the region (defined by the raster), each column containing all matches in that column for the target pattern.

findAllText(text)

OCR function

findBest(pattern)

Returns the best match in the region (instead of the first match)

findText(text, timeout=None)

OCR function

get(part)

Returns a section of the region as a new region

Accepts partitioning constants, e.g. Region.NORTH, Region.NORTH_WEST, etc. Also accepts an int 200-999: * First digit: Raster (n rows by n columns) * Second digit: Row index (if equal to raster, gets the whole row) * Third digit: Column index (if equal to raster, gets the whole column)

Region.get(522) will use a raster of 5 rows and 5 columns and return the cell in the middle.

Region.get(525) will use a raster of 5 rows and 5 columns and return the row in the middle.

getAutoWaitTimeout()

Returns the time to wait for an image to appear on the screen

getBitmap()

Captures screen area of this region, at least the part that is on the screen

Returns image as numpy array

getBottomLeft()

Return the Location of the bottom left corner of this region

getBottomRight()

Return the Location of the bottom right corner of this region

getCell(row, column)

Returns the specified cell (if a raster is set for the region)

getCenter()

Return the Location of the center of this region

getClipboard()

Returns the contents of the clipboard

Can be used to pull outside text into the application, if it is first copied with the OS keyboard shortcut (e.g., “Ctrl+C”)

getCol(column, numberColumns=None)

Returns the specified column of the region (if the raster is set)

If numberColumns is provided, uses that instead of the raster

getColW()

getCols()

getEvent(name)

Returns the named event.

Removes it from the internal queue.

getEvents()

Returns a list of all events that have occurred.

Empties the internal queue.

getFindFailedResponse()

Returns the current default response to a FindFailed exception

getH()

Get the height of the region

getLastMatch()

Returns the last successful Match returned by find(), exists(), etc.

getLastMatches()

Returns the last successful set of Match objects returned by findAll()

getLastScreenImage()

Gets the last image taken on this region’s screen

getObserveScanRate()

Gets the number of times per second the observe loop should run

getRepeatWaitTime()

Gets the wait time before repeating a search

getRow(row, numberRows=None)

Returns the specified row of the region (if the raster is set)

If numberRows is provided, uses that instead of the raster

getRowH()

getRows()

getScreen()

Return an instance of the Screen object this region is inside.

Checks the top left corner of this region (if it touches multiple screens) is inside. Returns None if the region isn’t positioned in any screen.

getTarget()

By default, a region’s target is its center

getThrowException()

Returns True if an exception will be thrown for FindFailed operations, False otherwise.

getTime()

Returns the elapsed time in milliseconds to find the last match

getTopLeft()

Return the Location of the top left corner of this region

getTopRight()

Return the Location of the top right corner of this region

getTuple()

Returns the shape of the region as (x, y, w, h)

getW()

Get the width of the region

getWaitScanRate()

Get the current scan rate

getX()

Get the x-coordinate of the upper left-hand corner

getY()

Get the y-coordinate of the upper left-hand corner

grow(width, height=None)

Expands the region by width on both sides and height on the top and bottom.

If only one value is provided, expands the region by that amount on all sides. Equivalent to nearby().

hasEvents()

Check whether any events have been caught for this region

hasObserver()

Check whether at least one event is registered for this region.

The observer may or may not be running.

highlight(*args)

Highlights the region with a colored frame. Accepts the following parameters:

highlight([toEnable], [seconds], [color])

• toEnable (boolean): Enables or disables the overlay
• seconds (number): Seconds to show overlay
• color (string): Hex code (“#XXXXXX”) or color name (“black”)

hover(target=None)

Moves the cursor to the target location

inside()

Returns the same object. Included for Sikuli compatibility.

intersection()

Returns a new region that contains the overlapping portion of this region and the specified region (may be None)

isChanged(min_changed_pixels, screen_state)

Returns true if at least min_changed_pixels are different between screen_state and the current state.

isObserving()

Check whether an observer is running for this region

isRasterValid()

isRegionValid()

Returns false if the whole region is not even partially inside any screen, otherwise true

keyDown(keys)

Concatenate multiple keys to press them all down.

keyUp(keys)

Concatenate multiple keys to up them all.

left(expand=None)

Returns a new Region left of the current region with a width of expand pixels.

Does not include the current region. If range is omitted, it reaches to the left border of the screen. The new region has the same height and y-position as the current region.

leftAt(offset=0)

Returns point in the center of the region’s left side (offset to the left by negative offset)

morphTo(region)

Change shape of this region to match the given Region object

mouseDown(button=<Mock id='139888181611664'>)

Low-level mouse actions.

mouseMove(PSRML=None, dy=0)

Low-level mouse actions

mouseUp(button=<Mock id='139888181611664'>)

Low-level mouse actions

moveTo(location)

Change the upper left-hand corner to a new Location

Doesn’t change width or height

nearby(expand=50)

Returns a new Region that includes the nearby neighbourhood of the the current region.

The new region is defined by extending the current region’s dimensions all directions by range number of pixels. The center of the new region remains the same.

observe(seconds=None)

Begins the observer loop (synchronously).

Loops for seconds or until this region’s stopObserver() method is called. If seconds is None, the observer loop cycles until stopped. If this method is called while the observer loop is already running, it returns False.

Returns True if the observer could be started, False otherwise.

observeInBackground(seconds=None)

As Region.observe(), but runs in a background process, allowing the rest of your script to continue.

Note that the subprocess operates on copies of the usual objects, not the original Region object itself for example. If your event handler needs to share data with your main process, check out the documentation for the multiprocessing module to set up shared memory.

offset(location, dy=0)

Returns a new Region offset from this one by location

Width and height remain the same

onAppear(pattern, handler=None)

Registers an event to call handler when pattern appears in this region.

The handler function should take one parameter, an ObserveEvent object (see below). This event is ignored in the future unless the handler calls the repeat() method on the provided ObserveEvent object.

Returns the event’s ID as a string.

onChange(min_changed_pixels=None, handler=None)

Registers an event to call handler when at least min_changed_pixels change in this region.

(Default for min_changed_pixels is set in Settings.ObserveMinChangedPixels)

The handler function should take one parameter, an ObserveEvent object (see below). This event is ignored in the future unless the handler calls the repeat() method on the provided ObserveEvent object.

Returns the event’s ID as a string.

onVanish(pattern, handler=None)

Registers an event to call handler when pattern disappears from this region.

The handler function should take one parameter, an ObserveEvent object (see below). This event is ignored in the future unless the handler calls the repeat() method on the provided ObserveEvent object.

Returns the event’s ID as a string.

paste(*args)

Usage: paste([PSMRL], text)

If a pattern is specified, the pattern is clicked first. Doesn’t support text paths. text is pasted as is using the OS paste shortcut (Ctrl+V for Windows/Linux, Cmd+V for OS X). Note that paste() does NOT use special formatting like type().

resetScreens()

Synonym for resetMonitors

right(expand=None)

Returns a new Region right of the current region with a width of expand pixels.

Does not include the current region. If range is omitted, it reaches to the right border of the screen. The new region has the same height and y-position as the current region.

rightAt(offset=0)

Returns point in the center of the region’s right side (offset to the right by offset)

rightClick(target=None, modifiers='')

Moves the cursor to the target location and clicks the right mouse button.

saveLastScreenImage()

Saves the last image taken on this region’s screen to a temporary file

saveScreenCapture(path=None, name=None)

Saves the region’s bitmap

setActive(name)

Activates an inactive event type.

setAutoWaitTimeout(seconds)

Specify the time to wait for an image to appear on the screen

setBottomLeft(loc)

Move this region so its bottom left corner is on loc

setBottomRight(loc)

Move this region so its bottom right corner is on loc

setCenter(loc)

Move this region so it is centered on loc

setCols(columns)

Sets the number of columns in the raster (if rows have not been initialized, set to 1 as well)

setFindFailedHandler(handler)

Set a handler to receive FindFailed events (instead of triggering an exception).

setFindFailedResponse(response)

Set the response to a FindFailed exception in this region.

Can be ABORT, SKIP, PROMPT, or RETRY.

setH(h)

Set the height of the region

setImageMissingHandler(handler)

Set a handler to receive ImageMissing events (instead of triggering an exception).

setInactive(name)

The specified event is ignored until reactivated or until the observer restarts.

setLocation(location)

Change the upper left-hand corner to a new Location

Doesn’t change width or height

setObserveScanRate(scan_rate)

Set the number of times per second the observe loop should run

setROI(*args)

Set Region of Interest (same as Region.setRect())

setRaster(rows, columns)

Sets the raster for the region, allowing sections to be indexed by row/column

setRect(*args)

Sets the rect of the region. Accepts the following arguments:

setRect(rect_tuple) setRect(x, y, w, h) setRect(rect_region)

setRepeatWaitTime(wait_time)

Sets the wait time before repeating a search

setRows(rows)

Sets the number of rows in the raster (if columns have not been initialized, set to 1 as well)

setSize(w, h)

Sets the new size of the region

setThrowException(setting)

Defines whether an exception should be thrown for FindFailed operations.

setting should be True or False.

setTopLeft(loc)

Move this region so its top left corner is on loc

setTopRight(loc)

Move this region so its top right corner is on loc

setW(w)

Set the width of the region

setWaitScanRate(seconds=None)

Set this Region’s scan rate

A find op should repeat the search for the given Visual rate times per second until found or the maximum waiting time is reached.

setX(x)

Set the x-coordinate of the upper left-hand corner

setY(y)

Set the y-coordinate of the upper left-hand corner

showScreens()

Synonym for showMonitors

stopObserver()

Stops this region’s observer loop.

If this is running in a subprocess, the subprocess will end automatically.

text()

OCR method. Todo.

type(*args)

Usage: type([PSMRL], text, [modifiers])

If a pattern is specified, the pattern is clicked first. Doesn’t support text paths.

Special keys can be entered with the key name between brackets, as “{SPACE}”, or as Key.SPACE.

union()

Returns a new region that contains both this region and the specified region

wait(pattern, seconds=None)

Searches for an image pattern in the given region, given a specified timeout period

Functionally identical to find(). If a number is passed instead of a pattern, just waits the specified number of seconds. Sikuli supports OCR search with a text parameter. This does not (yet).

waitVanish(pattern, seconds=None)

Waits until the specified pattern is not visible on screen.

If seconds pass and the pattern is still visible, raises FindFailed exception. Sikuli supports OCR search with a text parameter. This does not (yet).

wheel(*args)

Clicks the wheel the specified number of ticks. Use the following parameters:

wheel([PSRML], direction, steps, [stepDelay])

write(text)

Has fancy special options. Not implemented yet.

lackey.Pattern class

class lackey.Pattern(target=None)

Bases: object

Defines a pattern based on a bitmap, similarity, and target offset

debugPreview(title='Debug')

Loads and displays the image at Pattern.path

exact()

Returns a new Pattern with a similarity threshold of 1.0

getFilename()

Returns the path to this Pattern’s bitmap

getImage()

getSimilar()

Returns the current minimum similarity

getTargetOffset()

Returns the target offset as a Location(dx, dy)

isImagePattern()

isValid()

setFilename(filename)

Set the filename of the pattern’s image (and load it)

setImage(img)

similar(similarity)

Returns a new Pattern with the specified similarity threshold

targetOffset(dx, dy)

Returns a new Pattern with the given target offset

lackey.Match class

class lackey.Match(score, target, rect)

Bases: lackey.RegionMatching.Region

Extended Region object with additional data on click target, match score

getScore()

Returns confidence score of the match

getTarget()

Returns the location of the match click target (center by default, but may be offset)

lackey.Screen class

class lackey.Screen(screenId=None)

Bases: lackey.RegionMatching.Region

Individual screen objects can be created for each monitor in a multi-monitor system.

Screens are indexed according to the system order. 0 is the primary monitor (display 1), 1 is the next monitor, etc.

Lackey also makes it possible to search all screens as a single “virtual screen,” arranged according to the system’s settings. Screen(-1) returns this virtual screen. Note that the larger your search region is, the slower your search will be, so it’s best practice to adjust your region to the particular area of the screen where you know your target will be.

Note that Sikuli is inconsistent in identifying screens. In Windows, Sikuli identifies the first hardware monitor as Screen(0) rather than the actual primary monitor. However, on OS X it follows the latter convention. We’ve opted to make Screen(0) the actual primary monitor (wherever the Start Menu/System Menu Bar is) across the board.

capture(*args)

Captures the region as an image

captureForHighlight(*args)

Captures the region as an image

closePrompt()

Not yet implemented

doPrompt(message, obs)

Not yet implemented

getBounds()

Returns bounds of screen as (x, y, w, h)

getCurrentID()

Returns screen ID

getID()

Returns screen ID

getLastScreenImageFromScreen()

Returns the last captured image from this screen

classmethod getNumberScreens()

Get the number of screens in a multi-monitor environment at the time the script is running

classmethod getPrimaryID()

Returns primary screen ID

classmethod getPrimaryScreen()

Returns the primary screen

hasPrompt()

Not yet implemented

newLocation(loc)

Creates a new location on this screen, with the same offset it would have had on the default screen

newRegion(loc, width, height)

Creates a new region on the current screen at the specified offset with the specified width and height.

primaryScreen = 0

resetMonitors()

Recalculates screen based on changed monitor setup

resetPrompt()

Not yet implemented

saveCapture(name, reg=None)

Not yet implemented

selectRegion(text='')

Not yet implemented

classmethod showMonitors()

Prints debug information about currently detected screens

showTarget()

Not yet implemented

userCapture(message='')

Not yet implemented

lackey.Location class

class lackey.Location(x, y)

Bases: object

Basic 2D point object

above(dy)

Get a new location dy pixels vertically above the current location.

below(dy)

Get a new location dy pixels vertically below the current location.

click()

copyTo(screen)

Creates a new point with the same offset on the target screen as this point has on the current screen

doubleClick()

getColor()

getMonitor()

Returns an instance of the Screen object this Location is inside.

Returns the primary screen if the Location isn’t positioned in any screen.

getOffset(loc)

Returns the offset between the given point and this point

getScreen()

Returns an instance of the Screen object this Location is inside.

Returns None if the Location isn’t positioned in any screen.

getTuple()

Returns coordinates as a tuple (for some PlatformManager methods)

getX()

Returns the X-component of the location

getY()

Returns the Y-component of the location

grow(*args)

Creates a region around the given point Valid arguments:

• grow(wh) - Creates a region centered on this point with a width and height of wh.
• grow(w, h) - Creates a region centered on this point with a width of w and height of h.
• grow(Region.CREATE_X_DIRECTION, Region.CREATE_Y_DIRECTION, w, h) - Creates a region with this point as one corner, expanding in the specified direction

hover()

left(dx)

Get a new location dx pixels horizontally to the left of the current location.

move(x, y)

Set the location of this object to the specified coordinates.

moveTo(x, y)

Set the location of this object to the specified coordinates.

offset(dx, dy)

Get a new location which is dx and dy pixels away horizontally and vertically from the current location.

right(dx)

Get a new location dx pixels horizontally to the right of the current location.

setLocation(x, y)

Set the location of this object to the specified coordinates.

translate(dx, dy)

lackey.Mouse class

class lackey.Mouse

Bases: object

Mid-level mouse routines.

LEFT

MIDDLE

RIGHT

WHEEL_DOWN = 0

WHEEL_UP = 1

at()

Gets Location of cursor

buttonDown(button=<Mock id='139888181612304'>)

Holds down the specified mouse button.

Use Mouse.LEFT, Mouse.MIDDLE, Mouse.RIGHT

buttonUp(button=<Mock id='139888181612496'>)

Releases the specified mouse button.

Use Mouse.LEFT, Mouse.MIDDLE, Mouse.RIGHT

click(loc=None, button=<Mock id='139888181612176'>)

Clicks the specified mouse button.

If loc is set, move the mouse to that Location first.

Use button constants Mouse.LEFT, Mouse.MIDDLE, Mouse.RIGHT

down(button=<Mock id='139888181612304'>)

Holds down the specified mouse button.

Use Mouse.LEFT, Mouse.MIDDLE, Mouse.RIGHT

getPos()

Gets Location of cursor

hasMoved()

Checks if mouse was moved since last mouse action

move(loc, yoff=None)

Moves cursor to specified location. Accepts the following arguments:

• move(loc) - Move cursor to Location
• move(xoff, yoff) - Move cursor to offset from current location

moveSpeed(location, seconds=0.3)

Moves cursor to specified Location over seconds.

If seconds is 0, moves the cursor immediately. Used for smooth somewhat-human-like motion.

up(button=<Mock id='139888181612496'>)

Releases the specified mouse button.

Use Mouse.LEFT, Mouse.MIDDLE, Mouse.RIGHT

wheel(direction, steps)

Clicks the wheel the specified number of steps in the given direction.

Use Mouse.WHEEL_DOWN, Mouse.WHEEL_UP

lackey.Keyboard class

class lackey.Keyboard

Bases: object

Mid-level keyboard routines. Interfaces with PlatformManager

keyDown(keys)

Accepts a string of keys (including special keys wrapped in brackets or provided by the Key or KeyModifier classes). Holds down all of them.

keyUp(keys)

Accepts a string of keys (including special keys wrapped in brackets or provided by the Key or KeyModifier classes). Releases any that are held down.

type(text, delay=0.1)

Translates a string into a series of keystrokes.

Respects Sikuli special codes, like “{ENTER}”.

lackey.App class

class lackey.App(identifier=None)

Bases: object

Allows apps to be selected by title, PID, or by starting an application directly. Can address individual windows tied to an app.

For more information, see Sikuli’s App documentation.

classmethod close(appName)

Closes the process associated with the specified app.

As a class method, accessible as App.class(appName). As an instance method, accessible as App(appName).close().

classmethod focus(appName)

Searches for exact text, case insensitive, anywhere in the window title.

Brings the matching window to the foreground.

As a class method, accessible as App.focus(appName). As an instance method, accessible as App(appName).focus().

classmethod focusedWindow()

Returns a Region corresponding to whatever window is in the foreground

classmethod getClipboard()

Gets the contents of the clipboard (as classmethod)

getName()

Returns the short name of the app as shown in the process list

getPID()

Returns the PID for the associated app (or -1, if no app is associated or the app is not running)

getWindow()

Returns the title of the main window of the currently open app.

Returns an empty string if no match could be found.

hasWindow()

Returns True if the process has a window associated, False otherwise

isRunning(waitTime=0)

If PID isn’t set yet, checks if there is a window with the specified title.

isValid()

classmethod open(executable)

Runs the specified command and returns an App linked to the generated PID.

As a class method, accessible as App.open(executable_path). As an instance method, accessible as App(executable_path).open().

classmethod pause(waitTime)

classmethod setClipboard(contents)

Sets the contents of the clipboard (as classmethod)

setUsing(params)

waitForWindow(seconds=5)

window(windowNum=0)

Returns the region corresponding to the specified window of the app.

Defaults to the first window found for the corresponding PID.

lackey.Button class

class lackey.Button

CENTER = 1

LEFT = 0

RIGHT = 2

lackey.Key class

class lackey.Key

Key codes for InputEmulation.Keyboard object.

Can be entered directly or concatenated with an existing string, e.g. type(Key.TAB)

ADD = '{ADD}'

ALT = '{ALT}'

BACKSPACE = '{BACKSPACE}'

CAPS_LOCK = '{CAPS_LOCK}'

CMD = '{CMD}'

CTRL = '{CTRL}'

DELETE = '{DELETE}'

DIVIDE = '{DIVIDE}'

DOWN = '{DOWN}'

END = '{END}'

ENTER = '{ENTER}'

ESC = '{ESC}'

F1 = '{F1}'

F10 = '{F10}'

F11 = '{F11}'

F12 = '{F12}'

F13 = '{F13}'

F14 = '{F14}'

F15 = '{F15}'

F16 = '{F16}'

F2 = '{F2}'

F3 = '{F3}'

F4 = '{F4}'

F5 = '{F5}'

F6 = '{F6}'

F7 = '{F7}'

F8 = '{F8}'

F9 = '{F9}'

HOME = '{HOME}'

INSERT = '{INSERT}'

LEFT = '{LEFT}'

META = '{META}'

MINUS = '{MINUS}'

MULTIPLY = '{MULTIPLY}'

NUM0 = '{NUM0}'

NUM1 = '{NUM1}'

NUM2 = '{NUM2}'

NUM3 = '{NUM3}'

NUM4 = '{NUM4}'

NUM5 = '{NUM5}'

NUM6 = '{NUM6}'

NUM7 = '{NUM7}'

NUM8 = '{NUM8}'

NUM9 = '{NUM9}'

NUM_LOCK = '{NUM_LOCK}'

PAGE_DOWN = '{PAGE_DOWN}'

PAGE_UP = '{PAGE_UP}'

PAUSE = '{PAUSE}'

PRINTSCREEN = '{PRINTSCREEN}'

RIGHT = '{RIGHT}'

SCROLL_LOCK = '{SCROLL_LOCK}'

SEPARATOR = '{SEPARATOR}'

SHIFT = '{SHIFT}'

SPACE = '{SPACE}'

TAB = '{TAB}'

UP = '{UP}'

WIN = '{WIN}'

lackey.KeyModifier class

class lackey.KeyModifier

Can be used with type() to modify another key, e.g. type(Key.DELETE, Key.CTRL+Key.ALT)

ALT = '{ALT}'

CMD = '{CMD}'

CTRL = '{CTRL}'

META = '{META}'

SHIFT = '{SHIFT}'

WIN = '{WIN}'

lackey.PlatformManagerWindows class

lackey.PlatformManagerWindows

alias of lackey.PlatformManagerWindows

lackey.Debug class

class lackey.DebugMaster

Bases: object

Used to create the global Debug object

error(message)

Records an Error-level log message

Uses the log path defined by Debug.setUserLogFile(). If no log file is defined, sends to STDOUT

history(message)

Records an Action-level log message

Uses the log path defined by Debug.setUserLogFile(). If no log file is defined, sends to STDOUT

info(message)

Records an Info-level log message

Uses the log path defined by Debug.setUserLogFile(). If no log file is defined, sends to STDOUT

log(level, message)

Records a Debug-level log message Uses the log path defined by Debug.setUserLogFile(). If no log file is defined, sends to STDOUT

off()

Turns off all debugging messages

on(level)

Turns on all debugging messages up to the specified level

0 = None; 1 = User;

setLogFile(filepath)

Defines the file to which output log messages should be sent.

Set to None to print to STDOUT instead.

setLogger(logger_obj)

Sets log handler to logger_obj

setLoggerAction(mthd)

Sends action messages to logger.[mthd]() for handling

setLoggerAll(mthd)

Sends all messages to logger.[mthd]() for handling

setLoggerDebug(mthd)

Sends debug messages to logger.[mthd]() for handling

setLoggerError(mthd)

Sends error messages to logger.[mthd]() for handling

setLoggerInfo(mthd)

Sends info messages to logger.[mthd]() for handling

setLoggerNoPrefix(logger_obj)

Sets log handler to logger_obj

setLoggerUser(mthd)

Sends user messages to logger.[mthd]() for handling

user(message)

Creates a user log (if user logging is turned on)

Uses the log path defined by Debug.setUserLogFile(). If no log file is defined, sends to STDOUT

Note: Does not use Java string formatting like Sikuli. Format your message with Python basestring.format() instead.

lackey.Settings class

class lackey.SettingsMaster

Bases: object

Global settings that Lackey refers to by default

ActionLogs = True

BundlePath = '/home/docs/checkouts/readthedocs.org/user_builds/lackey/envs/latest/bin'

ClickDelay = 0.0

DebugLogs = False

DelayBeforeDrag = 0.3

DelayBeforeDrop = 0.3

DelayBeforeMouseDown = 0.3

ErrorLogs = False

ImagePaths = []

InfoLogs = True

LogTime = False

MinSimilarity = 0.7

MoveMouseDelay = 0.3

OberveMinChangedPixels = 50

ObserveScanRate = 3

OcrDataPath = None

PopupLocation = None

ShowActions = False

SlowMotionDelay = 3

TypeDelay = 0.0

UserLogPrefix = 'user'

UserLogTime = True

UserLogs = True

WaitScanRate = 3

getSikuliVersion()

lackey.FindFailed class

class lackey.FindFailed(event)

Bases: exceptions.Exception

Exception: Unable to find the searched item

Sikuli Convenience Functions

lackey.sleep(seconds)

Convenience function. Pauses script for seconds.

lackey.exit(value)

Convenience function. Exits with code value.

lackey.setShowActions(value)

Convenience function. Sets “show actions” setting (True or False)

lackey.getBundlePath()

Convenience function. Returns the path of the *.sikuli bundle.

lackey.getBundleFolder()

Convenience function. Same as getBundlePath() plus the OS default path separator.

lackey.setBundlePath(path)

Convenience function. Changes the path of the *.sikuli bundle.

lackey.getImagePath()

Convenience function. Returns a list of paths to search for images.

lackey.addImagePath(new_path)

Convenience function. Adds a path to the list of paths to search for images.

Can be a URL (but must be accessible).

lackey.addHTTPImagePath(new_path)

Convenience function. Same as addImagePath().

lackey.getParentPath()

Convenience function. Returns the parent folder of the *.sikuli bundle.

lackey.getParentFolder()

Convenience function. Same as getParentPath() plus the OS default path separator.

lackey.makePath(*args)

Convenience function. Returns a path from a series of path components.

Same as os.path.join.

lackey.makeFolder(*args)

Convenience function. Same as makePath() plus the OS default path separator.

lackey.unzip(from_file, to_folder)

Convenience function.

Extracts files from the zip file fromFile into the folder toFolder.

lackey.popat(*args)

Convenience function. Sets the popup location (currently not used).

lackey.popup(text, title='Lackey Info')

Creates an info dialog with the specified text.

lackey.popError(text, title='Lackey Error')

Creates an error dialog with the specified text.

lackey.popAsk(text, title='Lackey Decision')

Creates a yes-no dialog with the specified text.

lackey.input(msg='', default='', title='Lackey Input', hidden=False)

Creates an input dialog with the specified message and default text.

If hidden, creates a password dialog instead. Returns the entered value.

lackey.inputText(message='', title='Lackey Input', lines=9, width=20, text='')

Creates a textarea dialog with the specified message and default text.

Returns the entered value.

lackey.select(message='', title='Lackey Input', options=None, default=None)

Creates a dropdown selection dialog with the specified message and options

default must be one of the options.

Returns the selected value.

lackey.popFile(title='Lackey Open File')

Creates a file selection dialog with the specified message and options.

Returns the selected file.