meliache
commented
7 months ago I have possible implementations of a docformatter wrapper script and both work interactively but fail the tests. I think I need some help. maybe @raxod502 has some idea?
Implementation 1: Using --in-place
Script:
#!/bin/sh
docformatter --in-place "$@"
if [ "$?" -eq 3 ]; then
exit 0
fiFormatter:
(docformatter . ("apheleia-docformatter" inplace))Error:
error("Formatter %s modified original file in place" "docformatter")In place is exactly what I tried to do here, supposedly apheleia has support for that, but seems it doesn't work for tests.
Implementation 1: Transformind diff to stdout
Script:
#!/bin/sh
output=$(docformatter "$@")
ret=$?
[ $ret -gt 0 ] && [ $ret -ne 3 ] && exit $ret
echo "${output}" | patch --quiet --output=-Formatter:
(docformatter . ("apheleia-docformatter" file))Error:
[Errno 2] No such file or directory: '/tmp/srctestformatterssamplecodedocformatterin.py'When testing interactively after a while I found the call to patch with standard input is very sensitive to from where it's called. It works when it's called in the same directory as the in.py but when it's in another directory it doesn't work except with a correct --strip argument. Not sure if this is what causes this weird error message.
raxod502
Add docformatter for Python docstrings.
By default it outputs diffs but changes in-place with
--in-place. On successful change it exits with an error code of3(found out by trial), so I had to add a formatter wrapping-script.Initially I used
--in-placewith the specialin-placesymbol in apheleia. But now I tried an approach where I transform the diff into usable stdout usingpatchinstead.Related to #266 , where I had used the example of docformatter to ask how to add scripts with positive exit codes and @raxod502 showed me the
phpcssolution.