Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Colorless, narrower output #15

Closed
JulienPalard opened this issue Dec 12, 2019 · 6 comments
Closed

Colorless, narrower output #15

JulienPalard opened this issue Dec 12, 2019 · 6 comments

Comments

@JulienPalard
Copy link
Contributor

JulienPalard commented Dec 12, 2019

Logs are hard to read:

Screenshot_2019-12-12 Build #3646 - python python-docs-fr - Travis CI

I think they should be narrower and maybe with less colors, at least no background color. why not sticking to gcc-style errors, as an example:

2019-12-12 21:27:53,569 [ERROR   ]            pofile.py(153):display_warnings     :: distutils/apiref.po: 618 [     NBSP     ] There should be a non-breakable space before ":": between ###ralement exactement un symbole ### and ###: « init + nom_de_l'extension »###
2019-12-12 21:27:54,937 [WARNING ]            pofile.py(156):display_warnings     :: faq/library.po: 938 [ Grammalecte  ] Unknown word "CGI" in ###mment reproduire un envoi de formulaire CGI (« METHOD###
2019-12-12 21:27:58,011 [WARNING ]            pofile.py(156):display_warnings     :: faq/programming.po:  72 [ Double space ] Double spaces detected between ###s développés sans *PythonWin*.### and ###*PythonWin* est disponible dan###
2019-12-12 21:27:58,026 [WARNING ]            pofile.py(156):display_warnings     :: faq/programming.po:1979 [ Grammalecte  ] Pour le “t” euphonique, il faut deux traits d’union. Pas d’apostrophe. Pas d’espace. => ###Pourquoi « a_tuple[i] += ['item'] » lève-t'il une exc###
2019-12-12 21:27:58,812 [WARNING ]            pofile.py(156):display_warnings     :: faq/windows.po: 354 [ Grammalecte  ] Unknown word "DLL" in ###avez « pas » besoin de créer un fichier DLL, et cela ###

Could be more readable as:

distutils/apiref.po:618: error: There should be a non-breakable space before ":": between ###ralement exactement un symbole ### and ###: « init + nom_de_l'extension »###
faq/library.po:938: warning: Unknown word "CGI" in ###mment reproduire un envoi de formulaire CGI (« METHOD###
faq/programming.po:72: warning: Double spaces detected between ###s développés sans *PythonWin*.### and ###*PythonWin* est disponible dan###
faq/programming.po:1979: warning: Pour le “t” euphonique, il faut deux traits d’union. Pas d’apostrophe. Pas d’espace. => ###Pourquoi « a_tuple[i] += ['item'] » lève-t'il une exc###
faq/windows.po:354: warning: Unknown word "DLL" in ###avez « pas » besoin de créer un fichier DLL, et cela ###

Note that in github the wide version is so wide we have literally no relevant information in the screen :(

Bonus: By sticking to gcc error format we could easily use padpo in vim/emacs :]

@vpoulailleau
Copy link
Member

Bonus: By sticking to gcc error format we could easily use padpo in vim/emacs :]

You convinced me! 😉

I think that I'll add a CLI flag to enable this, because the color allows to see rapidly the errors (skipping the warnings first). So I prefer to also keep this functionality.

@JulienPalard
Copy link
Contributor Author

I think that I'll add a CLI flag to enable this, because the color allows to see rapidly the errors (skipping the warnings first). So I prefer to also keep this functionality.

I'd say do as most CLI programs: a --color flag to opt-in, not a --no-color flag to opt out, but I'm not sure to be able to convince you twice on this one :]]

Also while I'm at it, I feel that foreground color is more readable than background color, at least on my color scheme, but I'm not sure to be able to convince you three times on this one :]]]

Also while I'm at it, I'd color only the "warning" / "error" string not the whole string, but I'm not sure to be able to convice you 4 times on this one :]]]]

@Seluj78
Copy link
Contributor

Seluj78 commented Dec 13, 2019

I agree with Julien,
I'd prefer to color the text instead of the background. As for what to color, idc

@vpoulailleau
Copy link
Member

@JulienPalard @Seluj78 For the readability issues, I'm using the default colors of http://github.com/vpoulailleau/simplelogging but changing those coloring choices is on my pretty old TODO list 😉

You almost made a strike there, at least a spare! The last point for which I'm not totally convinced yet is opt-in/opt-out for color. But I don't have the time to code right now, we'll see the decision later 😉 But "I'd say do as most CLI programs" is quite a valid argument 😛

@Seluj78
Copy link
Contributor

Seluj78 commented Dec 16, 2019

I prefer the opt out for colors even if it isnt standard

@deronnax
Copy link

deronnax commented Mar 30, 2020

+1 : general background color makes it unreadable. An outpout like grep would perfect (normal, with important parts in red)
Also the sharps as delimiters are not a good idea :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants