Skip to content
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

Makefile updates #5159

Merged
merged 10 commits into from
Jan 1, 2021
Merged

Makefile updates #5159

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e126001
Help as default goal
wiredfool Dec 30, 2020
dae30d8
Removed co target -- Artifact of previous code review process
wiredfool Dec 30, 2020
85649e2
Makefile: Lint target
wiredfool Dec 30, 2020
4ba769f
documentation
wiredfool Dec 31, 2020
35c396c
the other pip invocation
wiredfool Dec 31, 2020
31b6e80
lint-fix target, currently including black
wiredfool Dec 31, 2020
78a0514
Added isort to lint-fix
radarhere Jan 1, 2021
4f28ed3
Changed tabs to spaces for consistency
radarhere Jan 1, 2021
a955e97
Merge pull request #5 from radarhere/makefile_updates
wiredfool Jan 1, 2021
6f3670d
Updated description
radarhere Jan 1, 2021
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
15 changes: 7 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.DEFAULT_GOAL := release-test
.DEFAULT_GOAL := help

.PHONY: clean
clean:
Expand All @@ -7,13 +7,6 @@ clean:
rm -r build || true
find . -name __pycache__ | xargs rm -r || true

BRANCHES=`git branch -a | grep -v HEAD | grep -v master | grep remote`
.PHONY: co
co:
-for i in $(BRANCHES) ; do \
git checkout -t $$i ; \
done

.PHONY: coverage
coverage:
pytest -qq
Expand Down Expand Up @@ -109,3 +102,9 @@ test:
.PHONY: readme
readme:
python3 setup.py --long-description | markdown2 > .long-description.html && open .long-description.html


.PHONY: lint
lint:
tox --help > /dev/null || pip install tox
Copy link
Member

Choose a reason for hiding this comment

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

We use pip like this elsewhere in the Makefile:

Suggested change
tox --help > /dev/null || pip install tox
tox --help > /dev/null || python3 -m pip install tox

Let's also put the make commands in roughly alphabetical order to make them easier to find, and add a help entry for lint:

$ make help
Welcome to Pillow development. Please use `make <target>` where <target> is one of
  clean              remove build products
  coverage           run coverage test (in progress)
  doc                make html docs
  docserve           run an http server on the docs directory
  html               to make standalone HTML files
  inplace            make inplace extension
  install            make and install
  install-coverage   make and install with C coverage
  install-req        install documentation and test dependencies
  install-venv       install in virtualenv
  release-test       run code and package tests before release
  test               run tests on installed pillow
  upload             build and upload sdists to PyPI
  upload-test        build and upload sdists to test.pythonpackages.com

Copy link
Member Author

Choose a reason for hiding this comment

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

install-venv:
        virtualenv .
        bin/pip install -r requirements.txt

It's 1:1 for python3 -m pip install vs pip install, though to be fair, I think this is an artifact of the original usage, and I'd argue against both this and the inplace target on a general objection to mucking up the source tree. (though, I do understand that it's potentially used for some coverage or automated thing. )

Do we have a handle on what people are actually using from this makefile?

Copy link
Member

Choose a reason for hiding this comment

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

Other than the release checklist commands (release-test, sdist) I mainly only use doc and clean.

Copy link
Member

Choose a reason for hiding this comment

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

https://snarky.ca/why-you-should-use-python-m-pip/ is the reason for python3 -m pip, mostly important for the docs as we often get bug reports caused by installing for a different interpreter.

Similarly, I have earlier had problems with python in by the Makefile pointing to Python 2, not 3.

Copy link
Member Author

Choose a reason for hiding this comment

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

Also, I'm not a fan of sorting the rules alphabetically, I'd rather group them by purpose.

(especially as there are some new ones coming in that are 1 public, and several dependent ones)

tox -e lint