8000 Lint: call tools inside venv using make's PYTHON by hugovk · Pull Request #2408 · python/peps · GitHub
[go: up one dir, main page]
Skip to content

Lint: call tools inside venv using make's PYTHON #2408

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 3 commits into from
Mar 12, 2022
Merged

Lint: call tools inside venv using make's PYTHON #2408

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b655ad
Lint: call pre-commit as a module using make's PYTHON
hugovk Mar 10, 2022
96b66e7
Call tools inside venv
hugovk Mar 10, 2022
e6b6b0c
Use hidden .venv dir and skip upgrading setuptools
hugovk Mar 10, 2022
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
48 changes: 29 additions & 19 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,46 @@
# Builds PEP files to HTML using sphinx

PYTHON=python3
VENV_DIR=venv
VENVDIR=venv
JOBS=8
RENDER_COMMAND=$(PYTHON) build.py -j $(JOBS)
RENDER_COMMAND=$(VENVDIR)/bin/python3 build.py -j $(JOBS)
Copy link
Member

Choose a reason for hiding this comment

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

If one installs make on windows, this would fail, right? As the executables directory is Scripts.

A

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 don't use make on Windows, I've often seen a separate make.bat though so I think that is used instead of Makefile.

Copy link
Member

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 PYTHON variable could be updated to use VENVDIR, but that would also allow for overriding the path to the Python executable.

Copy link
Member

Choose a reason for hiding this comment

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

I do have make on 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.


render:
render: venv
$(RENDER_COMMAND)

pages: rss
pages: venv rss
$(RENDER_COMMAND) --build-dirs

fail-warning:
fail-warning: venv
$(RENDER_COMMAND) --fail-on-warning

check-links:
check-links: venv
$(RENDER_COMMAND) --check-links

rss:
$(PYTHON) generate_rss.py
rss: venv
$(VENVDIR)/bin/python3 generate_rss.py

clean:
clean: clean-venv
-rm -rf build

venv:
$(PYTHON) -m venv $(VENV_DIR)
./$(VENV_DIR)/bin/python -m pip install -r requirements.txt

lint:
pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
pre-commit run --all-files
clean-venv:
rm -rf $(VENVDIR)

spellcheck:
pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
pre-commit run --all-files --hook-stage manual codespell
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"; \
fi

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
0