Skip to main content

Robotframework-FlaUI Library

License
Python Builds (x86)
Python Builds (x64)
Tests
Python python_312 python_313 python_314 python_315
Robotframework
PyPi

Introduction

Robotframework-FlaUI is a keyword based user interface automation testing library for Windows applications like Win32, WinForms, WPF or Store Apps. It's based on the FlaUI user interface automation library.

The library supports Microsoft UI Automation interfaces UIA2 and UIA3 (default). Elements are located by XPath. Mouse keywords also accept absolute screen coordinates or X/Y offsets from an element's clickable point. Keyboard keywords can send input globally when no XPath is given.

Installation

Install the latest stable release:

pip install --upgrade robotframework-flaui

Usage

*** Settings ***
Library    FlaUILibrary    uia=UIA3    screenshot_on_failure=True    screenshot_mode=FILE    screenshot_suffix=jpg    timeout=1000

Library import arguments:

Argument Default Description
uia UIA3 Microsoft UI Automation interface: UIA2 or UIA3
screenshot_on_failure True Take a screenshot when a keyword fails
screenshot_dir output Screenshot directory relative to the Robot output directory
timeout 1000 Default element find timeout in milliseconds
screenshot_mode FILE Persist screenshots as FILE or BASE64
screenshot_suffix jpg Screenshot file type when mode is FILE: png, jpg or jpeg

Mouse examples:

Click    ${XPATH}
Click    x=100    y=200
Click    ${XPATH}    x=10    y=20

Keyboard examples:

Press Key    t'Text'    ${XPATH}
Press Key    t'Text'
Press Keys    ${KEYS}

A full keyword reference is available in the keyword documentation.

Dependencies and python support

The robot framework FlaUI is supposed to support the current Python 3 versions.

Required dependencies

See dependencies from Documentation

Runtime dependencies are listed in requirements.txt:

  • Robot Framework 3.2.2 or newer
  • Python.Net 3.0.0 or newer
  • robotframework-pythonlibcore
  • typing-extensions

Python.Net Wrapper Issues

Robotframework-Flaui 1.x

  • With the release of Python.Net version 2.5.2, Python 3.9 support was implemented for the first time.
  • However, no official support for Python 3.9 has been released yet.
    • For more information see the issue #1389
  • If there are problems installing the Python.Net library, please use Python 3.8 instead.
  • This is only a potential problem by all robotframework-flaui 1.x versions which are implemented by Python.Net 2.5.2

Robotframework-Flaui 2.x

  • Sometimes an AccessViolationException wil be occure on latest Python.Net Version v3.0.1
    • For more information see the issue #1977
    • A workaround is to set Python's memory allocation environment variable "PYTHONMALLOC=malloc"

Documentation

Keyword HTML and XML docs are generated by libdoc.py during the build blueprint stage and published from the documentation GitHub branch to GitHub Pages.

RFHUB2

RFHUB2 is an opensource project aimed to provide nice and easy way of collecting, browsing and sharing documentation of existing keywords written in RobotFramework and python. Built with Material-UI and FastAPI, served by Uvicorn.

Keyword XML files live on the documentation branch under docs/keywords/. Check out that branch and import them with RFHUB2-CLI:

rfhub2-cli .\docs\keywords\
rfhub2-cli .\docs\keywords\<VERSION>

GUI Inspector Tools

There are various tools around which help inspecting application that should be ui tested or automated.

Some of them are:

Examples

Examples of use can be found in the atests folder.

Development

Preconditions

  • Install Python, if not already installed.
  • Python 3.8 or newer is supported (CI covers 3.8–3.15, x86 and x64).

Requirement files

File Purpose
requirements.txt Runtime dependencies of the library
requirements-dev.txt Local build, lint and test tools
requirements-buildsystem.txt Builddrone
requirements-artifact-upload.txt Twine, used by the pypi blueprint stage

Dependency installation by Builddrone

Install Builddrone, then run stages from blueprint.json:

python -m pip install -r requirements-buildsystem.txt
python -m builddrone <stage>

Builddrone documentation: https://nepitwin.github.io/Builddrone/latest/

Test-Applications

Two test projects were used for the UI automation:

  • FlaUI WPF Test App 'Standard application that contains all common UI elements'
  • Notifier Test App 'Application which closes automatically after a time'

Testing locally TLDR

python -m venv .venv
.venv/Scripts/pip install -r requirements-dev.txt

cd ./atests
../.venv/Scripts/robot -v UIA:UIA3 -d ../result -P ../src -t "Element Should Be Offscreen" Element.robot

Building and testing with Builddrone

