Fix false symlink detection claims in verbose output#3385
Conversation
When trying to format a project from the outside, the verbose output shows says that there are symbolic links that points outside of the project, but displays the wrong project path, meaning that these messages are false positives. This bug is triggered when the command is executed from outside a project on a folder inside it, causing an inconsistency between the path to the detected project root and the relative path to the target contents. The fix is to normalize the target path using the project root before processing the sources, which removes the presence of the incorrect messages. Signed-off-by: Antonio Ossa Guerra <aaossa@uc.cl>
|
Seems like something is going on in Python 3.7 with the use of EDIT: Seems like this is it: # 3.7
>>> m = MagicMock(return_value=None)
>>> m(1, 2, 3, arg='one', arg2='two')
>>> kall = m.call_args
>>> args, kwargs = kall
>>> args
(1, 2, 3)
# 3.10
>>> m = MagicMock(return_value=None)
>>> m(1, 2, 3, arg='one', arg2='two')
>>> kall = m.call_args
>>> kall.args
(1, 2, 3) |
The test attemps to emulate the behavior of the CLI as closely as posible by patching some `pathlib.Path` methods and passing certain reference paths to the context object and `black.get_sources`. Before the associated fix was introduced, this test failed because some of the captured files reported the presence of a symlink due to an incorrectly formated path. The test also asserts that only a single file is reported as ignored, which is part of the expected behavior. Signed-off-by: Antonio Ossa Guerra <aaossa@uc.cl>
Add entry about fixing bug that cause false symlink detection messaged in verbose output. Signed-off-by: Antonio Ossa Guerra <aaossa@uc.cl>
|
Hi, any updates on this? |
ichard26
left a comment
ichard26
left a comment
There was a problem hiding this comment.
This looks good. I'm so sorry for dropping the ball on this!
We should fix and overhaul the file collection and discovery tests, it's not great that it's not testing typical usage. Could you open an issue? It's okay if you don't want to.
Thank you very much!
No worries. About the file collection and discovery tests, I'll explore the code a bit first and open an issue this week. I think I red about a related problem it in a comment on another issue, but I'm not sure if its the same problem. I'll look for it and properly report these concerns |
|
That would be great. Thank you! 🖤 |
3 participants
Description
Closes #3384
When trying to format a project from the outside, the verbose output shows says that there are symbolic links that points outside of the project, but displays the wrong project path. This behavior seem to be triggered when the command is executed from outside a project on a folder, causing an inconsistency between the path to the detected project root and the relative path to the target contents. The fix is to normalize the target path using the project root before processing the sources.
Checklist - did you ...
CHANGES.mdif necessary?