Skip to content

MNT: Add flake8-logging-format (G) rules to ruff #3242

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

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Conversation

DimitriPapadopoulos
Copy link
Contributor

@DimitriPapadopoulos DimitriPapadopoulos commented Feb 29, 2024

Changes proposed in this pull request

ruff check --select G

Documentation that should be reviewed

Copy link

codecov bot commented Feb 29, 2024

Codecov Report

Attention: Patch coverage is 64.28571% with 5 lines in your changes missing coverage. Please review.

Project coverage is 73.57%. Comparing base (1a0610e) to head (e105688).

Files with missing lines Patch % Lines
fmriprep/interfaces/reports.py 0.00% 3 Missing ⚠️
fmriprep/interfaces/workbench.py 0.00% 1 Missing ⚠️
fmriprep/utils/telemetry.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3242      +/-   ##
==========================================
+ Coverage   73.52%   73.57%   +0.05%     
==========================================
  Files          60       60              
  Lines        4570     4568       -2     
  Branches      583      582       -1     
==========================================
+ Hits         3360     3361       +1     
+ Misses       1083     1081       -2     
+ Partials      127      126       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@effigies
Copy link
Member

effigies commented Mar 4, 2024

I'm not sure why we should care about this.

@DimitriPapadopoulos
Copy link
Contributor Author

DimitriPapadopoulos commented Mar 4, 2024

The linter recommends that because that's what many programmers suggest: defer string interpolation to the log function so that string interpolation doesn't occur whenever the log function doesn't print at the current log level. So that would be a performance issue. The rationale is that the speed gain when deferring string interpolation with terse logging outwheighs the speed gain of f-strings with verbose logging. Other programmers don't agree.

G004 Logging statement uses f-string
FLY002 Consider f-string instead of string join
PERF403 Use a dictionary comprehension instead of a for-loop
PGH003 Use specific rule codes when ignoring type issues
PLE1205 Too many arguments for `logging` format string
RUF010 Use explicit conversion flag
RUF013 PEP 484 prohibits implicit `Optional`
RUF021 Parenthesize `a and b` expressions when chaining `and` and `or` together, to make the precedence clear
RUF100 Unused `noqa` directive
F841 Local variable is assigned to but never used
FURB192 Prefer `max` over `sorted()` to compute the maximum value in a sequence
RUF028 This suppression comment is invalid because it cannot be in an
expression, pattern, argument list, or other non-statement
RUF039 First argument is not raw string
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.

2 participants