Improved tty-less progress reporting #8939
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously when running borg in a systemd service (and similar when piping to a file and co.), these problems occurred: - The carriage return both made it so that journald interpreted the output as binary, therefore not printing the text, while also not buffering correctly, so that log output was only available every once in a while in the form [40k blob data]. This can partially be worked around by using `journalctl -a` to view the logs, which at least prints the text, though only sporadically - The path was getting truncated to a short length, since the default get_terminal_size returns a column width of 80, which isn't relevant when printing to e.g. journald This commit fixes this by introducing a new code path for when stderr is a tty, which always prints the full paths and never ends with a carriage return.
infinisil
force-pushed
the
non-tty-progress
branch
from
77084c8 to
a9e7040
Compare
ThomasWaldmann
requested changes
Jun 26, 2025
| return format_file_size(self.usize, iec=self.iec) | ||
|
|
||
| def show_progress(self, item=None, final=False, stream=None, dt=None): | ||
| def show_progress(self, item=None, final=False, stream=sys.stderr, dt=None): |
Member
There was a problem hiding this comment.
This would determine the default (the value of sys.stderr) at import time, while the original code determines it later, when the code is actually called. IIRC, that could be important.
So, to not risk any breakage, just keep the stream=None default and add a first line inside the method:
stream = stream or sys.stderr
And then use stream everywhere in the function where appropriate.
| end = "\n" | ||
| elif not stream.isatty(): | ||
| if not final: | ||
| msg = "{0.osize_fmt} O {0.csize_fmt} C {0.usize_fmt} D {0.nfiles} N ".format(self) |
Member
There was a problem hiding this comment.
hmm, the other branch uses U for usize.
Member
There was a problem hiding this comment.
also:
E AttributeError: 'Statistics' object has no attribute 'csize_fmt'
Member
|
Besides some technicalities in previous feedback, there is also something rather fundamental:
|
ThomasWaldmann
added a commit
to ThomasWaldmann/borg
that referenced
this pull request
Oct 11, 2025
Previously when running borg in a systemd service (and similar when piping to a file and co.), these problems occurred: - The carriage return both made it so that journald interpreted the output as binary, therefore not printing the text, while also not buffering correctly, so that log output was only available every once in a while in the form [40k blob data]. This can partially be worked around by using `journalctl -a` to view the logs, which at least prints the text, though only sporadically. - The path was getting truncated to a short length, since the default get_terminal_size returns a column width of 80, which isn't relevant when printing to e.g. journald. This commit fixes this by introducing a new code path for when stream is not a tty, which always prints the full paths and ends lines with a linefeed. This is based on unfinished PR borgbackup#8939 by @infinisil, thanks for your suggestion!
Member
|
Thanks for your suggestion, I am finishing this in #9055. |
ThomasWaldmann
added a commit
to ThomasWaldmann/borg
that referenced
this pull request
Oct 11, 2025
Previously when running borg in a systemd service (and similar when piping to a file and co.), these problems occurred: - The carriage return both made it so that journald interpreted the output as binary, therefore not printing the text, while also not buffering correctly, so that log output was only available every once in a while in the form [40k blob data]. This can partially be worked around by using `journalctl -a` to view the logs, which at least prints the text, though only sporadically. - The path was getting truncated to a short length, since the default get_terminal_size returns a column width of 80, which isn't relevant when printing to e.g. journald. This commit fixes this by introducing a new code path for when stream is not a tty, which always prints the full paths and ends lines with a linefeed. This is based on unfinished PR borgbackup#8939 by @infinisil, thanks for your suggestion!
ThomasWaldmann
added a commit
to ThomasWaldmann/borg
that referenced
this pull request
Oct 15, 2025
Previously when running borg in a systemd service (and similar when piping to a file and co.), these problems occurred: - The carriage return both made it so that journald interpreted the output as binary, therefore not printing the text, while also not buffering correctly, so that log output was only available every once in a while in the form [40k blob data]. This can partially be worked around by using `journalctl -a` to view the logs, which at least prints the text, though only sporadically. - The path was getting truncated to a short length, since the default get_terminal_size returns a column width of 80, which isn't relevant when printing to e.g. journald. This commit fixes this by introducing a new code path for when stream is not a tty, which always prints the full paths and ends lines with a linefeed. This is based on unfinished PR borgbackup#8939 by @infinisil, thanks for your suggestion! Forward port of PR borgbackup#9055 to master.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously when running borg in a systemd service (and similar when piping to a file and co.), these problems occurred:
journalctl -ato view the logs, which at least prints the text, though only sporadicallyThis commit fixes this by introducing a new code path for when stderr is a tty, which always prints the full paths and never ends with a carriage return.
Unfortunately I don't have the time right now to make the tests work nor add new ones to cover this, but I figured at least getting this patch out of my local repository is better than keeping it for myself, it definitely works in my deployment. Because of this I'll mark this PR a draft for now, feel free to close it if neither me nor anybody else manages to make the tests satisfactory in a reasonable time.