Dokumentace prostoru jmen urpa

Modul urpa slouží k automatizaci procesů. ...

Třídy
class	App
	Třída reprezentující obecnou aplikaci. ...
class	AppElement
	Třída reprezentuje element GUI v aplikaci. ...
class	AppExcel
	Třída reprezentující aplikaci MS Excel. ...
class	AppIE
	Třída slouží pro správu prohlížeče Internet Explorer. ...
class	AppJavaElement
	Třída reprezentuje element GUI v Java aplikaci. ...
class	Condition
	Třída slouží pro definici podmínek k vyhledávání elementů GUI. ...
class	ConditionFactory
	Třída slouží k vytvoření instance objektu typu Condition a k definici podmínek pro vyhledávání elementů GUI v této instanci objektu. ...
class	Config
class	ElementNotFoundError
	Výjimka vyvolaná v případech, kdy nebyl požadovaný element GUI nalezen. ...
class	ExcelCells
	Třída reprezentuje jednu buňku, jeden řádek, sloupec nebo blok buněk v listu sešitu aplikace MS Excel. ...
class	ExcelWorkbook
	Třída reprezentuje sešit v aplikaci MS Excel. ...
class	ExcelWorksheet
	Třída reprezentuje jeden list v sešitu aplikace MS Excel. ...
class	JavaCondition
	Třída slouží pro definici podmínek k vyhledávání elementů GUI v Java aplikacích. ...
class	Transformation
	Pomocná třída která definuje jak se mají provádět transformace obrázků. ...
class	TransformationFactory
	Pomocná třída která definuje jak se mají provádět transformace obrázků. ...
class	VisualElement
	Třída reprezentuje vizuální element GUI v aplikaci. ...

Funkce
def	set_password (system, user, password)
	Pro uložení přihlašovacích údajů se používá tzv. ...
def	get_password (system, user)
	Pro uložení přihlašovacích údajů se používá tzv. ...
def	set_debug_mode (debug_mode, sleep_time=None)
	Pokud je zapnuto, bude označovat nalezené elementy a čekat nějaký čas po nalezení elementu. ...
def	set_default_timeout (timeout)
	Nastaví implicitní timeout na všechna vyhledávání. ...
def	set_default_text_action (type, char_delay=None, decomposition_delay=None)
	Nastaví implicitní typ psaní textu a volitelně delay mezi psaním jednotlivých znaků. ...
def	set_default_mouse_action (type)
	Metoda nastaví implicitní typ akce myši. ...
def	set_default_focus_action (type)
	Nastaví implicitní typ akce pro volání AppElement.set_focus. ...
def	set_default_key_action (type)
	Nastaví implicitní typ akce pro send_key. ...
def	set_default_keyboard_layout (kl)
	Nastaví implicitní rozvržení klávesnice pro psaní textu. ...
def	set_default_search_method (method)
	Nastaví implicitní typ vyhledávání pro metody find_first, find_all. ...
def	condition_factory ()
	Pomocná třída pro zadávání složitějších podmínek pro vyhledávání viz ConditionFactory. ...
def	transformation_factory ()
	Pomocná třída která definuje jak se mají provádět transformace obrázků viz TransformationFactory. ...
def	exec_app (cmd_line, show_window=None)
	Spustí obecnou aplikaci viz třída App. ...
def	exec_excel_app (filename=None)
	Spustí aplikaci Excel. ...
def	exec_ie_app (url=None)
	Spustí Internet Explorer a přejde na zadané URL. ...
def	open_app (pid)
	Otevře aplikaci se zadaným ID procesu (PID). ...
def	find_first_app (name, timeout=default_timeout)
	Najde aplikaci podle zadaného názvu. ...
def	find_first_excel_app (timeout=default_timeout)
	Najde aplikaci Excel. ...
def	find_first_ie_app ()
	Najde aplikaci Internet Explorer. ...
def	bring_to_foreground (foreground=True)
	Přepnutí simulace na popředí/zpět. ...
def	default_error_processing ()
	Provede implicitní zpracování vyjimky: tj. ...
def	check_screen_resolution (width, height, bits_per_pixel=None)
	Provede kontrolu rozlišení a barevné hloubky. ...
def	set_screen_resolution (width, height, bits_per_pixel=None)
	Provede nastavení rozlišení a barevné hloubky. ...
def	set_clipboard_text (text)
	Vloží zadaný text do schránky Windows (clipboard). ...
def	clipboard_text ()
	Vrací text, který je uložen ve schránce Windows (clipboard). ...
def	write_sydesk_measure (directory, source_id, value, expiration, description=None)
	Zapíše měření ve formátu msr6 do zadaného adresáře. ...
def	write_measure (name, status, value=None, unit=None, tolerance=0, description=None, precision=None, id=None)
	Zapíše měření ve formátu pro UltimateRPA Management Console do zadaného adresáře. ...
def	take_screenshot ()

Proměnné
int	default_timeout = 5000
	Implicitní timeout na všechna vyhledávání viz set_default_timeout. ...
string	default_kl = "00000409"
string	default_text_action = "WM_CHAR"
int	default_char_delay = 50
int	default_decomposition_delay = 20
string	default_key_action = "Hardware"
string	default_mouse_action = "HW Left"
string	default_focus_action = "Default"
	default = Config()

Detailní popis

Modul urpa slouží k automatizaci procesů.

Volání z více vláken není podporováno.

Funkce print vypisuje informace do logu i na standardní výstup.

Dokumentace funkcí

bring_to_foreground()

def urpa.bring_to_foreground

(

foreground = True

)

Přepnutí simulace na popředí/zpět.

Parametry

foreground

bool True pro přepnutí simulace na popředí resp. přepnutí se na simulační desktop. False pro přepnutí simulace zpět na pozadí.

check_screen_resolution()

def urpa.check_screen_resolution	(		width,
			height,
			bits_per_pixel = None
	)

Provede kontrolu rozlišení a barevné hloubky.

Parametry

width	int
height	int
bits_per_pixel	int

Výjimky

ValueError

v případě, že rozlišení/barevná hloubka nesouhlasí

clipboard_text()

def urpa.clipboard_text

(

)

Vrací text, který je uložen ve schránce Windows (clipboard).

condition_factory()

def urpa.condition_factory

(

)

Pomocná třída pro zadávání složitějších podmínek pro vyhledávání viz ConditionFactory.

Návratová hodnota

ConditionFactory

default_error_processing()

def urpa.default_error_processing

(

)

Provede implicitní zpracování vyjimky: tj.

provede screenshot a error log vzhledem k naposledy vyvolané výjimce.

exec_app()

def urpa.exec_app	(		cmd_line,
			show_window = None
	)

Spustí obecnou aplikaci viz třída App.

Parametry

cmd_line	String
show_window	String Minimize Maximize Normal Hide

Návratová hodnota

App

exec_excel_app()

def urpa.exec_excel_app

(

filename = None

)

Spustí aplikaci Excel.

Cestu k binárce si zjistí automaticky.

Parametry

filename

String

Návratová hodnota

AppExcel

exec_ie_app()

def urpa.exec_ie_app

(

url = None

)

Spustí Internet Explorer a přejde na zadané URL.

Cestu k binárce si zjistí automaticky.

Parametry

url

String

Návratová hodnota

AppIE

find_first_app()

def urpa.find_first_app	(		name,
			timeout = default_timeout
	)

Najde aplikaci podle zadaného názvu.

Je tak možné pracovat i s aplikacemi, které se spustí jinak než přes urpa.exec_*.

Vyvolá výjimku urpa.ElementNotFoundError pokud aplikace nebyla nalezena do požadovaného času.

Parametry

name	String Přesný název titlu TP okna nebo ClassName TP okna, které bude svázáno s instancí vrácené třídy.
timeout	int [ms] Maximální doba, do které musí být vyhledáno TP okno, který splňuje podmínku name. Pokud není tento parametr specifikován, použije se implicitní hodnota viz urpa.default_timeout.

