Skip to content

Python formatter #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2025
Merged

Python formatter #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f81c3ad
Added isort and ruff settings to vscode to have code style compliant …
GPatiA2 Apr 25, 2025
0c3e90f
Added ruff and isort to python extension list
GPatiA2 Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/_09_development/_develop_guide/_develop_guide/_setting_code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Install the following required extensions from the 'Extensions' tab in VSCode:
* ``mine.cpplint``
* ``ms-python.autopep8``
* ``ms-python.pylint``
* ``charliermarsh.ruff``
* ``ms-python.isort``


.. _development_guide_code_settings:
Expand Down Expand Up @@ -74,6 +76,21 @@ Open your ``settings.json`` file from VSCode and add the following content to it
"--max-line-length=99", "--import-order-style=google", "--show-source=true",
"--statistics=true"],

"ruff.lineLength": 99,
"ruff.organizeImports": false,
"ruff.configuration" : {
"format" : {
"quote-style" : "single",
"line-ending" : "auto",
},
},
// isort to enforce propper import order
"isort.args": ["--line-length", "99", "--force-alphabetical-sort-within-sections", "--profile", "black", "--force-sort-within-sections"],
"pylint.args": ["--disable=B902,C816,D100,D101,D102,D103,D104,D105,D106,D107,D203,D212,D404,I202",
"--max-line-length=99", "--import-order-style=google", "--show-source=true",
"--statistics=true"
]

Newer versions of ROS 2 include upgraded flake8 (in ament_flake8), so it is preferable to use
flake8 from VSCode too instead of pylint. To do so, use, instead of the 'pylint.args' settings,
the following settings:
Expand Down