Add pre-commit hook for pip-compile #976

atugushev · 2019-10-30T15:31:57Z

Resolves #974.
Refs #882.

Changelog-friendly one-liner: Add pre-commit hook for pip-compile.

Contributor checklist

~~Provided the tests for the changes.~~
Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

asottile · 2019-10-30T15:34:45Z

.pre-commit-hooks.yaml

+  description: Automatically compile requirements.
+  entry: pip-compile
+  language: python
+  files: (requirements\.in|setup\.py)$


I'd suggest pyproject.toml and setup.cfg as well for completeness

and probably some docs on how to use this / when you might want to use this

I'd suggest pyproject.toml and setup.cfg as well for completeness

Thanks for noticing! I've missed that out. :(

and probably some docs on how to use this / when you might want to use this

Could be enough something like https://github.com/asottile/flake8-walrus#as-a-pre-commit-hook?

yep! that one's a little less standard, here's the copy I usually use: https://github.com/asottile/add-trailing-comma/#as-a-pre-commit-hook

May we borrow it? :)

sure! you may want to suggest stages: [pre-push] as well as pre-commit install --hook-type pre-push as well

up to you, not my project :D

Addressed in 1bff1e9 and e33f07d.

I've tried this hook as a user on my repositories and it looks pass_filenames: false (and probably files too) needs to be removed. Otherwise, pre-commit will run something like:

$ pip-compile setup.py setup.cfg

which is totally wrong, since setup.cfg is not a requirement file.

I'd let users configure files and args manually for their special case.

if there's no good default, it might make sense to set files: ^$ + pass_filenames: false and document that the consumer must configure args: [requirements.in] + files: ^(...)$ (for example)

Addressed in 5f2dea3

Add pyproject.toml and setup.cfg as well for completeness. Co-Authored-By: Anthony Sottile <asottile@umich.edu>

Add a basic doc on how to use pip-compile as pre-commit hook. Co-Authored-By: Anthony Sottile <asottile@umich.edu>

codecov · 2019-10-30T17:46:17Z

Codecov Report

Merging #976 into master will increase coverage by 0.16%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #976      +/-   ##
==========================================
+ Coverage   99.26%   99.42%   +0.16%     
==========================================
  Files          34       34              
  Lines        2446     2443       -3     
  Branches      306      302       -4     
==========================================
+ Hits         2428     2429       +1     
+ Misses         10        8       -2     
+ Partials        8        6       -2

Impacted Files	Coverage Δ
piptools/sync.py	`100.00% <0.00%> (ø)`
piptools/utils.py	`100.00% <0.00%> (ø)`
tests/conftest.py	`100.00% <0.00%> (ø)`
tests/test_sync.py	`100.00% <0.00%> (ø)`
tests/test_cache.py	`100.00% <0.00%> (ø)`
tests/test_utils.py	`100.00% <0.00%> (ø)`
piptools/resolver.py	`100.00% <0.00%> (ø)`
tests/test_writer.py	`100.00% <0.00%> (ø)`
piptools/locations.py	`100.00% <0.00%> (ø)`
tests/test_cli_sync.py	`100.00% <0.00%> (ø)`
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d405bf9...ae121d1. Read the comment docs.

dirn · 2020-02-11T05:03:02Z

@atugushev does the hook fail for you? I tried using it but, while I successfully get a new requirements.txt file, the pre-commit shows the hook as passing.

atugushev · 2020-02-11T05:11:28Z

@dirn

does the hook fail for you? I tried using it but, while I successfully get a new requirements.txt file, the pre-commit shows the hook as passing.

I've updated the hook. Could you try it?

dirn · 2020-02-11T05:43:25Z

I think I understand my problem a bit better now. The hook passes if requirements.txt doesn't already exist. Once it does, the hook correctly fails. I'm not sure there's much pip-compile can do about that.

atugushev · 2020-02-11T06:03:15Z

@dirn Yeah, this works if requirements.in and requirements.txt are in VCS.

- don't pass filenames since it would break CLI - update files filter

sfdye · 2020-03-18T15:33:27Z

I tried in my project with the this

config

repos:
  - repo: https://github.com/atugushev/pip-tools
    rev: pre-commit-hook
    hooks:
      - id: pip-compile

$ pre-commit run
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to /Users/xxx/.cache/pre-commit/patchxxx.
pip-compile..............................................................Passed
[INFO] Restored changes from /Users/lwan/.cache/pre-commit/patchxxx.

It worked from a pip-compile perspective, but unable to detect any files other than requirements.(in|txt). (e.g. requirements/main.txt)

It will be nice to support any requirement file in any location.

atugushev · 2020-03-18T15:58:07Z

@sfdye

Thank you for checking this out. Default pre-commit config handles only default values. If you have other than default values, you should configure args and files correspondingly. For example:

repos:
  - repo: https://github.com/atugushev/pip-tools
    rev: pre-commit-hook
    hooks:
      - id: pip-compile
        files: ^requirements/main\.(in|txt)$
        args: [requirements/main.in]

sfdye

🚢

atugushev · 2020-03-18T16:06:25Z

@sfdye

Since you've had an issue with this, it seems I should definitely address this #976 (comment).

sfdye · 2020-03-18T16:08:56Z

Yes, please. Would love to see this merged😁

Note about configuring `args` and `files`.

atugushev · 2020-03-18T16:23:41Z

@sfdye

Great! Please, review the latest changes if you get a chance.

README.rst

atugushev · 2020-03-19T05:22:20Z

@sfdye thanks for reviewing this! 🙏

How that jazzband/pip-tools#976 has been merged and released, we can switch to version of the [pip-tools][pip-tools] [pre-commit][pre-commit] hook provided by [Jazzband][jazzband]. [jazzband]: https://github.com/jazzband [pip-tools]: https://pypi.org/p/pip-tools [pre-commit]: https://pre-commit.com

Add pip-compile pre-commit hook

7f21433

atugushev mentioned this pull request Oct 30, 2019

pre-commit hook for pip-compile #974

Closed

asottile reviewed Oct 30, 2019

View reviewed changes

atugushev added the enhancement Improvements to functionality label Oct 30, 2019

atugushev and others added 2 commits October 30, 2019 22:59

Address review comments

1bff1e9

Add pyproject.toml and setup.cfg as well for completeness. Co-Authored-By: Anthony Sottile <asottile@umich.edu>

Address review comments

e33f07d

Add a basic doc on how to use pip-compile as pre-commit hook. Co-Authored-By: Anthony Sottile <asottile@umich.edu>

Merge branch 'master' into pre-commit-hook

659fbdc

Update pre-commit hook [skip ci]

14f4593

- don't pass filenames since it would break CLI - update files filter

atugushev force-pushed the pre-commit-hook branch from 848aad8 to 14f4593 Compare February 11, 2020 06:06

sfdye approved these changes Mar 18, 2020

View reviewed changes

atugushev added 2 commits March 18, 2020 23:17

Address review comments

5f2dea3

Note about configuring `args` and `files`.

Update upcoming revision for .pre-commit-config.yaml example in README

da2b46a

Add syntax highlighting to yaml code blocks

ae121d1

atugushev added this to the 5.0.0 milestone Mar 18, 2020

sfdye reviewed Mar 18, 2020

View reviewed changes

README.rst Show resolved Hide resolved

atugushev merged commit f4a4f7b into jazzband:master Mar 19, 2020

atugushev deleted the pre-commit-hook branch March 19, 2020 05:22

dirn mentioned this pull request May 6, 2020

Switch to Jazzband's pip-tools pre-commit hook PyGotham/awards-2020#33

Merged

Berk-Tosun mentioned this pull request Jun 22, 2023

pre-commit hook for pip-sync #1889

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pre-commit hook for pip-compile #976

Add pre-commit hook for pip-compile #976

atugushev commented Oct 30, 2019 •

edited

Loading

asottile Oct 30, 2019

atugushev Oct 30, 2019

asottile Oct 30, 2019

atugushev Oct 30, 2019 •

edited

Loading

asottile Oct 30, 2019

asottile Oct 30, 2019

atugushev Oct 30, 2019

atugushev Nov 4, 2019 •

edited

Loading

asottile Nov 4, 2019

atugushev Mar 18, 2020

codecov bot commented Oct 30, 2019 •

edited

Loading

dirn commented Feb 11, 2020

atugushev commented Feb 11, 2020 •

edited

Loading

dirn commented Feb 11, 2020

atugushev commented Feb 11, 2020

sfdye commented Mar 18, 2020 •

edited

Loading

atugushev commented Mar 18, 2020

sfdye left a comment

atugushev commented Mar 18, 2020

sfdye commented Mar 18, 2020

atugushev commented Mar 18, 2020 •

edited

Loading

atugushev commented Mar 19, 2020

Add pre-commit hook for pip-compile #976

Add pre-commit hook for pip-compile #976

Conversation

atugushev commented Oct 30, 2019 • edited Loading

Contributor checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atugushev Oct 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atugushev Nov 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 30, 2019 • edited Loading

Codecov Report

dirn commented Feb 11, 2020

atugushev commented Feb 11, 2020 • edited Loading

dirn commented Feb 11, 2020

atugushev commented Feb 11, 2020

sfdye commented Mar 18, 2020 • edited Loading

atugushev commented Mar 18, 2020

sfdye left a comment

Choose a reason for hiding this comment

atugushev commented Mar 18, 2020

sfdye commented Mar 18, 2020

atugushev commented Mar 18, 2020 • edited Loading

atugushev commented Mar 19, 2020

atugushev commented Oct 30, 2019 •

edited

Loading

atugushev Oct 30, 2019 •

edited

Loading

atugushev Nov 4, 2019 •

edited

Loading

codecov bot commented Oct 30, 2019 •

edited

Loading

atugushev commented Feb 11, 2020 •

edited

Loading

sfdye commented Mar 18, 2020 •

edited

Loading

atugushev commented Mar 18, 2020 •

edited

Loading