Fixes file types from .pre-commit-config.yaml issue
#744
Conversation
Adds a test for python and bash `types` using identify per interpreter interpretation. The python test succeeds with a false positive. The bash test identifies the bug, where a comparison happens between `tags >= types`. Tags is the tag list from identify, types is the value passed in from configuration file as `acceptable types`. The `tags(List) >= types(FrozenSet)` does a sort comparison of the two sequences as evidenced by this code sample (which should return True): ``` >>> types = frozenset(['a']) >>> tags = ['bash'] >>> tags >= types True ``` Note: In 2.7, I cannot get this to return anything other than True. Including the empty case: ``` >>> [] > frozenset() True ``` Which means to me that a list is always >= a frozenset in Python 2.7. In Python 3.5, I see errors when comparing a List to a FrozenSet. So thankfully the interpreter is stricter in this case. ``` >>> [] >= frozenset() TypeError: unorderable types: list() >= frozenset() ```
Fixes a bug where files are not being recognized based on their `types` using configuration file. In the case of using `types: ['bash', 'sh', 'shell']` in pre-commit-config, those filetypes will not be found, resulting in "no files found" being reported with pre-commit. This persists even when using --all-files flag. Intersection produces predictable results in Python 2.7 and 3.x.
|
@asottile Please let me know if you think this is my PR breaking the tests. I was unable to get them passing locally even before making changes. |
|
First off, thanks for the issue and PR! Turns out the current behaviour is intentional ( At least for your case, |
|
@asottile Interesting. I misread the docs then about the So if I want to do |
馃憢 Thanks for making pre-commit available :). It's quite handy!
This PR fixes a bug where files are not being recognized based on their
typesusing configuration file settingtypes.Technical writeup of findings: Commit message for 29d66f4
Issue / Reproduction case
When using a pre-commit-config.yaml in a repository with many bash scripts (that lack a
.shsuffix to filename):And running:
Actual output:
Expected behavior
That pre-commit finds the files with a shebang of
#!/usr/bin/env bashand lints them.Solution
I added two test cases, one for Python (which did behave properly) and one for a bash script like:
Filename:
bash_scriptThen I tracked down the issue to the comparison between a List and a FrozenSet here:
I rewrote that comparison to compare two FrozenSets using the
intersectionfunction. This produces predictable results on Python 2.7 and 3.5.Once this is approved, I'll happily squash it down to a single commit. Right now it's 2 commits to show the spec failing before the patch.
Notes:
get_tagsfunction via dependency injection to simplify testing. If you prefer a different mechanism, feel free to adjust the PR to suit your testing preferences.