-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
otk/ui: introduce some sort of ui #272
Open
supakeen
wants to merge
5
commits into
osbuild:main
Choose a base branch
from
supakeen:you-spin-me-right-round-baby-right-round
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8c4039f
otk/ui: create an ui submodule
supakeen 17b2c64
otk/ui: introduce spinner for externals
supakeen e4bf986
otk: reduce log level for includes
supakeen 105aacd
otk/ui: provide and use a print function
supakeen 6a59e83
otk/ui: introduce MOTD
supakeen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
import sys | ||
import time | ||
import threading | ||
|
||
from typing import Optional, Type | ||
from types import TracebackType | ||
|
||
from . import __version__ | ||
|
||
|
||
class _Spinner: | ||
"""Render a spinner with an optional prompt to stderr, if stderr isn't a | ||
tty this only prints the prompt.""" | ||
|
||
active: bool | ||
thread: threading.Thread | ||
|
||
def __init__(self, prompt: str) -> None: | ||
self.prompt = prompt | ||
|
||
def _loop(self): | ||
sys.stderr.write(self.prompt) | ||
sys.stderr.flush() | ||
|
||
# No spinner business if we aren't printing to tty's. | ||
if sys.stderr.isatty(): | ||
while self.active: | ||
sys.stderr.write(".") | ||
sys.stderr.flush() | ||
time.sleep(0.1) | ||
|
||
# Only write a newline if the prompt was actually there | ||
if self.prompt: | ||
sys.stderr.write("\n") | ||
sys.stderr.flush() | ||
|
||
def __enter__(self, prompt: str = "") -> None: | ||
self.active = True | ||
self.thread = threading.Thread(target=self._loop) | ||
self.thread.start() | ||
|
||
def __exit__( | ||
self, | ||
exc_type: Optional[Type[BaseException]], | ||
exc_val: Optional[BaseException], | ||
exc_tb: Optional[TracebackType], | ||
) -> bool: | ||
self.active = False | ||
self.thread.join() | ||
|
||
return True | ||
|
||
|
||
def spinner(prompt: str) -> _Spinner: | ||
return _Spinner(prompt) | ||
|
||
|
||
def print(text: str) -> None: # pylint: disable=redefined-builtin | ||
"""Write a line of text to stderr if it's attached to a tty.""" | ||
if sys.stderr.isatty(): | ||
sys.stderr.write(text + "\n") | ||
sys.stderr.flush() | ||
|
||
|
||
def motd() -> None: | ||
# Note, this is the local print function | ||
print(f"otk {__version__} -- https://www.osbuild.org/") |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As an intermediate solution to the valuable input of @mvo5 - should we info/debug-log the text here, to avoid duplication and have those interesting messages also in the logs?
( could as well be the "else" of
isatty()
? )