mirror of
https://github.com/astral-sh/ruff.git
synced 2025-11-19 12:16:43 +00:00
Update usage instructions and lockfile for py-fuzzer script (#20940)
This commit is contained in:
parent
0115fd3757
commit
c424007645
6 changed files with 98 additions and 79 deletions
|
|
@ -4,24 +4,21 @@ Python source-code files.
|
|||
|
||||
This script can be installed into a virtual environment using
|
||||
`uv pip install -e ./python/py-fuzzer` from the Ruff repository root,
|
||||
or can be run using `uvx --from ./python/py-fuzzer fuzz`
|
||||
or can be run using `uv run --project=./python/py-fuzzer fuzz`
|
||||
(in which case the virtual environment does not need to be activated).
|
||||
Note that using `uv run --project` rather than `uvx --from` means that
|
||||
uv will respect the script's lockfile.
|
||||
|
||||
Example invocations of the script using `uv`:
|
||||
- Run the fuzzer on Ruff's parser using seeds 0, 1, 2, 78 and 93 to generate the code:
|
||||
`uvx --from ./python/py-fuzzer fuzz --bin ruff 0-2 78 93`
|
||||
`uv run --project=./python/py-fuzzer fuzz --bin ruff 0-2 78 93`
|
||||
- Run the fuzzer concurrently using seeds in range 0-10 inclusive,
|
||||
but only reporting bugs that are new on your branch:
|
||||
`uvx --from ./python/py-fuzzer fuzz --bin ruff 0-10 --only-new-bugs`
|
||||
`uv run --project=./python/py-fuzzer fuzz --bin ruff 0-10 --only-new-bugs`
|
||||
- Run the fuzzer concurrently on 10,000 different Python source-code files,
|
||||
using a random selection of seeds, and only print a summary at the end
|
||||
(the `shuf` command is Unix-specific):
|
||||
`uvx --from ./python/py-fuzzer fuzz --bin ruff $(shuf -i 0-1000000 -n 10000) --quiet
|
||||
|
||||
If you make local modifications to this script, you'll need to run the above
|
||||
with `--reinstall` to get your changes reflected in the uv-cached installed
|
||||
package. Alternatively, if iterating quickly on changes, you can add
|
||||
`--with-editable ./python/py-fuzzer`.
|
||||
`uv run --project=./python/py-fuzzer fuzz --bin ruff $(shuf -i 0-1000000 -n 10000) --quiet
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue