Spaces:
No application file
No application file
File size: 3,348 Bytes
ba8d952 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
"""
# 🖋 editor - Open a text editor 🖋
`editor` opens the default text editor or your favorite editor to edit an existing file,
a new file, or a tempfile, blocks while the user edits text, then returns the contents
of the file.
You can pass a parameter `editor=` to specify an editor or leave it empty, in which
case the editor is:
* The contents of the environment variable `VISUAL`, if it's set, otherwise:
* The the contents of the environment variable `EDITOR`, if it's set, otherwise:
* The string `'Notepad'`, if the code is running on Windows, otherwise:
* The string `'vim'`
### Example 1: Using a temporary file
If no filename is provided, a temporary file gets edited, and its contents
returned.
import editor
comments = editor.editor(text='Comments here\\n\\n')
# Pop up the default editor with a tempfile containing "Comments here",
# then return the contents and delete the tempfile.
### Example 2: Using a named file
If a filename is provided, then that file gets edited.
import os
FILE = 'file.txt'
assert not os.path.exists(FILE)
comments = editor.editor(text=MESSAGE, filename=FILE)
# Pop up an editor for a new FILE containing MESSAGE, user edits
# This file is saved when the user exits the editor.
assert os.path.exists(FILE)
# You can edit an existing file too, and select your own editor.
comments2 = editor.editor(filename=FILE, editor='emacs -nw')
"""
import os
import platform
import tempfile
import traceback
import typing as t
from pathlib import Path
import runs
import xmod
__all__ = 'editor', 'default_editor'
DEFAULT_EDITOR = 'vim'
EDITORS = {'Windows': 'notepad'}
@xmod.xmod(mutable=True) # type: ignore[misc]
def editor(
text: t.Optional[str] = None,
filename: t.Union[None, Path, str] = None,
editor: t.Optional[str] = None,
**kwargs: t.Any,
) -> str:
"""
Open a text editor, block while the user edits, then return the results
Args:
text: A string which is written to the file before the editor is opened.
If `None`, the file is left unchanged.
filename: The name of the file to edit.
If `None`, a temporary file is used.
editor: A string containing the command used to invoke the text editor.
If `None`, use `editor.default_editor()`.
kwargs: Arguments passed on to `subprocess.call()`"""
editor = editor or default_editor()
is_temp = not filename
if filename is not None:
fname = filename
else:
fd, fname = tempfile.mkstemp()
os.close(fd)
try:
path = Path(fname)
if text is not None:
path.write_text(text)
cmd = '{} "{}"'.format(editor, path.resolve())
runs.call(cmd, **kwargs)
return path.read_text()
finally:
if is_temp:
try:
path.unlink()
except Exception:
traceback.print_exc()
def default_editor() -> str:
"""
Return the default text editor.
The default text editor is the contents of the environment variable
`EDITOR`, it it's non-empty, otherwise if the platform is Windows, it's
`'notepad'`, otherwise `'vim'`.
"""
return os.environ.get('VISUAL') or (
os.environ.get('EDITOR') or EDITORS.get(platform.system(), DEFAULT_EDITOR)
)
|