Lint: call tools inside venv using make's PYTHON #2408
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,45 @@ | ||
| # Builds PEP files to HTML using sphinx | ||
|
|
||
| PYTHON=python3 | ||
| VENVDIR=.venv | ||
| JOBS=8 | ||
| RENDER_COMMAND=$(VENVDIR)/bin/python3 build.py -j $(JOBS) | ||
|
|
||
| render: venv | ||
| $(RENDER_COMMAND) | ||
|
|
||
| pages: venv rss | ||
| $(RENDER_COMMAND) --build-dirs | ||
|
|
||
| fail-warning: venv | ||
| $(RENDER_COMMAND) --fail-on-warning | ||
|
|
||
| check-links: venv | ||
| $(RENDER_COMMAND) --check-links | ||
|
|
||
| rss: venv | ||
| $(VENVDIR)/bin/python3 generate_rss.py | ||
|
|
||
| clean: clean-venv | ||
| -rm -rf build | ||
|
|
||
| clean-venv: | ||
| rm -rf $(VENVDIR) | ||
|
|
||
| venv: | ||
| @if [ -d $(VENVDIR) ] ; then \ | ||
| echo "venv already exists."; \ | ||
| echo "To recreate it, remove it first with \`make clean-venv'."; \ | ||
| else \ | ||
| $(PYTHON) -m venv $(VENVDIR); \ | ||
| $(VENVDIR)/bin/python3 -m pip install -r requirements.txt; \ | ||
| echo "The venv has been created in the $(VENVDIR) directory"; \ | ||
| fi | ||
|
Comment on lines
+29
to
+37
Member
There was a problem hiding this comment. This sort of goes against the point of I really don't want to overcomplicate this -- whilst I have a desire to make usability better for PEP authors, no-one complained up until now, and so we should balance usability to PEP authors for whom the current Makefile doesn't work and maintainability to ourselves. A
Member
Author
There was a problem hiding this comment. Yep, This one is based on the CPython docs venv:
@if [ -d $(VENVDIR) ] ; then \
echo "venv already exists."; \
echo "To recreate it, remove it first with \`make clean-venv'."; \
else \
$(PYTHON) -m venv $(VENVDIR); \
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools; \
$(VENVDIR)/bin/python3 -m pip install -r requirements.txt; \
echo "The venv has been created in the $(VENVDIR) directory"; \
fiThe devguide's venv:
$(PYTHON) -m venv venv
./venv/bin/python3 -m pip install --upgrade pip
./venv/bin/python3 -m pip install -r requirements.txtI'm sure I've seen similar in other https://github.com/python
Member
There was a problem hiding this comment. I'm not a make expert, but as a general principle, I don't think we should let purity override practicality here, particularly when it comes to usability for PEP authors and contributors. We certainly want to reduce friction there as much as practical, and given all the changes lately and the remaining ones we want to do, making things easier rather than harder for users helps all that go more smoothly for everyone. |
||
|
|
||
| lint: venv | ||
| $(VENVDIR)/bin/python3 -m pre_commit --version > /dev/null || $(VENVDIR)/bin/python3 -m pip install pre-commit | ||
| $(VENVDIR)/bin/python3 -m pre_commit run --all-files | ||
|
|
||
| spellcheck: venv | ||
| $(VENVDIR)/bin/python3 -m pre_commit --version > /dev/null || $(VENVDIR)/bin/python3 -m pip install pre-commit | ||
| $(VENVDIR)/bin/python3 -m pre_commit run --all-files --hook-stage manual codespell | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If one installs
makeon windows, this would fail, right? As the executables directory isScripts.A
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't use
makeon Windows, I've often seen a separatemake.batthough so I think that is used instead ofMakefile.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AA-Turner correct, this is Unix-only. The
PYTHONvariable could be updated to useVENVDIR, but that would also allow for overriding the path to the Python executable.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do have
makeon my Windows dev machines and use it when necessary sometimes, but at least on this repo I don't really do so, and instead run the various commands I need directly (usually with custom invocations). I wouldn't expect very many if any non-WSL Windows users to do so either.