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-3.3.2.tar.gz
(63.7 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-3.3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 822c74a867150b82bfeaff51d2009411a2382dba9c795eba78b4beb60445f03c |
|
MD5 | 37520b8a9b482a45e842962fe8febf26 |
|
BLAKE2b-256 | 51cefe2772e4d14da7550d726b8240f19f31c85aff27d948e6b65e2ede9bc10d |
Close
Hashes for robotframework_tidy-3.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e46cc32d08fae820e4fe8213bf59e2f108d1bdb6e90a5a770d9bf1798342aa1 |
|
MD5 | 6aea73533075050bdc9c82730c7722a9 |
|
BLAKE2b-256 | 51f723004fede60b7f93d3881985d1cf25caab0d06a1670c1b2b95b755eac395 |