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

Switch from black and flake8 to ruff for Python files #24590

Merged
merged 15 commits into from
Apr 18, 2024

Conversation

FlorentClarret
Copy link
Member

@FlorentClarret FlorentClarret commented Apr 11, 2024

What does this PR do?

We currently use:

  • flake8: linter
  • black: code formatter
  • isort: sort the imports

We drop them all to replace them with ruff which can do the same things! I also updated the hooks, people that are using them won't need to do anything.

I kept almost the same rules we already have to avoid modifying too many things. We will probably update some of them in the future.

Motivation

  • The versions that we use are getting old and we will need to bump them eventually (more than 3 years for flake8).
  • Ruff can now format the code, so that will be less tools to use, install and maintain.
  • Even if we do not have a lot of python files, ruff is also faster than the tools we use.
  • This is the recommended tool to use in our python community
  • Ruff is faster than them, but this is not that important here because we do not have a lot of python files
  • We also use this tool in integrations-core

Additional Notes

  • Most Python files in this repo are either tests or tools. This is not going to impact the agent itself.
  • I'll drop the dependencies from the base image in a follow-up PR
  • We won't merge this PR right away and make several announcements first so people will be warned
  • People that are using the invoke task will need to pip install the dependencies

This PR depends on:

https://datadoghq.atlassian.net/browse/ADXT-186

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

test/e2e/containers/fake_datadog/app/api.py Dismissed Show dismissed Hide dismissed
@FlorentClarret FlorentClarret force-pushed the florentclarret/ruff branch 6 times, most recently from 07615e1 to 67d65a4 Compare April 12, 2024 07:17
@FlorentClarret FlorentClarret added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Apr 12, 2024
@FlorentClarret FlorentClarret added this to the 7.54.0 milestone Apr 12, 2024
@pr-commenter
Copy link

pr-commenter bot commented Apr 12, 2024

Regression Detector

Regression Detector Results

Run ID: 7c3a6e11-25f9-49f6-9144-1a6ef15c1d47
Baseline: ffb7c2f
Comparison: a8fcc26

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization +2.34 [-3.71, +8.40]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization +2.34 [-3.71, +8.40]
pycheck_1000_100byte_tags % cpu utilization +2.22 [-2.72, +7.16]
process_agent_standard_check_with_stats memory utilization +0.35 [+0.30, +0.39]
otel_to_otel_logs ingress throughput +0.27 [-0.14, +0.69]
uds_dogstatsd_to_api_cpu % cpu utilization +0.14 [-2.81, +3.09]
process_agent_standard_check memory utilization +0.11 [+0.06, +0.17]
file_tree memory utilization +0.03 [-0.09, +0.15]
trace_agent_msgpack ingress throughput +0.02 [+0.01, +0.03]
uds_dogstatsd_to_api ingress throughput +0.01 [-0.19, +0.22]
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.04, +0.03]
trace_agent_json ingress throughput -0.01 [-0.03, +0.01]
idle memory utilization -0.10 [-0.14, -0.06]
process_agent_real_time_mode memory utilization -0.12 [-0.17, -0.08]
tcp_syslog_to_blackhole ingress throughput -0.14 [-0.23, -0.06]
basic_py_check % cpu utilization -1.64 [-4.15, +0.86]

Explanation

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

pyproject.toml Outdated Show resolved Hide resolved
@FlorentClarret FlorentClarret marked this pull request as ready for review April 15, 2024 14:44
@FlorentClarret FlorentClarret requested review from a team as code owners April 15, 2024 14:44
Copy link
Contributor

@louis-cqrl louis-cqrl left a comment

Choose a reason for hiding this comment

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

LGTM for files that ASC owns

pkg/config/legacy/tests/config.py Show resolved Hide resolved
tasks/build_tags.py Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@KSerrania KSerrania mentioned this pull request Apr 17, 2024
10 tasks
@FlorentClarret
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Apr 18, 2024

🚂 MergeQueue

Pull request added to the queue.

This build is going to start soon! (estimated merge in less than 25m)

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit b0d6c2d into main Apr 18, 2024
360 checks passed
@dd-mergequeue dd-mergequeue bot deleted the florentclarret/ruff branch April 18, 2024 05:08
CelianR pushed a commit that referenced this pull request Apr 26, 2024
* Switch from black and flake8 to ruff for Python files

* fix

* Update .pre-commit-config.yaml

* Update pyproject.toml

* address

* fix fmt

* future

* noqa

* fix comment
alexgallotta pushed a commit that referenced this pull request May 9, 2024
* Switch from black and flake8 to ruff for Python files

* fix

* Update .pre-commit-config.yaml

* Update pyproject.toml

* address

* fix fmt

* future

* noqa

* fix comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.