{"id":24535,"library":"robotframework-whitelibrary","title":"Robot Framework WhiteLibrary","description":"Windows GUI testing library for Robot Framework, version 1.6.0. Uses White (a .NET UI automation framework) to interact with Windows applications. Provides Robot Framework keywords for launching, attaching, and controlling windows, controls, and UI elements. Release cadence is irregular, with minor updates every few months.","status":"active","version":"1.6.0","language":"python","source_language":"en","source_url":"https://github.com/Omenia/robotframework-whitelibrary","tags":["robotframework","windows","gui-testing","white","ui-automation"],"install":[{"cmd":"pip install robotframework-whitelibrary","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"WhiteLibrary extends Robot Framework's test library interface","package":"robotframework","optional":false}],"imports":[{"note":"The package uses hyphens, but import uses the module name without hyphens. The repository name is robotframework-whitelibrary, but the Python module is WhiteLibrary.","wrong":"from robotframework_whitelibrary import WhiteLibrary","symbol":"WhiteLibrary","correct":"from WhiteLibrary import WhiteLibrary"}],"quickstart":{"code":"*** Settings ***\nLibrary    WhiteLibrary\n\n*** Test Cases ***\nOpen Notepad and Type Text\n    Launch Application    notepad.exe\n    Attach Window By Title    Untitled - Notepad\n    Type Text    id:15    Hello, Robot Framework!\n    Sleep    1s\n    Close Window","lang":"python","description":"Launch Notepad, type text, and close the window. Demonstrates basic usage of Launch Application, Attach Window By Title, Type Text, and Close Window keywords."},"warnings":[{"fix":"Update any robot test cases that check the error messages of these keywords to match the new format.","message":"Backwards incompatible changes in v1.5.0: Error messages for keywords `Window Should Be Maximized`, `Window Should Be Minimized` and `Window Should Be Closed` have changed. Tests that assert on exact error messages may break.","severity":"breaking","affected_versions":">=1.5.0"},{"fix":"Use the recommended locator format from the official documentation. For most cases, `id:value` is fine.","message":"The locator format 'type:value' introduced in v1.2.0 may be deprecated or changed in future versions. The old plain locators (e.g., `id:15`) still work but check docs for preferred format.","severity":"deprecated","affected_versions":">=1.2.0"},{"fix":"Ensure tests are executed on Windows with .NET Framework installed. Use conditional execution or skip on non-Windows platforms.","message":"WhiteLibrary is Windows-only. It uses .NET Framework and White, which only run on Windows. Running tests on Linux or macOS will fail with platform errors.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `Wait Until Item Exists` (only in v1.5.0+) or increase the `white_find_window_timeout` and `white_busy_timeout` settings. Alternatively, add explicit `Sleep` statements.","message":"The library relies on White's UI automation, which is sensitive to timing. It's common to encounter `ItemNotFoundException` or timeout errors if the UI element hasn't appeared yet. Use `Wait Until Item Exists` (v1.5.0+) or increase timeouts.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install robotframework-whitelibrary` and use `Library    WhiteLibrary` in Robot Framework settings.","cause":"The installed package is 'robotframework-whitelibrary', but import uses 'WhiteLibrary'. Ensure the package is installed and the import is correct.","error":"ImportError: No module named 'WhiteLibrary'"},{"fix":"Ensure the application is launched (use `Launch Application` or attach manually). Check the window title or use `Attach Window By Title` with correct string. For dynamic windows, use `Wait Until Item Exists` or increase timeout.","cause":"WhiteLibrary cannot find the window with the given criteria. The application may not be running, or the window title/identifier is incorrect.","error":"System.InvalidOperationException: Could not find a window ..."},{"fix":"Upgrade WhiteLibrary with `pip install --upgrade robotframework-whitelibrary` or check the keyword name in the documentation of your installed version.","cause":"The keyword does not exist in the version installed. Possibly using a newer keyword like `Wait Until Item Exists` (available since v1.5.0) on an older version.","error":"AttributeError: 'WhiteLibrary' object has no attribute 'some_keyword'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}