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.10.0.tar.gz
(81.0 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a6e609252b7df25ced3e1344589dc4e8636c21b13676d97109f95dad55f3f26 |
|
MD5 | 35b3aec8e8dc7f1cb6c95cc2c0e5781a |
|
BLAKE2b-256 | 909087a8e1f3e74342f8194f8e77531dd8ce3bfa1fa0c4105e4178233b6943cc |
Close
Hashes for robotframework_tidy-4.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cfa69a4d102768411f5f1834c8c669355bca63a2f3f68efe5b248a9e69bd6f2 |
|
MD5 | f4e86d60b506083db53eb93ce37cdf0f |
|
BLAKE2b-256 | 637842de7a380f4811e74b56e9cb9f04ee72c33ae29fb557250dd0674013ebbb |