Pretty Terminal Output #2787

Shivansh-007 · 2022-01-20T11:58:30Z

This introduces a style helper for styling your logs to get a bit pretty output in the terminal.

It adds an OutputLevels enum which can be used to define the level of the message "log" you are outputting. You can still use the old manual styles by passing fg, bold, dim, etc. individually to the function black.output.out(), but if they are specified alongside with style= kwarg (which specifies the OutputLevels) the manual styles would over-write the style specified by the style= kwarg. An example use case is:

out(
	error_msg if report.return_code else "All done! ✨ 🍰 ✨",
	style=OutputLevels.success,
	bold=False,
)
# The final style would be {"fg": "green", "bold": False} 
# (as we are overwriting it by manually passing `bold=False`

The current terminal output looks like this:

This PR needs discussion regarding the colour styling, currently, I just picked up what I think would be okay for the level.

Checklist - did you ...

Add a CHANGELOG entry if necessary?
Add / update tests if necessary?
Add new / update outdated documentation? -> n/a

This enum can be used with `black.out.output()` to create pretty output logs, backward compatibility is ensured and if both, manual styles and `style=` kwarg is passed, the manually passed styles would overwrite the styles of the `style=`.

… logs

github-actions · 2022-01-20T12:15:16Z

diff-shades reports zero changes comparing this PR (70c77ee) to main (4ea75cd).

What is this? | Workflow run | diff-shades documentation

felix-hilden

All in all, I like the change especially for the easy access to predefined styles. Some comments below.

felix-hilden · 2022-01-20T12:01:02Z

src/black/const.py

+
+
+class OutputLevels(Enum):
+    null: Any = dict()


As discussed, I prefer literals. This way the flake8 config doesn't have to change as well. I'll include it here as well so that others may comment.

Also none could be a more pythonic name.

None would be more pythonic agreed, but I would need to add some additional logic to _out function, I wanted to keep it simple hence using am using an empty dict here.

Regarding the dict literals, I am using function calls here as I found them more readable compared to literals.

I meant none: dict = {}!

We should either use dict literals here or decide that we globally don't care for this flake8 setting and disable it.

I meant none: dict = {}!

Ah, that would work 👍🏻 (the name, mypy complains about : dict as it needs the parameters)

The Flake8 rule is definitely useful. So maybe we'll sacrifice a bit of readability and use literals here.

I am not sure, either way is fine. We could even safely ignore the rule since very few people use functional calls over literals for normal use cases (which can be caught in reviews), otherwise, they are only used for some specific reasons like readability/explicitness (this case).

src/black/output.py

felix-hilden · 2022-01-20T12:03:47Z

src/black/output.py

+    **_styles: Any,
+) -> None:
+    styles = style.value.copy()
+    if style:


To me this is redundant because .update with an empty dict does nothing. Also discussed before.

Yeah, but I wanted to keep the .update() change explicit hence keeping it in an if block.

This seems wrong, doesn't it mean we ignore _styles if style == LogLevel.none?

Also, the variable names style, styles, and _styles here are pretty confusing.

Ah yeah, I forgot to make that change.

Umm, can't think of a better name for _styles, these are the "styles" which the user explicitly passes as kwargs to overwrite the style defined by the LogLevel.

I'd suggest style_overrides.

src/black/output.py

felix-hilden · 2022-01-20T12:07:49Z

src/black/report.py

@@ -55,7 +62,7 @@ def failed(self, src: Path, message: str) -> None:

    def path_ignored(self, path: Path, message: str) -> None:
        if self.verbose:
-            out(f"{path} ignored: {message}", bold=False)
+            out(f"{path} ignored: {message}", style=OutputLevels.warning)


I feel like this should be some other level, like info.

I wanted to highlight them, I could use dim yellow though, by changing to OutputLevels.info and fg="yellow".

Any particular reason as to why you'd want to highlight them? Don't get me wrong, it could be nice. But this is why we define the styles right? 😄

I just wanted them to be easily recognizable from the crowd of "wasn't modified logs".

src/black/const.py

Shivansh-007 · 2022-01-20T13:02:48Z

I don't think a skip news label is needed, I just haven't added the changelog yet. This change will be affecting the user side of the project, so a changelog would be good 👍🏻

Co-authored-by: felix-hilden <felix.hilden@gmail.com>

When we do `from black.output import out`, we get a object `out` pointing to function `black.output.out` function. But now when we _assign_ a new function to it via mock patching on `black.output.out`, the `out` object we had earlier still points to `black.output.out` (the old function, before patching). This is why when you are patching `black.output.out`, it wouldn"t be patched correctly, resulting in these errors. Nedbat has got a better explaination at https://nedbatchelder.com/blog/201908/why_your_mock_doesnt_work.html, in case this was a bouncer to you.

felix-hilden

Looking better, but let's address all the comments!

src/black/const.py

…into pretty-output

JelleZijlstra · 2022-01-22T05:17:01Z

Here's how it looks in my terminal (top is this PR, bottom is current main).

Feedback:

We need to worry about making this readable for everyone, which is hard because there are so many different configurations. In your screenshot the "wasn't modified" lines are kind of hard to read.
The stuff at the top in blue is easier to read on current main where it's bolded.
I like the color difference between the ignored and well-formatted lines on your branch.

Shivansh-007 · 2022-01-22T05:20:13Z

That's a lot of bright green 👀 Anyways, regarding your second point, do you want to make all info level logs bold blue or just those? I would go with the former.

And regarding the third point, I don't dim them so that they are highlighted for the user, do you think the colour difference is enough or the non-dimness helps?

JelleZijlstra · 2022-01-22T06:01:20Z

I don't think you should change anything just yet, would be better to get more feedback first.

JelleZijlstra · 2022-12-18T15:51:54Z

This now has heavy merge conflicts. Should we still pursue this change?

Shivansh-007 added 2 commits January 20, 2022 16:34

Actually use OutputLevels in black.output.out() for pretty output…

7427fa6

… logs

felix-hilden requested changes Jan 20, 2022

View reviewed changes

felix-hilden added the skip news Pull requests that don't need a changelog entry. label Jan 20, 2022

felix-hilden removed the skip news Pull requests that don't need a changelog entry. label Jan 20, 2022

Shivansh-007 and others added 3 commits January 21, 2022 11:29

Rename OutputLevels to LogLevel and null to none

12834d3

Apply code style changes

68aa77c

Co-authored-by: felix-hilden <felix.hilden@gmail.com>

Use correct typehint for LogLevel.none

31c962e

Shivansh-007 requested review from felix-hilden and ichard26 January 21, 2022 06:42

Shivansh-007 added 3 commits January 21, 2022 13:32

Add changelog entry

df4d5b9

Merge branch 'main' into pretty-output

2c15263

felix-hilden reviewed Jan 21, 2022

View reviewed changes

src/black/const.py Show resolved Hide resolved

Shivansh-007 added 3 commits January 21, 2022 13:48

Oops

a2c5bbc

Import typing_extensions.TypedDict only on <py38

40e0c9d

Merge branch 'pretty-output' of https://github.com/Shivansh-007/black …

70c77ee

…into pretty-output

Shivansh-007 requested a review from felix-hilden January 21, 2022 10:47

Merge branch 'main' into pretty-output

9b45591

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pretty Terminal Output #2787

Pretty Terminal Output #2787

Shivansh-007 commented Jan 20, 2022 •

edited

Loading

github-actions bot commented Jan 20, 2022 •

edited

Loading

felix-hilden left a comment

felix-hilden Jan 20, 2022

felix-hilden Jan 20, 2022

Shivansh-007 Jan 20, 2022

felix-hilden Jan 20, 2022

JelleZijlstra Jan 20, 2022

Shivansh-007 Jan 20, 2022

felix-hilden Jan 21, 2022

Shivansh-007 Jan 21, 2022

felix-hilden Jan 20, 2022

Shivansh-007 Jan 20, 2022

JelleZijlstra Jan 22, 2022

Shivansh-007 Jan 22, 2022

Shivansh-007 Jan 22, 2022

JelleZijlstra Jan 22, 2022

felix-hilden Jan 20, 2022

Shivansh-007 Jan 20, 2022

felix-hilden Jan 20, 2022

Shivansh-007 Jan 20, 2022

Shivansh-007 commented Jan 20, 2022

felix-hilden left a comment

JelleZijlstra commented Jan 22, 2022

Shivansh-007 commented Jan 22, 2022 •

edited

Loading

JelleZijlstra commented Jan 22, 2022

JelleZijlstra commented Dec 18, 2022

Pretty Terminal Output #2787

Are you sure you want to change the base?

Pretty Terminal Output #2787

Conversation

Shivansh-007 commented Jan 20, 2022 • edited Loading

Checklist - did you ...

github-actions bot commented Jan 20, 2022 • edited Loading

felix-hilden left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shivansh-007 commented Jan 20, 2022

felix-hilden left a comment

Choose a reason for hiding this comment

JelleZijlstra commented Jan 22, 2022

Shivansh-007 commented Jan 22, 2022 • edited Loading

JelleZijlstra commented Jan 22, 2022

JelleZijlstra commented Dec 18, 2022

Shivansh-007 commented Jan 20, 2022 •

edited

Loading

github-actions bot commented Jan 20, 2022 •

edited

Loading

Shivansh-007 commented Jan 22, 2022 •

edited

Loading