tui: open log files in external application #6611
Open
Conversation
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
oliver-sanders
force-pushed
the
tui-open-log-in-external-tool
branch
from
3a22611 to
4eb3f7d
Compare
1 task
oliver-sanders
force-pushed
the
tui-open-log-in-external-tool
branch
from
4eb3f7d to
853af33
Compare
oliver-sanders
commented
Feb 14, 2025
cylc/flow/tui/overlay.py
Outdated
Comment on lines
507
to
500
| with tempfile.NamedTemporaryFile('w+') as temp_file: | ||
| # write the text into a temp file | ||
| temp_file.write(text) | ||
| temp_file.seek(0, 0) | ||
|
|
||
| # make the file readonly to avoid confusion | ||
| os.chmod(temp_file.name, stat.S_IRUSR) |
There was a problem hiding this comment.
This is the approach we used to use cylc view. Dump the text into a temp file and mark it as readonly so that people don't think they can edit it.
Note, we can't reliably edit the file locally because it might not be a local file.
oliver-sanders
force-pushed
the
tui-open-log-in-external-tool
branch
from
853af33 to
f0695a9
Compare
hjoliver
reviewed
Feb 16, 2025
| @@ -0,0 +1 @@ | |||
| Tui: Add ability to open log files in external tools. Configure your `$EDITOR`, `$GEDITOR` or `$PAGER` options to configure which tool is used. | |||
There was a problem hiding this comment.
Too much "configure".
Suggested change
| Tui: Add ability to open log files in external tools. Configure your `$EDITOR`, `$GEDITOR` or `$PAGER` options to configure which tool is used. | |
| Tui: Add ability to open log files in external tools. Configure your `$EDITOR`, `$GEDITOR` or `$PAGER` options to choose which tool is used. |
|
For coverage, I think you could test this with a fake editor that just reads the file the in, then exits? |
oliver-sanders
force-pushed
the
tui-open-log-in-external-tool
branch
from
f0695a9 to
c51d584
Compare
* Allow log files to be open in external applications. * Tui will suspend whilst the external tool is open, and resume once it has closed. * Options implemented are `$EDITOR`, `$GEDITOR`, `$PAGER` and `vim` as a backup.
oliver-sanders
force-pushed
the
tui-open-log-in-external-tool
branch
from
c51d584 to
38b4c09
Compare
I've added an integration test that mocks out the command itself. This isn't really testing very much, but I think it's about all we can do without actually driving an interactive terminal session. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Requested in: https://cylc.discourse.group/t/feature-request-cylc-tui-searching-job-out-job-err-files/1122/2
$EDITOR,$GEDITOR,$PAGERandvimas a backup.Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).?.?.xbranch.