[flake8-logging] Stabilize log-exception-outside-except-handler (LOG004)

[ntBre]

Summary

Stabilizes LOG004 and updates the documentation to say explicitly that the rule still triggers even when passing the exc_info kwarg (#18044).

Test Plan

Existing tests, which were already in the right place

[github-actions]

ruff-ecosystem results

Linter (stable)

ℹ️ ecosystem check detected linter changes. (+25 -1 violations, +0 -0 fixes in 4 projects; 51 projects unchanged)

apache/airflow (+14 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --no-preview --select ALL

+ airflow-core/src/airflow/api_fastapi/execution_api/app.py:187:9: LOG004 `.exception()` call outside exception handlers
+ airflow-core/src/airflow/api_fastapi/execution_api/routes/task_instances.py:506:17: LOG004 `.exception()` call outside exception handlers
+ airflow-core/src/airflow/dag_processing/bundles/base.py:373:9: LOG004 `.exception()` call outside exception handlers
+ providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/operators/pod.py:1338:13: LOG004 `.exception()` call outside exception handlers
+ providers/edge3/src/airflow/providers/edge3/worker_api/auth.py:80:5: LOG004 `.exception()` call outside exception handlers
+ providers/edge3/src/airflow/providers/edge3/worker_api/routes/_v2_routes.py:59:5: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/cloud_sql.py:1046:13: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/dataproc.py:1604:13: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/dataproc.py:1760:13: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/dataproc.py:2258:17: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/kubernetes_engine.py:318:13: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/operators/kubernetes_engine.py:511:13: LOG004 `.exception()` call outside exception handlers
+ providers/google/src/airflow/providers/google/cloud/triggers/cloud_batch.py:145:9: LOG004 `.exception()` call outside exception handlers
+ task-sdk/tests/task_sdk/definitions/test_secrets_masker.py:136:9: LOG004 `.exception()` call outside exception handlers

apache/superset (+2 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --no-preview --select ALL

+ superset/utils/decorators.py:231:13: LOG004 `.exception()` call outside exception handlers
+ superset/views/error_handling.py:210:9: LOG004 `.exception()` call outside exception handlers

rotki/rotki (+0 -1 violations, +0 -0 fixes)

- rotkehlchen/api/server.py:436:42: RUF100 [*] Unused `noqa` directive (non-enabled: `LOG004`)

zulip/zulip (+9 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --no-fix --output-format concise --no-preview --select ALL

+ zerver/decorator.py:342:5: LOG004 `.exception()` call outside exception handlers
+ zerver/decorator.py:357:9: LOG004 `.exception()` call outside exception handlers
+ zerver/decorator.py:359:9: LOG004 `.exception()` call outside exception handlers
+ zerver/decorator.py:361:9: LOG004 `.exception()` call outside exception handlers
+ zerver/lib/email_mirror_server.py:144:13: LOG004 `.exception()` call outside exception handlers
+ zerver/lib/remote_server.py:291:9: LOG004 `.exception()` call outside exception handlers
+ zerver/worker/base.py:269:17: LOG004 `.exception()` call outside exception handlers
+ zerver/worker/base.py:271:17: LOG004 `.exception()` call outside exception handlers
+ zerver/worker/email_senders_base.py:39:17: LOG004 `.exception()` call outside exception handlers

Changes by rule (2 rules affected)

code	total	+ violation	- violation	+ fix	- fix
LOG004	25	25	0	0	0
RUF100	1	0	1	0	0

Linter (preview)

✅ ecosystem check detected no linter changes.

[ntBre]

I think this example might be a false positive:

https://github.com/zulip/zulip/blob/3dc54a10d7cbfb6f6f66a868a31d17ee9e215f53/zerver/worker/email_senders_base.py#L28-L45

It looks like a closure defined in the except handler will preserve its exc_info in the same call stack:

>>> import logging
>>> l = []
>>> def foo(f): f()
...
>>> try:
...     raise ValueError("my error")
... except ValueError:
...     logging.exception("building on_failure")
...     def on_failure():
...         logging.exception("on_failure called")
...     foo(on_failure)
...     l.append(on_failure)
...
ERROR:root:building on_failure
Traceback (most recent call last):
  File "<python-input-19>", line 2, in <module>
    raise ValueError("my error")
ValueError: my error
ERROR:root:on_failure called
Traceback (most recent call last):
  File "<python-input-19>", line 2, in <module>
    raise ValueError("my error")
ValueError: my error
>>> l[-1]()
ERROR:root:on_failure called
NoneType: None

but not if you store it somewhere else and call it later.

[ntBre]

What do you think about the false positive? This is the last LOG rule in preview, but my first thought was to leave it in preview even before this, so I'm happy to leave it for now.

[dylwil3]

I vote to leave it in preview and address the bug!

[ntBre]

Sounds good to me, thanks for opening the issue!