Návratová hodnota

App

Výjimky

ElementNotFoundError

aplikace nebyla nalezena v požadovaném čase

Examples

Příklad spuštění aplikace notepad. Po nějaké době chceme nalézt aplikaci, která má v názvu řetězec "pad"".

app = urpa.exec_app("notepad.exe")
.
.
urpa.find_first_app(cf.regexp('pad'))

find_first_excel_app()

def urpa.find_first_excel_app

(

timeout = default_timeout

)

Najde aplikaci Excel.

Je tak možné pracovat i s aplikacemi, které se spustí jinak než přes urpa.exec_excel_app.

Vyvolá výjimku urpa.ElementNotFoundError pokud aplikace nebyla nalezena do požadovaného času.

KwKwargs

timeout int [ms] Maximální doba, do které musí být aplikace vyhledána.

Návratová hodnota

AppExcel

Výjimky

ElementNotFoundError

aplikace nebyla nalezena v požadovaném čase

find_first_ie_app()

def urpa.find_first_ie_app

(

)

Najde aplikaci Internet Explorer.

Návratová hodnota

AppIE

get_password()

def urpa.get_password	(		system,
			user
	)

Pro uložení přihlašovacích údajů se používá tzv.

Trezor pověření Windows (anglicky Windows Credential Vault), který je samostatný pro každý uživatelský profil. Záznamy lze uživatelsky spravovat pomocí standardního nástroje Správce pověření, kde se postupně zadá název obecného pověření, uživatelské jméno a heslo.

open_app()

def urpa.open_app

(

pid

)

Otevře aplikaci se zadaným ID procesu (PID).

Vyvolá výjimku pokud proces se zadaným ID neexistuje nebo se ho nepodařilo otevřít.

Parametry

pid

int

Návratová hodnota

App

ElementNotFoundError

set_clipboard_text()

def urpa.set_clipboard_text

(

text

)

Vloží zadaný text do schránky Windows (clipboard).

set_debug_mode()

def urpa.set_debug_mode	(		debug_mode,
			sleep_time = None
	)

Pokud je zapnuto, bude označovat nalezené elementy a čekat nějaký čas po nalezení elementu.

Parametry

debug_mode	Boolean Zapne/vypne debug mod
sleep_time	int [ms] Doba v ms, po kterou se čeká po nalezení elementu.

set_default_focus_action()

def urpa.set_default_focus_action

(

type

)

Nastaví implicitní typ akce pro volání AppElement.set_focus.

Nastavení má vliv i na metody send_text a send_key, kde se metoda set_focus volá automaticky.

Parametry

type	String Default - při použití na skrytém desktopu trvá tato metoda "dlouho" (2s) Mouse - aktivace elementu pomocí kliku myši None - aktivace elementu se nebude provádět

set_default_key_action()

def urpa.set_default_key_action

(

type

)

Nastaví implicitní typ akce pro send_key.

Parametry

type	String Hardware Standard

set_default_keyboard_layout()

def urpa.set_default_keyboard_layout

(

kl

)

Nastaví implicitní rozvržení klávesnice pro psaní textu.

Má vliv pouze pro psaní typy *_Scan_Virtual.

Parametry

kl	String 00000405 - české (Czech, CSY, Czech Republic) 00000409 - anglické (US, ENU, United States) 0000041B - slovenké (Slovak, SKY, Slovakia)

set_default_mouse_action()

def urpa.set_default_mouse_action

(

type

)

Metoda nastaví implicitní typ akce myši.

Parametry

type	String HW Left HW Right HW Middle HW Move HW Left Down HW Right Down HW Middle Down HW Left Up HW Right Up HW Middle Up Left Right Middle Left Down Right Down Middle Down Left Up Right Up Middle Up

set_default_search_method()

def urpa.set_default_search_method

(

method

)

Nastaví implicitní typ vyhledávání pro metody find_first, find_all.

Parametry

method

String default tree_walk

set_default_text_action()

def urpa.set_default_text_action	(		type,
			char_delay = None,
			decomposition_delay = None
	)

Nastaví implicitní typ psaní textu a volitelně delay mezi psaním jednotlivých znaků.

Pro typy *_Scan_Virtual je potřeba mít nastaven správně keyboard layout viz set_default_keyboard_layout. Pro typy *_Alt_code je potřeba mít v registrech povoleno EnableHexNumpad v HKEY_CURRENT_USER\Control Panel\Input Method.

Parametry

type	String HW_Alt_code HW_Scan_Virtual Standard_Alt_code Standard_Scan_Virtual WM_CHAR
char_delay	int [ms] Delay v ms mezi psaním jednotlivých znaků.
decomposition_delay	int [ms] Delay v ms pro psaní jednotlivých znaků.

set_default_timeout()

def urpa.set_default_timeout

(

timeout

)

Nastaví implicitní timeout na všechna vyhledávání.

Parametry

timeout

int [ms]

set_password()

def urpa.set_password	(		system,
			user,
			password
	)

Pro uložení přihlašovacích údajů se používá tzv.

Trezor pověření Windows (anglicky Windows Credential Vault), který je samostatný pro každý uživatelský profil. Záznamy lze uživatelsky spravovat pomocí standardního nástroje Správce pověření, kde se postupně zadá název obecného pověření, uživatelské jméno a heslo.

set_screen_resolution()

def urpa.set_screen_resolution	(		width,
			height,
			bits_per_pixel = None
	)

Provede nastavení rozlišení a barevné hloubky.

Parametry

width	int
height	int
bits_per_pixel	int

take_screenshot()

def urpa.take_screenshot

(

)

transformation_factory()

def urpa.transformation_factory

(

)

Pomocná třída která definuje jak se mají provádět transformace obrázků viz TransformationFactory.

Návratová hodnota

TransformationFactory

write_measure()

def urpa.write_measure	(		name,
			status,
			value = None,
			unit = None,
			tolerance = 0,
			description = None,
			precision = None,
			id = None
	)

Zapíše měření ve formátu pro UltimateRPA Management Console do zadaného adresáře.

Začátek měření je aktuální čas.

Parametry

name	String Název měření.
status	String (SUCCESS|WARNING|ERROR|INFO|NONE)
value	float Volitelná hodnota měření.
unit	String Volitelná jednotka hodnoty měření např. %.
tolerance	float Volitelná tolerance pro platnost měření.
description	String Volitelný popisek měření.
precision	int Volitelná přesnost zobrazení hodnoty v intervalu <0, 8>.
id	String Volitelné id měření. Pokud není zadáno, vezme se jako id argument name.

write_sydesk_measure()

def urpa.write_sydesk_measure	(		directory,
			source_id,
			value,
			expiration,
			description = None
	)

Zapíše měření ve formátu msr6 do zadaného adresáře.

Začátek měření je aktuální čas.

Parametry

directory	String Adresář, do kterého dojde k zápisu datové věty.
source_id	String Id zdroje dat v SyDesku.
value	float nebo None Hodnota měření. None znamená selhání měření (monitor failure).
expiration	int Doba platnosti měření ve vteřinách.
description	String Volitelný popisek měření.

Dokumentace proměnných

default

urpa.default = Config()

default_char_delay

int urpa.default_char_delay = 50

default_decomposition_delay

int urpa.default_decomposition_delay = 20

default_focus_action

string urpa.default_focus_action = "Default"

default_key_action

string urpa.default_key_action = "Hardware"

default_kl

string urpa.default_kl = "00000409"

default_mouse_action

string urpa.default_mouse_action = "HW Left"

default_text_action

string urpa.default_text_action = "WM_CHAR"

default_timeout

int urpa.default_timeout = 5000

Implicitní timeout na všechna vyhledávání viz set_default_timeout.