Add support for nicer error output by ilevkivskyi · Pull Request #7425 · python/mypy

ilevkivskyi · 2019-08-30T10:38:19Z

This adds some basic support for output styling on Mac and Linux. The formatter does some basic error message parsing because passing them forward in a structured form would be a bigger change, however if you think this is worth doing I can refactor the PR in a more principled way.

To illustrate the result this is how the output would look:

ilevkivskyi · 2019-08-30T11:58:44Z

I just realized that these changes don't affect the daemon. When we will agree here, I will make a separate PR to update the daemon.

JukkaL · 2019-08-30T12:58:12Z

Nice! I'd like to play around a little with this before merging to get a feel of how this works.

A few quick comments:

The error code looks too prominent to me. Maybe it should be in gray or cyan, for example? It's probably the least interesting thing in the output.
It would be interesting to try making the error message bolded/more bright to make it stand out a bit more from the path.
Maybe "error" should be in brighter red? Now it's a bit dark.
What about using an emoji such as ✨ for success? Something like "✨ All clean" or something. Emojis in error messages seem to be all the rage these days. (No need to do this in this PR, as this could be a bit tricky, depending on the default encoding etc.)

ilevkivskyi · 2019-08-30T15:37:05Z

@JukkaL OK, I made the changes we discussed privately. Also here is how new output looks on white background.

gvanrossum · 2019-08-30T15:45:42Z

I like the new look on a light theme. (What does it look now on black theme? Still the same?)

I don't recognize Jukka's emoji; let's not go there (error messages are formal speech, where emoji aren't as accepted as in informal speech).

ilevkivskyi · 2019-08-30T15:52:43Z

What does it look now on black theme? Still the same?

I want to check on my home Linux machine (Mac and Linux may have slightly different colors). I will post a new screenshot when I am back home.

ilevkivskyi · 2019-08-30T15:53:07Z

Btw I opened mypyc/mypyc#696 for mypyc compilation error.

msullivan · 2019-08-30T22:10:25Z

+class FancyFormatter:
+    """Apply color and bold font to terminal output.
+
+    This currently only works on Linus an Mac.


Linux and Mac

msullivan · 2019-08-30T22:22:33Z

+        if sys.platform not in ('linux', 'darwin'):
+            self.dummy_term = True
+            return
+        if not f_out.isatty() or not f_err.isatty():


I think we need a flag to suppress the isatty checking, since our internal scripts all wrap mypy for logging purposes.

Yes, indeed. I however added just an environment variable, it is probably relatively rarely needed thing.

msullivan · 2019-08-30T22:26:46Z

+        return out
+
+    def underline_link(self, note: str) -> str:
+        match = re.search(r'http://\S*', note)


probably want https too

msullivan · 2019-08-30T22:33:17Z

I love this

ilevkivskyi · 2019-08-30T23:39:38Z

@gvanrossum I think the new version still works well on dark background:

gvanrossum · 2019-08-30T23:42:36Z

IMO the contrast for "note" is too low. But presumably it's easy enough to tweak later, so don't worry about it. Or just leave it black?

emmatyping · 2019-08-30T23:52:50Z

+from typing_extensions import Final, Type, Literal
+
+try:
+    import curses


Instead of using curses which doesn't support Windows well, perhaps we could use colorama instead? If you don't want to change things in this PR I can open one to redo this in colorama if you want (maybe after the daemon changes).

ilevkivskyi · 2019-08-31T00:18:45Z

@gvanrossum I actually like it this way. I would keep it and see what people say.

@ethanhs I wanted to start from curses because it is what is in stdlib. But yeah at some point we can switch to something more advanced (if this is required for Windows). Btw, I have heard curses may be available on Windows too but I can't check this. Can you try this PR on Windows (after removing the platform check)?

gvanrossum · 2019-08-31T00:26:45Z

No worries. It turns out my love for this is mostly theoretical, since I usually look at mypy errors through various tools (e.g. the PyCharm plugin or Dropbox CI).

IIUC curses on Windows is a 3rd party package: https://pypi.org/project/windows-curses/.

emmatyping · 2019-08-31T06:13:21Z

So I tested the PR removing the platform check on Windows:

I went ahead and tried the windows-curses package and it returned None for the tigetstr calls, and so it doesn't seem to work, which didn't really surprise me, as I've heard that curses on Windows is rather buggy.

ilevkivskyi · 2019-08-31T11:10:52Z

I opened some follow-up issues. I would propose to merge this soon (today) and then iterate later (if there are no objections).

ssbarnea · 2020-05-07T18:42:50Z

What is the trick to enable colors for mypy as I am running on MacOS? All the other python tools are able to use colors but mypy is still plain. I did an import curses and I got no error, so I doubt is that. Funny, all the CLI options seem to be about how to disable it not how to enforce it.

I tried: mypy --color-output lib and clearly it lacks any colors.

emmatyping · 2020-05-07T20:05:31Z

@ssbarnea please open a new issue describing what terminal you are using and any other relevant information.

ssbarnea · 2020-05-08T09:23:26Z

@ethanhs Thanks, added as #8791

ilevkivskyi added 4 commits August 30, 2019 11:28

Add support for nicer error output

b3c1710

Be more careful about curses

fdb9dbf

Mypyc doesn't like method level imports?

ffeb74e

Fix and add tests

2d26fb0

ilevkivskyi requested review from JukkaL and gvanrossum August 30, 2019 11:58

Address CR; few more ideas

bf3d3db

msullivan reviewed Aug 30, 2019

View reviewed changes

Address CR

1ed6640

emmatyping reviewed Aug 30, 2019

View reviewed changes

This was referenced Aug 31, 2019

Support colorized output on Windows #7437

Closed

Support colorized output for daemon #7438

Closed

Document how to suppress colorized output and summary line #7439

Closed

ilevkivskyi merged commit 178603c into python:master Aug 31, 2019

ilevkivskyi deleted the add-basic-color branch August 31, 2019 13:43

Conversation

ilevkivskyi commented Aug 30, 2019

Uh oh!

ilevkivskyi commented Aug 30, 2019

Uh oh!

JukkaL commented Aug 30, 2019

Uh oh!

ilevkivskyi commented Aug 30, 2019

Uh oh!

gvanrossum commented Aug 30, 2019

Uh oh!

ilevkivskyi commented Aug 30, 2019

Uh oh!

ilevkivskyi commented Aug 30, 2019

Uh oh!

msullivan Aug 30, 2019

Choose a reason for hiding this comment

Uh oh!

msullivan Aug 30, 2019

Choose a reason for hiding this comment

Uh oh!

ilevkivskyi Aug 30, 2019

Choose a reason for hiding this comment

Uh oh!

msullivan Aug 30, 2019

Choose a reason for hiding this comment

Uh oh!

msullivan commented Aug 30, 2019

Uh oh!

ilevkivskyi commented Aug 30, 2019

Uh oh!

gvanrossum commented Aug 30, 2019

Uh oh!

emmatyping Aug 30, 2019

Choose a reason for hiding this comment

Uh oh!

ilevkivskyi commented Aug 31, 2019

Uh oh!

gvanrossum commented Aug 31, 2019

Uh oh!

emmatyping commented Aug 31, 2019

Uh oh!

ilevkivskyi commented Aug 31, 2019

Uh oh!

ssbarnea commented May 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emmatyping commented May 7, 2020

Uh oh!

ssbarnea commented May 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ssbarnea commented May 7, 2020 •

edited

Loading

ssbarnea commented May 8, 2020 •

edited

Loading