Local CI is defined in blueprint.json and executed by Builddrone:

python -m builddrone <stage>

Builddrone loads blueprint.json from the working directory, selects the named stage and runs its module steps in order. Relative paths are resolved from the directory that contains blueprint.json.

Stage Purpose
build Create .build.venv, install requirements-dev.txt, build the package into dist/, generate keyword docs into keywords/
cleanup Remove generated folders and local virtual environments
robocop Run Robot Framework lint checks via robocop_lint.py in .testing.venv
pylint Run pylint for the Python sources in src
test Run UIA2 and UIA3 acceptance tests, merge reports into result/
pypi Upload dist/*.whl and dist/*.tar.gz to PyPI (AppVeyor, git tags only)
appveyor_upload_tests Upload JUnit results to AppVeyor
appveyor_upload_failure_artifacts Zip result/ and upload it as an AppVeyor artifact on failure

The build stage writes:

  • Wheel and source distribution under dist/
  • Keyword documentation keywords/keywords.html and keywords/keywords.xml (generated by libdoc.py)

The test stage runs atests twice (UIA2 and UIA3), merges the Robot outputs with rebot into result/, copies screenshots and converts the merged report with parsly.py.

robocop, pylint and test share .testing.venv. build uses .build.venv. pypi uses .upload.venv.

Example full local CI run:

python -m pip install -r requirements-buildsystem.txt
python -m builddrone build
python -m builddrone robocop
python -m builddrone pylint
python -m builddrone test

AppVeyor (appveyor.yml) runs the same four stages on every branch except documentation. The pypi stage runs only when the build is triggered by a git tag.

Contributing

Code changes are welcome via pull request. Release tagging, PyPI upload and keyword documentation publishing are not part of this workflow.

  • add or update keywords in folders
    • src/FlaUILibrary/flaui/module
    • src/FlaUILibrary/keywords
  • add or update tests in folder atests
  • update CHANGELOG.md under [Unreleased]
  • open a pull request against main

Acknowledgements

FlaUI

  • Thanks to @Roemer for the passion to create and maintain the FlaUI project.
  • Thanks to FlaUI developers and maintainers for this project.

Metadata

Release files for robotframework-flaui 7.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotframework-flaui 7.0.0
File Size Uploaded Provenance Actions
robotframework_flaui-7.0.0.tar.gz 328.9 kB Without provenance Details for robotframework_flaui-7.0.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for robotframework-flaui 7.0.0
File Actions
robotframework_flaui-7.0.0-cp315-cp315-win_amd64.whl CPython 3.15 CPython 3.15 Windows x86-64 Details for robotframework_flaui-7.0.0-cp315-cp315-win_amd64.whl
robotframework_flaui-7.0.0-cp315-cp315-win32.whl CPython 3.15 CPython 3.15 Windows x86-32 Details for robotframework_flaui-7.0.0-cp315-cp315-win32.whl
robotframework_flaui-7.0.0-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for robotframework_flaui-7.0.0-cp314-cp314-win_amd64.whl
robotframework_flaui-7.0.0-cp314-cp314-win32.whl CPython 3.14 CPython 3.14 Windows x86-32 Details for robotframework_flaui-7.0.0-cp314-cp314-win32.whl
robotframework_flaui-7.0.0-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for robotframework_flaui-7.0.0-cp313-cp313-win_amd64.whl
robotframework_flaui-7.0.0-cp313-cp313-win32.whl CPython 3.13 CPython 3.13 Windows x86-32 Details for robotframework_flaui-7.0.0-cp313-cp313-win32.whl
robotframework_flaui-7.0.0-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for robotframework_flaui-7.0.0-cp312-cp312-win_amd64.whl
robotframework_flaui-7.0.0-cp312-cp312-win32.whl CPython 3.12 CPython 3.12 Windows x86-32 Details for robotframework_flaui-7.0.0-cp312-cp312-win32.whl
robotframework_flaui-7.0.0-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for robotframework_flaui-7.0.0-cp311-cp311-win_amd64.whl
robotframework_flaui-7.0.0-cp311-cp311-win32.whl CPython 3.11 CPython 3.11 Windows x86-32 Details for robotframework_flaui-7.0.0-cp311-cp311-win32.whl
robotframework_flaui-7.0.0-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for robotframework_flaui-7.0.0-cp310-cp310-win_amd64.whl
robotframework_flaui-7.0.0-cp310-cp310-win32.whl CPython 3.10 CPython 3.10 Windows x86-32 Details for robotframework_flaui-7.0.0-cp310-cp310-win32.whl
robotframework_flaui-7.0.0-cp39-cp39-win_amd64.whl CPython 3.9 CPython 3.9 Windows x86-64 Details for robotframework_flaui-7.0.0-cp39-cp39-win_amd64.whl
robotframework_flaui-7.0.0-cp39-cp39-win32.whl CPython 3.9 CPython 3.9 Windows x86-32 Details for robotframework_flaui-7.0.0-cp39-cp39-win32.whl
robotframework_flaui-7.0.0-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details for robotframework_flaui-7.0.0-cp38-cp38-win_amd64.whl
robotframework_flaui-7.0.0-cp38-cp38-win32.whl CPython 3.8 CPython 3.8 Windows x86-32 Details for robotframework_flaui-7.0.0-cp38-cp38-win32.whl

Total release size: 6.1 MB

Release files / robotframework_flaui-7.0.0.tar.gz

Download URL robotframework_flaui-7.0.0.tar.gz
Size 328.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4f05a1a7054ccdd68789e7e2773063a5eb85ef5ba0fdd86cb11128ba1e26d42b
BLAKE2b-256 checksum
How to use checksums
247540b837587a2ae4846372c8509c9c51a7799426920950fa58127d68187910
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.10

Release files / robotframework_flaui-7.0.0-cp315-cp315-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp315-cp315-win_amd64.whl
Size 367.5 kB
Tags CPython 3.15 Windows x86-64
SHA-256 checksum
How to use checksums
dad72d207fa55ab28ed198d3ea6e1720e4c55e4c677a1a441422eba082135543
BLAKE2b-256 checksum
How to use checksums
434db4bec7b74629b2e89b22d71998f2b76b6a304a47a7302b2f1002d6f7800b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0rc2

Release files / robotframework_flaui-7.0.0-cp315-cp315-win32.whl

Download URL robotframework_flaui-7.0.0-cp315-cp315-win32.whl
Size 367.5 kB
Tags CPython 3.15 Windows x86-32
SHA-256 checksum
How to use checksums
73e8444482713f8933ecc7d7824933e54960b974aac9fc5e238af2fbab1e8717
BLAKE2b-256 checksum
How to use checksums
f8e76e42a6e76da424352400a3247775350d87c85513a1987ed4aea80558d59b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0rc2

Release files / robotframework_flaui-7.0.0-cp314-cp314-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp314-cp314-win_amd64.whl
Size 367.5 kB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
d794b76e4d7f967602c9eb12cbc557671501e667a1ad1e6c03ba76212a9dcdaa
BLAKE2b-256 checksum
How to use checksums
566a865b9074b204892792adf792991a9ea615363f0e59340aa98d1e84c38198
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / robotframework_flaui-7.0.0-cp314-cp314-win32.whl

Download URL robotframework_flaui-7.0.0-cp314-cp314-win32.whl
Size 367.5 kB
Tags CPython 3.14 Windows x86-32
SHA-256 checksum
How to use checksums
1dabf4019f79981880388cafc79407e6a1622e7b5865cceabacd6c1131c81225
BLAKE2b-256 checksum
How to use checksums
026a0576c36c47a152a45e4edc0182dd73332d1098c7515d6b709de3dd42a5e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / robotframework_flaui-7.0.0-cp313-cp313-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp313-cp313-win_amd64.whl
Size 357.3 kB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
355c0562f0f1504685e4dac3ce9af1778b7b62961efabd75c1ef3de6f0884245
BLAKE2b-256 checksum
How to use checksums
f8e4863c75cd096e1e6159fad0177257948ce50e8a0f0bcb2902f03b7f501bcd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.9

Release files / robotframework_flaui-7.0.0-cp313-cp313-win32.whl

Download URL robotframework_flaui-7.0.0-cp313-cp313-win32.whl
Size 357.3 kB
Tags CPython 3.13 Windows x86-32
SHA-256 checksum
How to use checksums
142aa5c3d285503af475f7c90ed67e0c7203d9473107bb4b6e55c6fbf637fb93
BLAKE2b-256 checksum
How to use checksums
1f6952cb6db6c45abca8695f66f160994ce3272a223cd3655d0d9e6ab05f62f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.9

Release files / robotframework_flaui-7.0.0-cp312-cp312-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp312-cp312-win_amd64.whl
Size 357.3 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
bda76c6abcbda4deb3fde53cba2593767d3e4bd60feada3b41cfd59377ec1da5
BLAKE2b-256 checksum
How to use checksums
b90c692c38556886b92c7ebfdaf6c28c77c13e575880937a13d9eae087f7f178
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.10

Release files / robotframework_flaui-7.0.0-cp312-cp312-win32.whl

Download URL robotframework_flaui-7.0.0-cp312-cp312-win32.whl
Size 357.3 kB
Tags CPython 3.12 Windows x86-32
SHA-256 checksum
How to use checksums
97c8cf6d1f42e3aa6f9b42b98d84f1261083cfcea3f324186897d47f05997ff7
BLAKE2b-256 checksum
How to use checksums
b1d1af9bd768e48081c05e06592185a3d5c51e89111c289350506638022cc8d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.10

Release files / robotframework_flaui-7.0.0-cp311-cp311-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp311-cp311-win_amd64.whl
Size 357.3 kB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
77f02d18c1aa3298b32e6927ea3db0cf6a5b0190552baec7a1d481d78ba36c1f
BLAKE2b-256 checksum
How to use checksums
ffca692fc8e546429af285b74ecc65cfaddeb796bd015b8084f16a0e77b0cfad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / robotframework_flaui-7.0.0-cp311-cp311-win32.whl

Download URL robotframework_flaui-7.0.0-cp311-cp311-win32.whl
Size 357.3 kB
Tags CPython 3.11 Windows x86-32
SHA-256 checksum
How to use checksums
e30a40295b1b32b4ce29ad78874bc10a505901d89d0e15773c633bf18dd8f4cc
BLAKE2b-256 checksum
How to use checksums
cfc2ac704c7b43ce1710503ce1415fc5d3807a26add1db33c790f92cfb1a0a41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.9

Release files / robotframework_flaui-7.0.0-cp310-cp310-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp310-cp310-win_amd64.whl
Size 357.3 kB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
7e79382931f155a71af2a04a0491dcbb5a865c9a666421c51c0b1c474b48898f
BLAKE2b-256 checksum
How to use checksums
fab2daa4eade7f6cbd39656cd786f2cad94ea94be68aba8075d9f8f21d8b4a23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Release files / robotframework_flaui-7.0.0-cp310-cp310-win32.whl

Download URL robotframework_flaui-7.0.0-cp310-cp310-win32.whl
Size 357.3 kB
Tags CPython 3.10 Windows x86-32
SHA-256 checksum
How to use checksums
e931c69498880dbf4a9f90b5e899c30eb10832fe71c38835807c881313ed59ad
BLAKE2b-256 checksum
How to use checksums
7211ddbabf7316430c641baf04ef1edefc1ec35aecf59bfb6a7675f14edd3430
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Release files / robotframework_flaui-7.0.0-cp39-cp39-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp39-cp39-win_amd64.whl
Size 357.3 kB
Tags CPython 3.9 Windows x86-64
SHA-256 checksum
How to use checksums
d7f343ace217715a13c83431b8a100cdc8d0cdd8e4b7c37c424ffdc9173903d2
BLAKE2b-256 checksum
How to use checksums
876249c386358ac72d0f92d8213334f1993641dc90f9703bfd00d27c84ba8a52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / robotframework_flaui-7.0.0-cp39-cp39-win32.whl

Download URL robotframework_flaui-7.0.0-cp39-cp39-win32.whl
Size 357.3 kB
Tags CPython 3.9 Windows x86-32
SHA-256 checksum
How to use checksums
b5154b42c1d56652adb7823ed65f290276ec22118a4eb976fb27849fba930865
BLAKE2b-256 checksum
How to use checksums
61599e990e3d9a399f05a2d2359a66961bd292f43f0bd0c7dac370d118059c68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / robotframework_flaui-7.0.0-cp38-cp38-win_amd64.whl

Download URL robotframework_flaui-7.0.0-cp38-cp38-win_amd64.whl
Size 357.2 kB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
d7611735bafa89b679f23cdef910cd0aa9836fc58b67c2b036a86b46064e2fdb
BLAKE2b-256 checksum
How to use checksums
94e086488725e11ff46706a884fbf9ff443bf0495b546e70635ee46c8096b15b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.10

Release files / robotframework_flaui-7.0.0-cp38-cp38-win32.whl

Download URL robotframework_flaui-7.0.0-cp38-cp38-win32.whl
Size 357.2 kB
Tags CPython 3.8 Windows x86-32
SHA-256 checksum
How to use checksums
07c8eb9725174c0cc0b71bfff157b422468a5bbbb42829ea2298878b78e8a5be
BLAKE2b-256 checksum
How to use checksums
c47d3a4f9e01c1eff019737efb0800b4b72d2b83ed7c4401c08f8236a026b778
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.10

Security for robotframework-flaui 7.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.0.0 This release

17 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page