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.2.0.tar.gz
(75.2 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb9c876f3418e754d1659ef9c806ba3e45366a2e9c00a4a2ae16058c2a9153bc |
|
MD5 | e9021d8edb224878a4061797e4621edd |
|
BLAKE2b-256 | b7839a7d829cfd89ef1c31736f676b7fa35aedb3b578265bf0a4bc6c5eba66a9 |
Close
Hashes for robotframework_tidy-4.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab2cae4119057c32c9ed03692f0545083dbb173abdc3a38653aa3556e4fae66e |
|
MD5 | d4bd24b2dae31ab5124a6045deea9905 |
|
BLAKE2b-256 | 7cfcbc99dab1df43bf762736cf45c13b77f7ac3ae11d3b4783f955fb6b3db610 |