chore: upgrade Ruff configuration and reformat codebase by pvital · Pull Request #861 · instana/python-sensor

pvital · 2026-04-07T06:21:06Z

This PR modernizes the repository’s Ruff setup and applies the resulting formatting and lint cleanup across the codebase and tests.

Upgraded pre-commit Ruff integration in .pre-commit-config.yaml
- bumped Ruff from v0.7.0 to v0.15.9
- switched the lint hook from ruff to ruff-check
- extended formatting hook coverage to Python and Markdown files
Added Ruff configuration to pyproject.toml
- set Python target version to 3.9
- configured repository exclusions for non-source directories
- enabled preview mode and concise output
- defined lint rule selection for style, import ordering, simplification, string modernizations, and copyright checks
Applied repository-wide Ruff-driven cleanup across source and test files
- normalized import ordering
- reformatted multiline logging, context managers, assertions, and long calls
- simplified membership checks, such as key in dict instead of key in dict.keys()
- removed unused imports in several tests
- cleaned whitespace and newline issues
Fixed SonarQube failed conditions on new code
- Deleted src/instana/util/gunicorn.py since the code is duplicated in running_in_gunicorn() function from src/instana/log.py.
- Adapted code to import running_in_gunicorn() from src/instana/log.py.
- Add tests for running_in_gunicorn() to increase the coverage on new code.

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

used ruff (pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…ormat. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…ring join. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

….keys()`. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…ead of `try`-`except`-`pass`. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…aders.get(<index>, None)`. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…le contexts instead of nested `with` statements. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…sted `if` statements. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…directly. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…e`-block. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

…se True`. Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

- Deleted `src/instana/util/gunicorn.py` since the code is duplicated in `running_in_gunicorn()` function from `src/instana/log.py`. - Adapted code to import `running_in_gunicorn()` from `src/instana/log.py`. - Add tests for `running_in_gunicorn()` to increase the coverage on new code. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

sonarqubecloud · 2026-04-07T12:51:33Z

Quality Gate failed

Failed conditions
3.4% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

GSVarsha · 2026-04-09T05:42:33Z

src/instana/util/config.py

-        if tracing_disable_config := config["tracing"].get("disable", None):
-            return parse_span_disabling(tracing_disable_config)
+    if "tracing" in config and (
+        tracing_disable_config := config["tracing"].get("disable", None)


Suggested change

tracing_disable_config := config["tracing"].get("disable", None)

tracing_disable_config := config["tracing"].get("disable")

Interesting to see how Ruff did not catch this SIM910. It should be part of commit 08083c5.

GSVarsha · 2026-04-09T05:55:04Z

src/instana/util/span_utils.py

+    return bool(
+        rule_value == "*"
+        or match_type == "strict"
+        and span_value == rule_value
+        or match_type == "contains"
+        and rule_value in span_value
+        or match_type == "startswith"
+        and span_value.startswith(rule_value)
+        or match_type == "endswith"
+        and span_value.endswith(rule_value)
+    )


Just a slight adjustment for better readability.
Also I think we don't need the bool() wrapper here, as all those comparison operators already return boolean values.

Suggested change

return bool(

rule_value == "*"

or match_type == "strict"

and span_value == rule_value

or match_type == "contains"

and rule_value in span_value

or match_type == "startswith"

and span_value.startswith(rule_value)

or match_type == "endswith"

and span_value.endswith(rule_value)

)

return (

rule_value == "*" or

(match_type == "strict" and span_value == rule_value) or

(match_type == "contains" and rule_value in span_value) or

(match_type == "startswith" and span_value.startswith(rule_value)) or

(match_type == "endswith" and span_value.endswith(rule_value))

)

I'll try to apply your suggestion, but probably this will be re-formatted back to the original by Ruff when running the pre-commit rule. Let's see.

GSVarsha · 2026-04-09T05:59:19Z

tests/apps/fastapi_app/__init__.py

 import uvicorn
 from ...helpers import testenv
-from instana.log import logger
+from instana.log import logger as logger


Do we need this change?

I don't think so. Will remove this line

GSVarsha · 2026-04-09T06:09:00Z

src/instana/collector/helpers/fargate/docker.py

+
 from ....log import logger
-from ..base import BaseHelper
 from ....util import DictionaryOfStan
+from ..base import BaseHelper


Can we change these relative imports to absolute imports?

GSVarsha

Just a few suggestions

pvital self-assigned this Apr 7, 2026

pvital added the chore label Apr 7, 2026

pvital changed the title ~~Ruff update~~ chore: upgrade Ruff configuration and reformat codebase Apr 7, 2026

pvital force-pushed the ruff_update branch from 82784ed to 3b107e9 Compare April 7, 2026 12:36

pvital added 22 commits April 7, 2026 14:38

chore: update Ruff's project lint config

bba824e

Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [E117] - Over-indented

49b6a49

used ruff (pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations, like unused imports. - isort-compatible import sorting. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [F401] - {package} imported but unused.

520a69d

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [E302] - Expected 2 blank lines, found 1.

75d649f

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [E303] - Too many blank lines (2).

4c80d51

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [E222] - Multiple spaces after operator.

f602ecd

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

style: fix error [SIM300] - Yoda condition detected.

d895a3b

Used Ruff (vscode and pre-commit) to: - Black-compatible code formatting. - fix all auto-fixable violations. - isort-compatible import sorting. - flake8-simplify manual fixes. Signed-off-by: Paulo Vital <paulo.vital@ibm.com>

pvital force-pushed the ruff_update branch from 3b107e9 to 3516d15 Compare April 7, 2026 12:39

pvital marked this pull request as ready for review April 7, 2026 20:14

pvital requested a review from a team as a code owner April 7, 2026 20:14

GSVarsha reviewed Apr 9, 2026

View reviewed changes

GSVarsha requested changes Apr 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: upgrade Ruff configuration and reformat codebase#861

chore: upgrade Ruff configuration and reformat codebase#861
pvital wants to merge 22 commits intomainfrom
ruff_update

pvital commented Apr 7, 2026 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Apr 7, 2026

Uh oh!

GSVarsha Apr 9, 2026

Uh oh!

pvital Apr 9, 2026

Uh oh!

GSVarsha Apr 9, 2026

Uh oh!

pvital Apr 9, 2026

Uh oh!

GSVarsha Apr 9, 2026

Uh oh!

pvital Apr 9, 2026

Uh oh!

GSVarsha Apr 9, 2026

Uh oh!

GSVarsha left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	tracing_disable_config := config["tracing"].get("disable", None)
	tracing_disable_config := config["tracing"].get("disable")

Conversation

pvital commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 7, 2026

Quality Gate failed

Uh oh!

GSVarsha Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

pvital Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

GSVarsha Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

pvital Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

GSVarsha Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

pvital Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

GSVarsha Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

GSVarsha left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pvital commented Apr 7, 2026 •

edited

Loading