[python] Add pyproject and lint with ruff

Author: KowalskiThomas

pyproject.toml

@@ -0,0 +1,61 @@
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+    "F",     # Pyflakes
+    "E",     # pycodestyle errors
+    "W",     # pycodestyle warnings
+    "C90",   # mccabe complexity
+    "I",     # isort
+    "N",     # pep8-naming
+    "UP",    # pyupgrade
+    "ANN",   # flake8-annotations
+    "ASYNC", # flake8-async
+    "S",     # flake8-bandit
+    "BLE",   # flake8-blind-except
+    "B",     # flake8-bugbear
+    "A",     # flake8-builtins
+    "C4",    # flake8-comprehensions
+    "DTZ",   # flake8-datetimez
+    "T10",   # flake8-debugger
+    "EM",    # flake8-errmsg
+    "ISC",   # flake8-implicit-str-concat
+    "ICN",   # flake8-import-conventions
+    "G",     # flake8-logging-format
+    "PIE",   # flake8-pie
+    "T20",   # flake8-print
+    "PT",    # flake8-pytest-style
+    "Q",     # flake8-quotes
+    "RSE",   # flake8-raise
+    "RET",   # flake8-return
+    "SIM",   # flake8-simplify
+    "TID",   # flake8-tidy-imports
+    "ARG",   # flake8-unused-arguments
+    "PTH",   # flake8-use-pathlib
+    "ERA",   # eradicate
+    "PL",    # Pylint
+    "PERF",  # Perflint
+    "RUF",   # Ruff-specific rules
+]
+ignore = [
+    "D203",    # one-blank-line-before-class (conflicts with D211)
+    "D213",    # multi-line-summary-second-line (conflicts with D212)
+    "T201",    # print statement used
+    "PLR2004", # constant variable
+]
+
+[tool.ruff.lint.per-file-ignores]
+"**/__init__.py" = ["D104"]        # missing docstring in public package
+"**/test_*.py" = ["S101", "D"]     # allow assert in tests, skip docstrings
+"**/tests/**/*.py" = ["S101", "D"] # allow assert in tests, skip docstrings
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.isort]
+known-first-party = ["scenarios"]

scenarios/python_asyncio_3.11/main.py

@@ -1,5 +1,7 @@
-import os
 import asyncio
+import os
+
+from ddtrace.profiling import Profiler
 
 
 async def my_coroutine(n: float) -> None:
@@ -21,20 +23,18 @@ async def main() -> None:
     # We are in the process of making asyncio better in dd-trace-py; we will update the correctness check once that
     # issue is fixed.
 
-    from ddtrace.profiling import Profiler
-
     prof = Profiler()
     prof.start()  # Should be as early as possible, eg before other imports, to ensure everything is profiled
 
     # Give the Profiler some time to start up
     await asyncio.sleep(0.5)
 
-    EXECUTION_TIME_SEC = float(os.environ.get("EXECUTION_TIME_SEC", "2"))
+    execution_time_sec = float(os.environ.get("EXECUTION_TIME_SEC", "2"))
 
-    short_task = asyncio.create_task(my_coroutine(EXECUTION_TIME_SEC / 2))
+    short_task = asyncio.create_task(my_coroutine(execution_time_sec / 2))
 
     # asyncio.gather will automatically wrap my_coroutine into a Task
-    await asyncio.gather(short_task, my_coroutine(EXECUTION_TIME_SEC))
+    await asyncio.gather(short_task, my_coroutine(execution_time_sec))
 
 
 if __name__ == "__main__":

scenarios/python_basic_3.11/main.py

@@ -1,10 +1,11 @@
 import os
 from threading import Thread
 from time import sleep
+
 from ddtrace.profiling import Profiler
 
 
-def target(n):
+def target(n: int) -> None:
     sleep(n)
 
 

scenarios/python_basic_gevent/main.py

@@ -3,13 +3,12 @@
 monkey.patch_all()
 
 import os  # noqa: E402
+import time  # noqa: E402
 from threading import Thread  # noqa: E402
 
 
 def target(n: int) -> None:
     # Do actual work instead of just sleeping so profiler can capture it
-    import time
-
     end_time = time.monotonic() + n
     count = 0
     while time.monotonic() < end_time:

scenarios/python_cpu/expected_profile.json

@@ -5,7 +5,7 @@
       "profile-type": "cpu-time",
       "stack-content": [
         {
-          "regular_expression": "<module>;main;b",
+          "regular_expression": "<module>;.*main;.*b",
           "percent": 66,
           "error_margin": 5,
           "labels": [
@@ -18,7 +18,7 @@
           ]
         },
         {
-          "regular_expression": "<module>;main;a",
+          "regular_expression": "<module>;.*main;.*a",
           "percent": 33,
           "error_margin": 6,
           "labels": [

scenarios/python_cpu/main.py

@@ -1,37 +1,33 @@
 import os
 from time import time
 
-x = 0
-i = 0
 
+class CPUBurner:
+    def __init__(self) -> None:
+        self.x = 0
+        self.i = 0
 
-def main():
-    global x, i
-    EXECUTION_TIME_SEC = int(
-        os.getenv("EXECUTION_TIME_SEC", "10")
-    )  # defaults to 10 if not set
-    end = time() + EXECUTION_TIME_SEC
-    while time() < end:
-        a()
-        b()
-    # We add a print to prevent optimization that could turn this into a no-op program
-    print(x)
+    def a(self) -> None:
+        self.i = 0
+        while self.i < 1000000:
+            self.x += self.i
+            self.i += 1
 
+    def b(self) -> None:
+        self.i = 0
+        while self.i < 2000000:
+            self.x += self.i
+            self.i += 1
 
-def a():
-    global x, i
-    i = 0
-    while i < 1000000:
-        x += i
-        i += 1
+    def main(self) -> None:
+        execution_time_sec = int(os.getenv("EXECUTION_TIME_SEC", "10"))  # defaults to 10 if not set
+        end = time() + execution_time_sec
+        while time() < end:
+            self.a()
+            self.b()
 
+        # We add a print to prevent optimization that could turn this into a no-op program
+        print(self.x)
 
-def b():
-    global x, i
-    i = 0
-    while i < 2000000:
-        x += i
-        i += 1
 
-
-main()
+CPUBurner().main()

scenarios/python_uwsgi_3.11/app.py

@@ -9,7 +9,7 @@
 
 
 def _make_requests() -> None:
-    run_time = int(os.environ.get("EXECUTION_TIME_SEC", 10))
+    run_time = int(os.environ.get("EXECUTION_TIME_SEC", "10"))
 
     start = time.monotonic()
     while time.monotonic() - start < run_time: