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
Built Distribution
Close
Hashes for robotframework-tidy-3.4.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a3e74a38c7be1a5ba285311d92c0f964b7779b948fd8f2648ac7184ab81adae |
|
MD5 | 85eda38b707f234106182a50d7dc6dc6 |
|
BLAKE2b-256 | 544d6b23a888ef88780afc26958bac5bde196754d5c2be40872413650ec8ea10 |
Close
Hashes for robotframework_tidy-3.4.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fc8eb803bb145b2e31fc4856876c3bddf4082454c0ed393759571b4331a9fe1 |
|
MD5 | a9ff2174122049f273a83499f32a07ba |
|
BLAKE2b-256 | cb727f5ec78c8d35510465a670cc6b5bf56ed694f93eeed00a662e3d72a2d728 |