chore: use ruff with ruff.toml file #594
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
maintenance
github-actions
bot
added
the
documentation
SMoraisAnsys
requested changes
May 8, 2025
There was a problem hiding this comment.
Thanks for this PR @ecoussoux-ansys, I left some minor comments
|
Nice work. I am glad that our dev guide was updated according to our current guidance promoting ruff usage. |
SMoraisAnsys
changed the title
github-actions bot
pushed a commit
that referenced
this pull request
May 15, 2025
* feat: Introducing Ruff config, removing .flake8, updating pre-commit-config * feat: Adding ruff-format hook to pre-commit, updating fixed files * feat: Adding linting rules to Ruff config, updating fixed file * feat: Extending Ruff linting rules list, updating fixed files * feat: Reverting change breaking doc build, updating ignored linting rules * Apply suggestions from code review Co-authored-by: Sébastien Morais <[email protected]> * feat: Updating pyansys_logging and ruff config based on review comments * Update doc/source/how-to/code/test_pyansys_logging.py Co-authored-by: Sébastien Morais <[email protected]> * feat: Removing ignored rules from ruff config and updating files accordingly * Update doc/source/how-to/code/test_pyansys_logging.py --------- Co-authored-by: Sébastien Morais <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements the change discussed in #593, i.e. migrating the pyansys-dev-guide to Ruff.
The specific configs for Black, isort and flake8 are removed and the .pre-commit-config.yaml file is updated accordingly, while a ruff.toml file defining the rules used by Ruff for linting and formatting is introduced.
Python files fixed by Ruff are updated.
Since the project does not currently contain a pyproject.toml file, it was decided not to define one for the purpose of holding the Ruff configuration, but instead to specify it in a ruff.toml file placed at the root of the project. The introduction of a pyproject.toml file is considered to be beyond the scope of this PR, which is the motivation for this choice.
Should a pyproject.toml file be created in the future, the content of the ruff.toml can simply be added to it and this config file removed.
As indicated in #593, the use of blacken-docs in .pre-commit-config.yaml is maintained as this tool (used for formatting Python code blocks in documentation files) cannot currently be replaced by Ruff, which does not support formatting/linting of embedded code (particularly in .rst or .md files, see astral-sh/ruff#8237). Similarly, blacken-docs does not support the Ruff formatter as an alternative for Black (see adamchainz/blacken-docs#352).
This tool is therefore retained (see here about the Ruff pre-commit hook astral-sh/ruff-pre-commit#55) for this project, despite the remaining dependence on Black.
Close #593