Skip to content

Clean up check.sh, move stuff to pre-commit #3157

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Dec 24, 2024
Merged

Clean up check.sh, move stuff to pre-commit #3157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9b3783f
remove ruff, black, codespell, and gen-exports from check.sh as they'…
jakkdl Dec 17, 2024
84433f4
move pip-compile tests to pre-commit
jakkdl Dec 17, 2024
7557558
restore pip-compile in check.sh, skip in CI
jakkdl Dec 17, 2024
b38faba
make regenerate-files runnable in CI, with the downside of not freezi…
jakkdl Dec 17, 2024
17d3d05
fix skip
jakkdl Dec 17, 2024
4633591
Merge remote-tracking branch 'origin/main' into cleanup_checksh
jakkdl Dec 22, 2024
22215d0
restore gen_exports in check.sh, skip in pre-commit+ci
jakkdl Dec 22, 2024
b4d08e1
make check.sh call pre-commit
jakkdl Dec 23, 2024
8f787d6
it seems uv pip-compile is sorting the requirements now
jakkdl Dec 23, 2024
2bc884c
Merge branch 'main' into cleanup_checksh
jakkdl Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ ci:
autofix_prs: true
autoupdate_schedule: weekly
submodules: false
skip: [regenerate-files]
# pip-compile requires internet, regenerate-files may get cache
# issues in CI, so they're run in check.sh
skip: [pip-compile, regenerate-files]

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
Expand Down Expand Up @@ -44,7 +46,30 @@ repos:
hooks:
- id: regenerate-files
name: regenerate generated files
language: system
language: python
entry: python src/trio/_tools/gen_exports.py
pass_filenames: false
additional_dependencies: ["astor", "attrs", "black", "ruff"]
files: ^src\/trio\/_core\/(_run|(_i(o_(common|epoll|kqueue|windows)|nstrumentation)))\.py$
- repo: https://github.com/astral-sh/uv-pre-commit
rev: 0.5.9
hooks:
# Compile requirements
- id: pip-compile
name: uv pip-compile test-requirements.in
args: [
"--universal",
"--python-version=3.9",
"test-requirements.in",
"-o",
"test-requirements.txt"]
files: ^test-requirements\.(in|txt)$
- id: pip-compile
name: uv pip-compile docs-requirements.in
args: [
"--universal",
"--python-version=3.11",
"docs-requirements.in",
"-o",
"docs-requirements.txt"]
files: ^docs-requirements\.(in|txt)$
55 changes: 4 additions & 51 deletions check.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,38 +17,6 @@ python ./src/trio/_tools/gen_exports.py --test \
|| EXIT_STATUS=$?
echo "::endgroup::"
Copy link
Contributor

Choose a reason for hiding this comment

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

I probably should do this in another PR but I think we should move gen exports out of pre-commit and back here. Unfortunately, as things currently are, if you modify a file that the pre-commit hook says it uses then commit with a git client (ie not just git commit -m "..." in the venv you have for trio), gen_exports doesn't get the dependencies it needs.

So far I've been getting that error then going to my terminal to run git there, but that's a bit much.

Copy link
Member

Choose a reason for hiding this comment

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

Pre-commit with a external git client doesn't install required dependencies?

Copy link
Contributor

Choose a reason for hiding this comment

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

Nope, because we don't specify them. We don't specify them because pre-commit doesn't let you install from a requirements file :(

Copy link
Member Author

Choose a reason for hiding this comment

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

I specified them in the latest commit:

trio/.pre-commit-config.yaml

Line 46 in 17d3d05

additional_dependencies: ["astor", "attrs", "black", "ruff"]

but that doesn't let us pin the versions (in a non-awful way), so yeah if we don't want that then it has to go outside of pre-commit

Copy link
Member

Choose a reason for hiding this comment

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

trio/.pre-commit-config.yaml

Line 46 in 17d3d05

additional_dependencies: ["astor", "attrs", "black", "ruff"]

Keep in mind that the pre-commit cache is virtually immortal. You can clean it locally, but not in the pre-commit.ci service. For that, changing the deps list or the hook version is required. This may be problematic sometimes.

So I've found that the best thing to do here is to keep the version pins in the list and bump them periodically. Just so that the cache doesn't grow too old.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I'm personally a big fan of tox. #2790 discussed hatchling too but we ended up bikeshedding too much to actually do anything in the end.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd be happy to switch to nox -- potentially or tox. I haven't used either and attrs uses tox so it can't be that bad, but https://hynek.me/articles/why-i-like-nox/ is convincing to me...

Copy link
Member Author

Choose a reason for hiding this comment

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

I've yet to use nox, but would def be open to.

Copy link
Member

Choose a reason for hiding this comment

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

I've contributed to projects with nox, and they're slightly more inconvenient. I'd also want to run nox python files under coverage.

one thing to bear in mind with tox is that constraints are a bit of a pain, tox-uv and a lock file seems the way to go:

