Add option to print machine readable output to stdout #39

vortec · 2014-02-05T14:56:46Z

When you run bumpversion --verbose, its output gets sent to stderr. This prevents a user to pipe the output into Linux commands like grep without having to redirect stderr to stdout. I don't see a reason why the verbose output should be treated as an error, therefore I'm issuing this pull request.

Furthermore this commit uses False instead of 0 as default value for --verbose, because it's a boolean value and all other options use it too.

…0 as default value.

peritus · 2014-02-05T16:02:43Z

I think bumpversion behaves like other unix tools out there in this respect.

Compare curl -v with muted stdout:

curl -v https://github.com/peritus/bumpversion/pull/39 > /dev/null 2>&1 | head
* Adding handle: conn: 0x7f9e33003a00
* Adding handle: send: 0
* Adding handle: recv: 0
* Curl_addHandleToPipeline: length: 1
* - Conn 0 (0x7f9e33003a00) send_pipe: 1, recv_pipe: 0
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0* About to connect() to github.com port 443 (#0)
*   Trying 192.30.252.131...
* Connected to github.com (192.30.252.131) port 443 (#0)

and with muted stderr:

curl -v https://github.com/peritus/bumpversion/pull/39 2> /dev/null | head





<!DOCTYPE html>
<html>
  <head prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb# object: http://ogp.me/ns/object# article: http://ogp.me/ns/article# profile: http://ogp.me/ns/profile#">
    <meta charset='utf-8'>
    <meta http-equiv="X-UA-Compatible" content="IE=edge">

I don't consider verbose logging an error, merely "human readable useful information besides the main output" and that should go to "the other channel that is not stdout" (that is stderr in this case).

What are you trying to accomplish ? I certainly want bumpversion to be unixy the way that it prints useful information for other programs to consume, I'm interested in your usecase.

peritus · 2014-02-05T16:05:18Z

Also I want bumpversion to support multiple verbosity levels in the future, so that's why it's a count.
At the moment there's only one level because I couldn't decide yet.

vortec · 2014-02-05T16:38:51Z

Hi Filip, thanks for the quick response.

My usecase is indeed a wrapper script that takes a generated version number from bumpversion (using -n --verbose) and checks if the version exists as a tag on a git remote. If it doesn't exist, it calls bumpversion again to let it actually change files and commit the changes. Actually It does a little more than that, but this is my basic requirement.

Under the current implementation I need to redirect the output of the --verbose call to stdout and then use grep+cut or sed to get the generated version number. To improve that solution, I was actually about to submit another pull request which added a new option, --short-output or something similar, which would, combined with -n, just print a.b.c -> x.y.z to stdout. For me, parsing that would be much easier (| cut -d " " -f 3) than a multiline string in stderr.

Apart from that, bumpversion is a really nice tool which has been working perfectly so far.

peritus · 2014-02-05T16:50:47Z

Yes, let's print machine readable information to stdout (also, maybe with something that would be somehow stable).

Maybe similar to what git config -l does ?

Should be another loglevel in the Python logging sense, but independent from --verbose IMO.

vortec · 2014-02-05T17:14:56Z

The output format of git config -l is indeed easy to parse. Shall we open an issue to discuss this further? It seems that my pull request is obsolete and can be closed.

peritus · 2014-02-05T17:28:57Z

Please leave this open as a reminder, feel free to change the attached code on this PR or open another PR if you feel like it.

git config -l was only one idea from the top of my head, maybe there is another format that makes more sense.

Happy coding ;)

vortec · 2014-02-06T11:37:40Z

I suggest implementing a -mor --machine-readableoption:

$ bumpversion -m patch
current_version=1.2.3
new_version=1.2.4
files=setup.py version.txt

This is the minimum it should output. I'm not sure about stuffing all options in it aswell, because that would bloat things up and unless you've overwritten options in .bumpversion.cfg, you have to pass them to the bumpversion command anyway.

…all bumpversion in devel mode

vortec · 2014-02-17T19:51:31Z

I think 4546e37 should be a good starting point to add more information. I had some issues with the argument parsers so please review my changes and let me know if it's ok.

h/t #39

peritus · 2014-03-02T11:11:04Z

@vortec I took your code and improved it a bit, please let me know if 8b998c4 fits your use case. If there are no objections, this is the last commit that needs to get in v0.4.1 which I'd like to release soon.

vortec · 2014-03-02T11:38:37Z

Perfect!

Two things I've noticed:

The -n option seems to be broken, --dry-run works.
Github doesn't render the newline in the README.rst example.

Apart from that, I have no objections. Thanks!

h/t #39

peritus · 2014-03-04T16:59:28Z

released in v0.4.1

Send output of --verbose to stdout, not stderr. Use False instead of …

14ada7e

…0 as default value.

peritus added the v0.4.1 label Feb 10, 2014

vortec added 3 commits February 15, 2014 13:51

fix 'python setup.py develop' in vboxsf, enable vagrant users to inst…

9c57aed

…all bumpversion in devel mode

add --machine-readable to options

4546e37

Merge branch 'master' of ssh://github.com/vortec/bumpversion

99b4d59

peritus added a commit that referenced this pull request Mar 2, 2014

--list prints machine readable information

8b998c4

h/t #39

peritus added a commit that referenced this pull request Mar 4, 2014

--list prints machine readable information

f7ce7f3

h/t #39

peritus closed this Mar 4, 2014

peritus mentioned this pull request Jun 19, 2015

--list-fields option added #96

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to print machine readable output to stdout #39

Add option to print machine readable output to stdout #39

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 6, 2014

vortec commented Feb 17, 2014

peritus commented Mar 2, 2014

vortec commented Mar 2, 2014

peritus commented Mar 4, 2014

Add option to print machine readable output to stdout #39

Add option to print machine readable output to stdout #39

Conversation

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 5, 2014

peritus commented Feb 5, 2014

vortec commented Feb 6, 2014

vortec commented Feb 17, 2014

peritus commented Mar 2, 2014

vortec commented Mar 2, 2014

peritus commented Mar 4, 2014