unity8 Package

custom proxy object Modules

class unity8.tutorial.TutorialPage(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

short_swipe_right()[source]
swipe_left()[source]
swipe_up()[source]
tap()[source]

Tap the tick button to complete this step.

classmethod validate_dbus_object(path, state)[source]
class unity8.greeter.Greeter(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

A helper that understands the greeter screen.

get_prompt()[source]
swipe()[source]

Swipe the greeter screen away.

wait_swiped_away()[source]

unity shell autopilot tests and helpers - sub level package.

class unity8.shell.QQuickView(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

An helper class that makes it easy to interact with the shell

close_indicator_page()[source]

Swipe to close the opened indicator, wait until it’s closed.

enter_pin_code(code)[source]

Enter code ‘code’ into the single-pin lightdm pincode entry screen.

Parameters:code – must be a string of numeric characters.
Raises:TypeError if code is not a string.
Raises:ValueError if code contains non-numeric characters.
get_bottombar()[source]
get_current_focused_app_id()[source]

Return the id of the focused application.

get_greeter()[source]
get_lockscreen()[source]
get_login_list()[source]
get_login_loader()[source]
get_pinPadLoader()[source]
get_pinentryField()[source]
is_launcher_open()[source]
launch_application(application_name)[source]

Launch an application.

Parameters:application_name – The name of the application to launch.
open_indicator_page(indicator_name)[source]

Swipe to open the indicator, wait until it’s open.

Returns:The indicator page.
open_launcher()[source]
show_dash_from_launcher()[source]

Open the dash clicking the dash icon on the launcher.

show_dash_swiping()[source]

Show the dash swiping from the left.

wait_for_notification()[source]

Wait for a notification dialog to appear.

Returns:An object for the notification dialog data.
Raises StateNotFoundError:
 if the timeout expires when the

notification has not appeared.

unity8.shell.create_ephemeral_notification(summary='', body='', icon=None, hints=[], urgency='NORMAL')[source]

Create an ephemeral (non-interactive) notification

Parameters:
  • summary – Summary text for the notification
  • body – Body text to display in the notification
  • icon – Path string to the icon to use
  • hint_strings – List of tuples containing the ‘name’ and value for setting the hint strings for the notification
  • urgency – Urgency string for the noticiation, either: ‘LOW’, ‘NORMAL’, ‘CRITICAL’
unity8.shell.disable_qml_mocking(fn)[source]

Simple decorator that disables the QML mocks from being loaded.

class unity8.launcher.Launcher(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

A helper that understands the Launcher.

click_application_launcher_icon(application_name)[source]
click_dash_icon()[source]
show()[source]

Show the launcher swiping it to the right.

class unity8.dash.Dash(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

A helper that understands the Dash.

enter_search_query(query)[source]
get_application_icon(text)[source]

Returns a ‘Tile’ icon that has the text ‘text’ from the application grid.

Parameters:text – String containing the text of the icon to search for.
get_applications_grid()[source]
get_scope(scope_name='clickscope')[source]
get_scope_by_index(scope_index=0)[source]
open_scope(scope_id)[source]

Open a dash scope.

Parameters:scope_id – The id of the scope.
Returns:The scope.
class unity8.dash.DashApp(app_proxy)[source]

Bases: builtins.object

Autopilot helper for the Dash app.

class unity8.dash.GenericScopeView(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

Autopilot helper for generic scopes.

click_scope_item(category, title, press_duration=0.1)[source]

Click an item from the scope.

Parameters:
  • category – The name of the category where the item is.
  • title – The title of the item.
get_applications(category)[source]

Return the list of applications on a category.

Parameters:category – The name of the category.
open_preview(category, app_name, press_duration=0.1)[source]

Open the preview of an application.

Parameters:
  • category – The name of the category where the application is.
  • app_name – The name of the application.
Returns:

The opened preview.

class unity8.dash.ListViewWithPageHeader(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._flickable.QQuickFlickable

margin_to_swipe_from_bottom = 32.0
class unity8.dash.Preview(*args)[source]

Bases: ubuntuuitoolkit._custom_proxy_objects._common.UbuntuUIToolkitCustomProxyObjectBase

Autopilot custom proxy object for generic previews.

Table Of Contents

Previous topic

Welcome to unity8-autopilot’s documentation!