https://github.com/tox-dev/tox-uv?tab=readme-ov-file#uvlock-support

Copy link
Member

@webknjaz webknjaz Dec 26, 2024 •
edited by CoolCat467
Loading

Choose a reason for hiding this comment

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

I've been taking DIY lock files to extremes with tox for a while. Haven't yet tried uv for that, really. I know that they were implementing the poetry-style format, not real lock files. I'm looking forward to seeing Brett's PEP accepted, honestly.

I also have a lot more experience with tox and haven't contributed to nox. Although, I have contributed to projects using nox. There's limitations for parallelism, for example. Some scripting would be more convenient in Python. However, tox 4 has a toxfile.py that should be able to cover a lot of that. I'm yet to play with it properly.


# Autoformatter *first*, to avoid double-reporting errors
# (we'd like to run further autoformatters but *after* merging;
# see https://forum.bors.tech/t/pre-test-and-pre-merge-hooks/322)
# autoflake --recursive --in-place .
# pyupgrade --py3-plus $(find . -name "*.py")
echo "::group::Black"
if ! black --check src/trio; then
echo "* Black found issues" >> "$GITHUB_STEP_SUMMARY"
EXIT_STATUS=1
black --diff src/trio
echo "::endgroup::"
echo "::error:: Black found issues"
else
echo "::endgroup::"
fi

# Run ruff, configured in pyproject.toml
echo "::group::Ruff"
if ! ruff check .; then
echo "* ruff found issues." >> "$GITHUB_STEP_SUMMARY"
EXIT_STATUS=1
if $ON_GITHUB_CI; then
ruff check --output-format github --diff .
else
ruff check --diff .
fi
echo "::endgroup::"
echo "::error:: ruff found issues"
else
echo "::endgroup::"
fi

# Run mypy on all supported platforms
# MYPY is set if any of them fail.
MYPY=0
Expand Down Expand Up @@ -77,25 +45,11 @@ if [ $MYPY -ne 0 ]; then
fi

# Check pip compile is consistent
echo "::group::Pip Compile - Tests"
uv pip compile --universal --python-version=3.9 test-requirements.in -o test-requirements.txt
echo "::endgroup::"
echo "::group::Pip Compile - Docs"
uv pip compile --universal --python-version=3.11 docs-requirements.in -o docs-requirements.txt
echo "::group::Pip Compile - Tests & Docs"
pre-commit run pip-compile --all-files \
|| EXIT_STATUS=$?
echo "::endgroup::"

