Repository navigation
Autoformat on save ignores custom style file #730
Description
Environment data
VS Code version: 1.20
Python Extension version: 2018.1.0
Python Version: 3.6
OS and version: MacOS Sierra 0.12.6
Actual behavior
First file save with python code formats it to default yapf style. Second save format code to intended, custom style specified in .style.yapf.
To fix this issue added custom argument to workspace settings:
"python.formatting.yapfArgs": [
"--style=.style.yapf"
]
After that yapf on save works as intended
Expected behavior
After changes in code and saving file, yapf should format code to style described in .style.yapf
Steps to reproduce:
- open project
- install and enable yapf
- enable format on save
- create
.style.yapffile with custom settings (SPLIT_BEFORE_FIRST_ARGUMENT = true) - add changes to any .py file
- save
- now file is formatted with default style
- add changes to same file
- save
- now file is formatted with custom style
Activity
DonJayamanne commentedon Feb 8, 2018
Please try using the following format:
patrys commentedon Feb 8, 2018
I've faced a similar problem today where "Sort dependencies" would sometimes ignore the local
isortconfiguration. Could it be that the working directory is sometimes incorrect when invoking external tools?patrys commentedon Feb 8, 2018
Don Jayamanne (@DonJayamanne) The problem is not with
yapfArgsas it works correctly with the example provided above, the problem is that without overridingyapfArgsthe tool does not always find the default config file which is in the root of the repository. The same thing happens in myisortexample.(Disclaimer: I work with Krzysztof Wolski (@krzysztofwolski).)
DonJayamanne commentedon Feb 8, 2018
Apologies, for the misunderstanding.
patrys commentedon Feb 13, 2018
I've found a way to reproduce this. It turns out that when you run any of the formatters (
yapf,isortetc.) on an unsaved file, they look for their config files outside of the current workspace directory.MikhailArkhipov commentedon Feb 20, 2018
This is because in unsaved case file is actually saved in temp folder and then formatted so formatter can't access style rules that are next to the actual file.
DonJayamanne commentedon Feb 20, 2018
I think we should look for the file, and then apply it.
We can walk up the folder structure and then use that file when formatting a temporary file.
patrys commentedon Feb 20, 2018
Would it be possible to save the temporary file next to the real one so that things just work without VSCode having to reimplement parts of the tool logic?
MikhailArkhipov commentedon Feb 20, 2018
Yes. There a small risk that if something fails temp file will remain and appear in the workspace (and possibly the git changes). We could try and locate the file too.
#730, #838 (#845)