Code autoformatter for Robot Framework
Project description
Robotidy
Introduction
Robotidy is a tool for autoformatting Robot Framework code.
It is spiritual descendant of Robot Framework's internal robot.tidy package.
Documentation
Full documentation available here. :open_book:
Requirements
Python 3.7+ :snake: and Robot Framework 4.0.0+ :robot:.
Installation
You can install Robotidy simply by running:
pip install -U robotframework-tidy
Usage
Call robotidy with path(s) to file/directory with robot files:
robotidy tests
robotidy test.robot
robotidy tests/resources test.robot
All command line options can be displayed in help message by executing:
robotidy --help
See documentation for information how to configure robotidy.
Example
Ugly code before transforming with robotidy:
*** Settings ***
Force Tags tags tag2
Library Collections
Resource important.robot
Library MyCustomLibrary.py
Test Setup Setup Keyword
*** test case*
Test1
[ teardown] Teardown Keyword
Keyword
FOR ${var} IN RANGE 10
Run Keyword If ${var}>5 Other Keyword
END
*** Variables ***
${var}= 2
${bit_longer} 10
${var2} a
... b
*** Keywords ***
A lot prettier code after:
*** Settings ***
Library Collections
Library MyCustomLibrary.py
Resource important.robot
Test Setup Setup Keyword
Force Tags tags tag2
*** Variables ***
${var} 2
${bit_longer} 10
${var2} a
... b
*** Test Cases ***
Test1
Keyword
FOR ${var} IN RANGE 10
IF ${var}>5
Other Keyword
END
END
[Teardown] Teardown Keyword
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
robotframework_tidy-4.12.0.tar.gz
(82.3 kB
view hashes)
Built Distribution
Close
Hashes for robotframework_tidy-4.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a10c826ceb340607e94a8c6b31ec24377661c44b0fc77da651a72c57962a668a |
|
MD5 | 967143f5e50380f693d364ece3032a21 |
|
BLAKE2b-256 | 68763f9720999ee0288a75e63a32b4951890b732b77ada32c731f2ba956ab493 |
Close
Hashes for robotframework_tidy-4.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 486c182e8a1c47c19eb535d860f4d139e85961d4108c27500fd29af83cc5adf1 |
|
MD5 | 7db236d95bfbea684d8d083357512dd7 |
|
BLAKE2b-256 | d878ccdd349bf4bae2b2d4763954dd01e36a13f69f8e39d63fcd937a304c8b71 |