if git status --porcelain | grep -q "requirements.txt"; then
echo "::error::requirements.txt changed."
echo "::group::requirements.txt changed"
echo "* requirements.txt changed" >> "$GITHUB_STEP_SUMMARY"
git status --porcelain
git --no-pager diff --color ./*requirements.txt
EXIT_STATUS=1
echo "::endgroup::"
fi

codespell || EXIT_STATUS=$?
Copy link
Contributor

@A5rocks A5rocks Dec 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

(not the right line because github isn't letting me comment there)

Should you remove the uv pip compile lines above? And also update the error message + add a pre-commit run -a line in check.sh so people can run check.sh locally? (I'm not sure people do run check.sh locally but...)

Copy link
Member Author

@jakkdl jakkdl Dec 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Realized we can't do uv pip compile in pre-commit in CI since it needs internet, so it needs to be here (or somewhere).

My goal is not to require/expect people to run check.sh locally as it's unintuitive and clunky, but given the limitations of pre-commit we do need to stash these somewhere and make it easy for users to run them locally if they want.
I'd personally vote for tox (due to familiarity), and set up environments for the different tests.

Copy link
Member

Choose a reason for hiding this comment

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

I usually wrap the pre-commit invocation in tox for local run anyway + run it in CI too, which covers the case of the service not having the internet during testing.

Copy link
Member

Choose a reason for hiding this comment

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

We could also add a local system hook to pre-commit that runs check.sh if we were worried about people forgetting to run it

Copy link
Member Author

Choose a reason for hiding this comment

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

We could also add a local system hook to pre-commit that runs check.sh if we were worried about people forgetting to run it

There's several problems with doing this currently:

  1. mypy is actually failing in my workdir, probably due to something dirty in my env. tox/nox would fix this
  2. running check.sh takes a full minute on my current system, so I don't want to run it on every commit (pre-commit run --all-files takes ~8 seconds)
  3. I catch most type errors from running mypy through pylsp in my editor anyway

So I don't ~ever run check.sh locally, and don't expect others to either. (Nor do I run ci.sh, I prefer manually running pytest)

This def isn't super obvious for new contributors though, but tox/nox should help with that. E.g. in tox you can create a label for a collection of environments that is considered "standard" to run locally.


echo "::group::Pyright interface tests"
python src/trio/_tests/check_type_completeness.py || EXIT_STATUS=$?

Expand All @@ -113,8 +67,7 @@ Problems were found by static analysis (listed above).
To fix formatting and see remaining errors, run

uv pip install -r test-requirements.txt
black src/trio
ruff check src/trio
pre-commit run --all-files
Copy link
Member

Choose a reason for hiding this comment

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

hook stage manual?

Copy link
Member Author

Choose a reason for hiding this comment

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

?
We don't have any manual hooks anymore

Copy link
Member

Choose a reason for hiding this comment

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

ah I see, it might be worth using hook stage manual here, just in case any get added

Copy link
Member Author

Choose a reason for hiding this comment

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

it feels kinda weird suggesting people do stuff that is completely redundant/ineffective. And if we do add manual stages there's perhaps gonna be a decent reason we make them manual? Idk I'll leave it as is /shrug

./check.sh

in your local checkout.
Expand Down
6 changes: 3 additions & 3 deletions docs-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ beautifulsoup4==4.12.3
# via sphinx-codeautolink
certifi==2024.8.30
# via requests
cffi==1.17.1 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
cffi==1.17.1 ; os_name == 'nt' or platform_python_implementation != 'PyPy'
# via
# -r docs-requirements.in
# cryptography
charset-normalizer==3.4.0
# via requests
click==8.1.7
# via towncrier
colorama==0.4.6 ; sys_platform == 'win32' or platform_system == 'Windows'
colorama==0.4.6 ; platform_system == 'Windows' or sys_platform == 'win32'
# via
# click
# sphinx
Expand Down Expand Up @@ -51,7 +51,7 @@ outcome==1.3.0.post0
# via -r docs-requirements.in
packaging==24.2
# via sphinx
pycparser==2.22 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
pycparser==2.22 ; os_name == 'nt' or platform_python_implementation != 'PyPy'
# via cffi
pygments==2.18.0
# via sphinx
Expand Down
1 change: 1 addition & 0 deletions test-requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ ruff >= 0.8.0
astor # code generation
uv >= 0.2.24
codespell
pre-commit

# https://github.com/python-trio/trio/pull/654#issuecomment-420518745
mypy-extensions
Expand Down
25 changes: 21 additions & 4 deletions test-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,19 @@ black==24.10.0 ; implementation_name == 'cpython'
# via -r test-requirements.in
certifi==2024.8.30
# via requests
cffi==1.17.1 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
cffi==1.17.1 ; os_name == 'nt' or platform_python_implementation != 'PyPy'
# via
# -r test-requirements.in
# cryptography
cfgv==3.4.0
# via pre-commit
charset-normalizer==3.4.0
# via requests
click==8.1.7 ; implementation_name == 'cpython'
# via black
codespell==2.3.0
# via -r test-requirements.in
colorama==0.4.6 ; (implementation_name != 'cpython' and sys_platform == 'win32') or (platform_system != 'Windows' and sys_platform == 'win32') or (implementation_name == 'cpython' and platform_system == 'Windows')
colorama==0.4.6 ; (implementation_name == 'cpython' and platform_system == 'Windows') or sys_platform == 'win32'
# via
# click
# pylint
Expand All @@ -44,12 +46,18 @@ cryptography==43.0.3
# types-pyopenssl
dill==0.3.9
# via pylint
distlib==0.3.9
# via virtualenv
docutils==0.21.2
# via sphinx
exceptiongroup==1.2.2 ; python_full_version < '3.11'
# via
# -r test-requirements.in
# pytest
filelock==3.16.1
# via virtualenv
identify==2.6.3
# via pre-commit
idna==3.10
# via
# -r test-requirements.in
Expand Down Expand Up @@ -79,7 +87,9 @@ mypy-extensions==1.0.0
# black
# mypy
nodeenv==1.9.1
# via pyright
# via
# pre-commit
# pyright
orjson==3.10.12 ; implementation_name == 'cpython'
# via -r test-requirements.in
outcome==1.3.0.post0
Expand All @@ -97,9 +107,12 @@ platformdirs==4.3.6
# via
# black
# pylint
# virtualenv
pluggy==1.5.0
# via pytest
pycparser==2.22 ; platform_python_implementation != 'PyPy' or os_name == 'nt'
pre-commit==4.0.1
# via -r test-requirements.in
pycparser==2.22 ; os_name == 'nt' or platform_python_implementation != 'PyPy'
# via cffi
pygments==2.18.0
# via sphinx
Expand All @@ -111,6 +124,8 @@ pyright==1.1.389
# via -r test-requirements.in
pytest==8.3.3
# via -r test-requirements.in
pyyaml==6.0.2
# via pre-commit
requests==2.32.3
# via sphinx
ruff==0.8.2
Expand Down Expand Up @@ -168,5 +183,7 @@ urllib3==2.2.3
# via requests
uv==0.5.5
# via -r test-requirements.in
virtualenv==20.28.0
# via pre-commit
zipp==3.21.0 ; python_full_version < '3.10'
# via importlib-metadata
Loading