This repository was archived by the owner on Nov 3, 2023. It is now read-only.
Add a match_path option for comparison against a full path. #529
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
It has been noted in issue PyCQA#363 that match & match_dir are unwieldy when attempting to match against full paths. For unexample if you have A.py in directories B & C and you only want to run pydocstyle on one of them. From my own experience trying to deploy pydocstyle against a large legacy codebase it is unworkable as it would mean the entire codebase being converted as a big bang change. A more nuanced approach means the codebase can be converted gradually. This commit adds a new option, match_path, to the config & command lines which can be used to provide more nuanced matching. For example the following specification: match_path = [AB]/[ab].py D/e.py This defines two regexes. If either match a given path, relative to the directory specified, the file will be yielded for comparison. The is complimentary to match & match_dir and the three can be used together.
2 tasks
| @heoga thank you so much for this PR! Sorry for the late review. Would it be possible for you to rebase this PR against the latest changes in the master branch? |
| Yes, I'll get it updated against the latest changes and see how it looks. |
| Any updates on this PR? It would help me a lot. Can I somehow help? |
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
It has been noted in issue #363 that match & match_dir are
unwieldy when attempting to match against full paths. For
unexample if you have A.py in directories B & C and you only
want to run pydocstyle on one of them.
From my own experience trying to deploy pydocstyle against a
large legacy codebase it is unworkable as it would mean the
entire codebase being converted as a big bang change.
This commit adds a new option, match_path, to the config &
command lines which can be used to provide more nuanced
matching. For example the following specification:
This defines two regexes. If either match a given path,
relative to the directory specified, the file will be yielded
for comparison. The is complimentary to match & match_dir and
the three can be used together.
A test has been added to test_integration to test & illustrate the feature.
tox was run on Linux (Ubuntu under the subsystem for Windows) and all tests were successful.
Fixes #363