Similar to #827, seeing ANSI colors with --no-color #956

New Issue

Closed

opened 2024-12-23 03:32:10 +00:00 by lingfish · 7 comments

lingfish commented 2024-12-23 03:32:10 +00:00

Contributor

Copy Link

What I'm trying to do and why

Heya, I'm scripting some stuff around info, and when there is errors, I'm seeing a ANSI reset of \x1b[0m in stdout output.

Steps to reproduce

Run borgmatic --no-color info --json from a python subprocess call (expecting an error), seeing the error via stderr (good), but also seeing a mostly empty stdout, but with \x1b[0m.

Actual behavior

As above.

Expected behavior

No ANSI whatsoever, if using --no-color.

Other notes / implementation ideas

No response

borgmatic version

1.9.4

borgmatic installation method

pipx

Borg version

1.4.0

Python version

3.11

Database version (if applicable)

No response

Operating system and version

PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"

### What I'm trying to do and why Heya, I'm scripting some stuff around `info`, and when there is errors, I'm seeing a ANSI reset of `\x1b[0m` in `stdout` output. ### Steps to reproduce Run `borgmatic --no-color info --json` from a python subprocess call (expecting an error), seeing the error via `stderr` (good), but also seeing a *mostly* empty `stdout`, but with `\x1b[0m`. ### Actual behavior As above. ### Expected behavior No ANSI whatsoever, if using `--no-color`. ### Other notes / implementation ideas _No response_ ### borgmatic version 1.9.4 ### borgmatic installation method pipx ### Borg version 1.4.0 ### Python version 3.11 ### Database version (if applicable) _No response_ ### Operating system and version PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"

witten commented 2024-12-23 06:15:51 +00:00

Owner

Copy Link

Thanks for taking the time to file this. Unfortunately I haven't been able to get a repro thus far. Here's what I tried with both borgmatic 1.9.4 and main:

$ python -c "import subprocess; subprocess.check_call('borgmatic --config nope --no-color info --json'.split(' '))" > stdout
nope: No valid configuration files found

summary:
...
$ ls -lh stdout
-rw-r--r-- 1 root root 0 Dec 22 22:09 stdout

So stdout is zero bytes, meaning that there aren't any ANSI codes in it. I've also tried without redirection, and didn't see anything suspicious on the console. If you run that command, do you get a similar result? Or do you see an escape code in the output?

If you do get the same result, then can you give a little more info about your repro? What error are you getting, and what's your config file look like?

Thanks for taking the time to file this. Unfortunately I haven't been able to get a repro thus far. Here's what I tried with both borgmatic 1.9.4 and main: ```bash $ python -c "import subprocess; subprocess.check_call('borgmatic --config nope --no-color info --json'.split(' '))" > stdout nope: No valid configuration files found summary: ... $ ls -lh stdout -rw-r--r-- 1 root root 0 Dec 22 22:09 stdout ``` So stdout is zero bytes, meaning that there aren't any ANSI codes in it. I've also tried without redirection, and didn't see anything suspicious on the console. If you run that command, do you get a similar result? Or do you see an escape code in the output? If you do get the same result, then can you give a little more info about your repro? What error are you getting, and what's your config file look like?

lingfish commented 2024-12-24 01:56:20 +00:00

Author

Contributor

Copy Link

Yeah, I get the same result as you.

This is truly doing my head in; I've been changing TERM, setting NO_COLOR (as I use click and rich) selectively culling parts of my app, cannot work it out other than it is indeed borgmatic outputting it -- here's an strace launched from within:

2295789 openat(AT_FDCWD, "/etc/borgmatic.d/someconfig.yaml", O_RDONLY|O_CLOEXEC) = -1 EACCES (Permission denied)
2295789 getpid()                        = 2295789
2295789 getpid()                        = 2295789
2295789 write(2, "/etc/borgmatic/config.yaml /etc/"..., 154) = 154
2295789 getpid()                        = 2295789
2295789 write(2, "\n", 1)               = 1
2295789 getpid()                        = 2295789
2295789 write(2, "summary:\n", 9)       = 9
2295789 write(2, "/etc/borgmatic.d/someconfig.yaml: Ins"..., 81) = 81
2295789 write(2, "/etc/borgmatic.d/anotherconfig.yaml: "..., 84) = 84
2295789 write(2, "/etc/borgmatic/config.yaml /etc/"..., 154) = 154
2295789 getpid()                        = 2295789
2295789 write(2, "\n", 1)               = 1
2295789 getpid()                        = 2295789
2295789 write(2, "Need some help? https://torsion."..., 54) = 54
2295789 write(1, "\33[0m", 4)           = 4

The ANSI can clearly be seen at the end writeing to FD 1.

Yeah, I get the same result as you. This is truly doing my head in; I've been changing `TERM`, setting `NO_COLOR` (as I use `click` and `rich`) selectively culling parts of my app, cannot work it out other than it is indeed `borgmatic` outputting it -- here's an `strace` launched from within: ``` 2295789 openat(AT_FDCWD, "/etc/borgmatic.d/someconfig.yaml", O_RDONLY|O_CLOEXEC) = -1 EACCES (Permission denied) 2295789 getpid() = 2295789 2295789 getpid() = 2295789 2295789 write(2, "/etc/borgmatic/config.yaml /etc/"..., 154) = 154 2295789 getpid() = 2295789 2295789 write(2, "\n", 1) = 1 2295789 getpid() = 2295789 2295789 write(2, "summary:\n", 9) = 9 2295789 write(2, "/etc/borgmatic.d/someconfig.yaml: Ins"..., 81) = 81 2295789 write(2, "/etc/borgmatic.d/anotherconfig.yaml: "..., 84) = 84 2295789 write(2, "/etc/borgmatic/config.yaml /etc/"..., 154) = 154 2295789 getpid() = 2295789 2295789 write(2, "\n", 1) = 1 2295789 getpid() = 2295789 2295789 write(2, "Need some help? https://torsion."..., 54) = 54 2295789 write(1, "\33[0m", 4) = 4 ``` The ANSI can clearly be seen at the end `write`ing to FD 1.

witten referenced this issue 2024-12-24 03:37:12 +00:00

Replace colorama dependency #958

witten commented 2024-12-24 03:53:50 +00:00

Owner

Copy Link

I've confirmed that locally:

$ python -c "import subprocess; subprocess.check_call('strace borgmatic --config nope --no-color info --json'.split(' '))"
...
write(2, "Need some help? https://torsion."..., 54Need some help? https://torsion.org/borgmatic/#issues
) = 54
ioctl(1, TCGETS, {c_iflag=ICRNL|IXON|IUTF8, c_oflag=NL0|CR0|TAB0|BS0|VT0|FF0|OPOST|ONLCR, c_cflag=B38400|CS8|CREAD, c_lflag=ISIG|ICANON|ECHO|ECHOE|ECHOK|IEXTEN|ECHOCTL|ECHOKE, ...}) = 0
write(1, "\33[0m", 4)                   = 4

And now I have a fix in main! The problem was that colorama was unconditionally outputting a color reset code at exit. Incidentally, it may make sense to ditch colorama at some point: #958.

This fix will be part of the next release. Thanks again!

I've confirmed that locally: ```bash $ python -c "import subprocess; subprocess.check_call('strace borgmatic --config nope --no-color info --json'.split(' '))" ... write(2, "Need some help? https://torsion."..., 54Need some help? https://torsion.org/borgmatic/#issues ) = 54 ioctl(1, TCGETS, {c_iflag=ICRNL|IXON|IUTF8, c_oflag=NL0|CR0|TAB0|BS0|VT0|FF0|OPOST|ONLCR, c_cflag=B38400|CS8|CREAD, c_lflag=ISIG|ICANON|ECHO|ECHOE|ECHOK|IEXTEN|ECHOCTL|ECHOKE, ...}) = 0 write(1, "\33[0m", 4) = 4 ``` And now I have a fix in main! The problem was that colorama was unconditionally outputting a color reset code at exit. Incidentally, it may make sense to ditch colorama at some point: #958. This fix will be part of the next release. Thanks again!

witten closed this issue 2024-12-24 03:53:50 +00:00

witten referenced this issue from a commit 2024-12-24 03:55:01 +00:00

Fix the printing of a color reset code at exit even when color is disabled (#956).

witten added the

bug

label 2024-12-24 03:57:41 +00:00

lingfish commented 2024-12-24 23:00:16 +00:00

Author

Contributor

Copy Link

We were on the same page, nice one. A pleasure working with you as always Dan!

I've read the other ticket, agreed. I'd like to take a stab at that if you like? I note in there you speak of the size of rich, I personally don't see that as an issue (is your concern around size because you are vendoring?). Happy for me to proceed with rich?

We were on the same page, nice one. A pleasure working with you as always Dan! I've read the other ticket, agreed. I'd like to take a stab at that if you like? I note in there you speak of the size of `rich`, I personally don't see that as an issue (is your concern around size because you are vendoring?). Happy for me to proceed with `rich`?

witten commented 2024-12-27 03:25:09 +00:00

Owner

Copy Link

Sorry, I just saw this after having already implemented that ticket. My apologies! I ended up just replacing colorama with a handful of color constants.. borgmatic wasn't using a lot of colorama's functionality. And yes, rich seemed like overkill. The size wasn't a huge issue—borgmatic itself doesn't do any vendoring even if third-party packages might—but after looking at rich it seemed like a higher-level library than borgmatic really needed to color a couple of different log types.

Sorry, I just saw this after having already implemented that ticket. My apologies! I ended up just replacing colorama with a handful of color constants.. borgmatic wasn't using a lot of colorama's functionality. And yes, `rich` seemed like overkill. The size wasn't a huge issue—borgmatic itself doesn't do any vendoring even if third-party packages might—but after looking at `rich` it seemed like a higher-level library than borgmatic really needed to color a couple of different log types.

👍 1

lingfish commented 2024-12-27 03:51:12 +00:00

Author

Contributor

Copy Link

All good!

All good!

witten commented 2024-12-27 17:01:56 +00:00

Owner

Copy Link

Released in borgmatic 1.9.5!

Released in borgmatic 1.9.5!

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

config-command-line

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels

blocked

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

No Label

bug

Milestone

No items

No Milestone

Assignees

Clear assignees

diivi import_bot witten

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#956

No description provided.