When using nano as editor, python-editor first opens an empty file. After closing that file, the given file is opened.

Test script:

from editor import edit
from os import unlink
from tempfile import NamedTemporaryFile


testfile = NamedTemporaryFile(prefix='editest', delete=False)
testfile.write('Hello World!')
testfile.close()


edit(testfile.name)


unlink(testfile.name)

Executing this as follows, works as expected:

EDITOR=vim python testscript.py

However, the following does not open the test file immediately:

EDITOR=nano python testscript.py

In Debian, we have a system called alternatives which allows the user to select the default applications for several tasks, including the editor. This system provides an /usr/bin/editor symlink pointing to user's command-line editor of choice. It would be nice if you could add support for this.

Our Policy recommends the following algorithm:

Thus, every program that launches an editor or pager must use the EDITOR or PAGER environment variable to determine the editor or pager the user wishes to use. If these variables are not set, the programs /usr/bin/editor and /usr/bin/pager should be used, respectively.

we are packaging python-editor for fedora. As per the pypi tarball : https://pypi.python.org/pypi/python-editor , the README and LICENSE file is missing. Please include in the pypi tarball and version tag is also missing on github. Please include it.

Can you add this package to PyPI?

Hi,
Version 1.0.2 appears to be missing on PyPI.

I'm not familiar with publishing on PyPI, but was 1.0.2 ever released or does the "latest" version need to be set to 1.0.2b?

Thank you!

On Windows I get an error. This is because tmp = tempfile.NamedTemporaryFile(suffix=suffix) (line 84) opens and locks the file.
This can be fixed by calling tmp.close() directly afterwards but I don't know if this breaks anything on other OSes.

>>> editor.edit(contents="hello")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\Max\AppData\Local\pypoetry\Cache\virtualenvs\bulletin-3-N3PFQvT7-py3.10\lib\site-packages\editor.py", line 92, in edit
    with open(filename, mode='wb') as f:
PermissionError: [Errno 13] Permission denied: 'C:\\Users\\Max\\AppData\\Local\\Temp\\tmp55cimtei'

Running the tests with python3.6 results in:

$ python3.6 test.py 
Traceback (most recent call last):
  File "test.py", line 5, in <module>
    use_tty='use_tty' in sys.argv)
  File "/home/tom/devel/python-editor/editor.py", line 89, in edit
    f.write(contents)
TypeError: a bytes-like object is required, not 'str'

The 'file' argument for edit() should be 'filename' in the documentation

import editor
commit_msg = editor.edit(contents=b"# Enter commit message here")

This works in the python3 command line (while exhibiting bug #1), but when called as a script I get the following error.

$ python3 /home/leggewie/.PyCharmCE2019.2/config/scratches/editor.py

Traceback (most recent call last):
File "/home/leggewie/.PyCharmCE2019.2/config/scratches/editor.py", line 1, in
import editor
File "/home/leggewie/.PyCharmCE2019.2/config/scratches/editor.py", line 3, in
commit_msg = editor.edit(contents=b"# Enter commit message here")
AttributeError: module 'editor' has no attribute 'edit'

python3 -c 'import editor; editor.edit(contents=b"# Enter commit message here")' works fine and does not bring about #1, either.

When I use pytest, I have this warning:

.../ve/lib/python3.6/distutils/__init__.py:4
  .../ve/lib/python3.6/distutils/__init__.py:4: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
    import imp

It seems related to this line:

distutils imports imp.

shutil.which seems to be an alternative supported since Python 3.3.

editor.edit('file') fails when the defined $EDITOR contains spaces:

$ touch /tmp/file
$ export EDITOR='vim -v'
$ python -c 'import editor; editor.edit("/tmp/file")' 
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "editor.py", line 103, in edit
    proc = subprocess.Popen(args, close_fds=True, stdout=stdout)
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 710, in __init__
    errread, errwrite)
  File "/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/subprocess.py", line 1335, in _execute_child
    raise child_exception
OSError: [Errno 2] No such file or directory

After removing the space, it works:

$ export EDITOR='vim'
$ python -c 'import editor; editor.edit("/tmp/file")'

Originally (and improperly) reported here as an Alembic issue.

Does this lib provide any windows support?

Not a "real" issue, just thought about dropping by to say thank you for such an easy-to-use module. 👍

Hey @fmoo, would you mind adding a release tag for 0.5 if the current master is ready?

Great work BTW...

I'm hoping to use this for a nose plugin I'm writing, but id like to pass a line number through to the editor command... Any chance you could expose that? or better still allow arbitrary args to be passed through?

e.g. emacs +123

Thanks

Trying to get a message doing the following:

msg = editor.edit(contents=b"PO# ")

instead the editor hangs and my Mac's fans kick in. It works when running as admin but right now I'm running in my non-admin desktop.

Hello when building packages rpmbuild get error

*** ERROR: ambiguous python shebang in /lib/python3.8/site-packages/editor.py: #!/usr/bin/env python. Change it to python3 (or python2) explicitly.

common case is our users will have EDITOR set to gvim -f which causes editor to crash.

This line seems to trigger a deprecation warning on Python 3.10. This happens both for the latest released version (1.0.4) as well as the latest master.

Minimal working example

$ python -W default -c 'import editor; editor.get_editor()'
/Users/alex/my-project/venv/lib/python3.10/site-packages/editor.py:11: DeprecationWarning: The distutils package is deprecated and slated for removal in Python 3.12. Use setuptools or check PEP 632 for potential alternatives
  from distutils.spawn import find_executable

Impact

• Noisy test output from pytest test suite. Explanation: DeprecationWarnings are silenced by default but pytest shows them anyway. Projects that use editor get warnings in their test output.
• This functionality will eventually break in Python 3.12.