Skip to content
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.

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

Update Ruff Rules #1080

Merged
merged 8 commits into from
Aug 28, 2024
Merged

Update Ruff Rules #1080

merged 8 commits into from
Aug 28, 2024

Conversation

caseyhans
Copy link
Collaborator

@caseyhans caseyhans commented Aug 14, 2024

Update code base to accept previously ignored ruff rules.

  • Return errors when caught and raised
  • Unused iterable variable names prefixed with underscores
  • Add a 15 second timeout to any GET and POST requests

Notes on other ignored rules:
S308: using mark_safe
- we use this a lot in template tags
- HERO uses a custom HTML sanitizer that calls mark_safe, which is then flagged as safe inline
- We could use this approach, or flag all our mark_safes inline

S314: raised when parsing XML input; I believe it'd require a new package to solve (defusedxml)
- 4 cases; could flag inline & remove from ignore list
- 3 cases are from parsing pubmed imports, one other is in a lit migration (0012) that parses HERO/RIS

S603: executing subprocess calls on "untrusted" inputs
- 4 cases; could be flagged as safe inline
- two of these cases are in the assessment_db_dump.py command for getting the db name from settings
- two of these are in the git.py commit model that returns last commit info; runs "git log" and grabs output

RUF012: 825 errors. too many to fix. related to mutable class attribute annotations

RUF015: iteration check; 3 failing cases, could be flagged safe inline

@caseyhans caseyhans marked this pull request as ready for review August 26, 2024 19:31
Copy link
Collaborator

@munnsmunns munnsmunns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to merge, nice job!

hawc/apps/common/api/mixins.py Dismissed Show dismissed Hide dismissed
@shapiromatron shapiromatron merged commit 71fb396 into main Aug 28, 2024
6 checks passed
@shapiromatron shapiromatron deleted the add-ruff-rules branch August 28, 2024 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants