ruff check file.py output is unreadable

[copperfield42]

Hello, I just hear of this project so I installed to test it, following the usage indication on some file I got this

I installed it like pip install ruff
ruff version: 0.0.256
Python version 3.11.2
OS: Windows 10

[charliermarsh]

It looks like the color-support detection isn't working. Can you try setting NO_COLOR=1?

(Reference in docs: https://beta.ruff.rs/docs/faq/#how-can-i-disable-ruffs-color-output)

[charliermarsh]

(Not sure why it's not working, but we delegate to another library for that: https://crates.io/crates/colored)

[copperfield42]

creating and setting the NO_COLOR enviroment variable like that I got

now is readable

[copperfield42]

I guess I have to install that colored library too...

[copperfield42]

mmm apparently I have to download a 625mb installer to get the docker thing in order to install the colored library!? what? that is a little too much

[charliermarsh]

No no sorry! You don't need to install that library at all. It's a library that Rust uses under the hood to output the colored escape characters, which many terminals recognize. It's supposed to detect whether your terminal supports those characters, and only output them if it does. In your case, it looks like your terminal doesn't support those characters, but the library is emitting them anyway. (E.g., on my machine, I didn't install that library outside of Ruff, but I do get colored output.)

In short: you don't need to install anything, but for whatever reason, it seems you either need to disable color via the environment variable (so that the library doesn't even try to output color), or try in a different terminal.

[copperfield42]

that is weird, it display color correctly for other thing like those of pip, and with the colorama library (that is needed for the tqdm to display correctly) also work fine, after calling the just_fix_windows_console

removing the environment and trying in the power shell I got the same

here is a test script with the colorama

from colorama import Fore, Back, Style, just_fix_windows_console

just_fix_windows_console()

print(Fore.RED + 'some red text')
print(Back.GREEN + 'and with a green background')
print(Style.DIM + 'and in dim text')
print(Style.RESET_ALL)
print('back to normal now')

commenting the just_fix_windows_console it display

with just_fix_windows_console

maybe there is something similar with that colored library too?

[charliermarsh]

Hmm, I'm not 100% sure -- it says Works on Linux, MacOS, and Windows (Powershell) so it's at least supposed to work in PowerShell.

[charliermarsh]

There's some commentary in colored-rs/colored#59 where it seems like it doesn't work in some cases on Windows, but that it's not clear when.

[charliermarsh]

Oh, I'm seeing this: https://docs.rs/colored/2.0.0/x86_64-pc-windows-msvc/colored/control/fn.set_virtual_terminal.html

[charliermarsh]

Maybe I should be setting that on Windows?

[copperfield42]

well, lets try and see.
constituent there also said something about that

[charliermarsh]

Are you interested in building Ruff locally to test that?

[copperfield42]

sure, what I need to do?

[charliermarsh]

Could you clone this branch (#3583), then run:

cargo run -p ruff_cli -- /path/to/your/file.py --no-cache

[charliermarsh]

You'd need to have Rust installed, so if that's too big of a lift, let me know. Maybe someone else can test.

[copperfield42]

it is big lift, Rust is very heavy, well the Visual Studio part is, that 950mb in just the c++ compiler or whatever holy molly and if it need the win 11 sdk is 1.5gb DX

[copperfield42]

if that branch can be made to be pip installed or similar without needing to install rust I can test it

[charliermarsh]

Ok thanks, let me create a wheel.

[charliermarsh]

I created wheels and binaries from that branch here: https://github.com/charliermarsh/ruff/actions/runs/4450737152

You can download them at the bottom, and find the appropriate one for your platform. LMK if that works...

[copperfield42]

it appear to work correctly now :)

[charliermarsh]

Woohoo! I'll clean up that PR.

[navneethc]

Can you use Windows Terminal?

[copperfield42]

the power shell? sure

[navneethc]

the power shell? sure

No, Windows Terminal -- it's the more modern alternative to the traditional terminal emulator. I'd recommend using that. It's available via the Windows Store: https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701

[copperfield42]

sure, give me a moment to install it

[copperfield42]

in that one there is no issue with either version of ruff

[navneethc]

in that one there is no issue with either version of ruff

Yeah, that's why I recommended it. :)