Introduces ruff as linter and formatter #38
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
StephenNneji
approved these changes
Jun 26, 2024
setup.py
Outdated
| install_requires=["numpy >= 1.20", "prettytable >= 3.9.0", "pydantic >= 2.7.2", "matplotlib >= 3.8.3"], | ||
| extras_require={ | ||
| ':python_version < "3.11"': ["StrEnum >= 0.4.15"], | ||
| "Dev": ["pytest>=7.4.0", "pytest-cov>=4.1.0"], |
Contributor
There was a problem hiding this comment.
please add ruff to the dev requirement
| author_email="", | ||
| url="https://github.com/RascalSoftware/python-RAT", | ||
| description="Python extension for the Reflectivity Analysis Toolbox (RAT)", | ||
| long_description=open("README.md").read(), # noqa: SIM115 |
Contributor
There was a problem hiding this comment.
I will move this to a context manager in my next PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #27
We should consider the rule set we have as standard. I've gone for the advanced set here: https://docs.astral.sh/ruff/linter/#rule-selection which seem to do the job quite well, but I've excluded a rule preferring ternary operators to if-else blocks. However, the rules can be turned on and off in a very fine grained way (i.e., by category, subcategory, and individual rule). We can also exclude particular files, or even lines from a rule (as we do here in line 156 of setup.py). So let me know what you think. The full ruleset is here: https://docs.astral.sh/ruff/rules/