Move ExternalEditor to own file

qutebrowser/browser/commands.py

@@ -34,8 +34,8 @@ import qutebrowser.browser.hints as hints
 import qutebrowser.utils.url as urlutils
 import qutebrowser.utils.message as message
 import qutebrowser.utils.webelem as webelem
-from qutebrowser.utils.misc import check_overflow, shell_escape, ExternalEditor
+from qutebrowser.utils.misc import check_overflow, shell_escape
-from qutebrowser.utils.misc import shell_escape
+from qutebrowser.utils.editor import ExternalEditor
 from qutebrowser.commands.exceptions import CommandError
 
 

qutebrowser/utils/editor.py

@@ -0,0 +1,113 @@
+# Copyright 2014 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Launcher for an external editor."""
+
+import os
+import logging
+from tempfile import mkstemp
+
+from PyQt5.QtCore import pyqtSignal, QProcess, QObject
+
+import qutebrowser.config.config as config
+
+
+class ExternalEditor(QObject):
+
+    """Class to simplify editing a text in an external editor."""
+
+    editing_finished = pyqtSignal(str)
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.text = None
+        self.oshandle = None
+        self.filename = None
+        self.proc = None
+
+    def _cleanup(self):
+        os.close(self.oshandle)
+        try:
+            os.remove(self.filename)
+        except PermissionError:
+            message.error("Failed to delete tempfile...")
+        self.text = None
+        self.oshandle = None
+        self.filename = None
+        self.proc = None
+
+    def on_proc_closed(self, exitcode, exitstatus):
+        """Write the editor text into the form field and clean up tempfile.
+
+        Callback for QProcess when the editor was closed.
+
+        Emit:
+            editing_finished: If process exited normally.
+        """
+        logging.debug("Editor closed")
+        if exitcode != 0:
+            message.error("Editor did quit abnormally (status {})!".format(
+                exitcode))
+            return
+        if exitstatus != QProcess.NormalExit:
+            # No error here, since we already handle this in on_editor_error
+            return
+        with open(self.filename, 'r') as f:
+            text = ''.join(f.readlines())
+        logging.debug("Read back: {}".format(text))
+        self._cleanup()
+        self.editing_finished.emit(text)
+
+    def on_proc_error(self, error):
+        """Display an error message and clean up when editor crashed."""
+        messages = {
+            QProcess.FailedToStart: "The process failed to start.",
+            QProcess.Crashed: "The process crashed.",
+            QProcess.Timedout: "The last waitFor...() function timed out.",
+            QProcess.WriteError: ("An error occurred when attempting to write "
+                                  "to the process."),
+            QProcess.ReadError: ("An error occurred when attempting to read "
+                                "from the process."),
+            QProcess.UnknownError: "An unknown error occurred.",
+        }
+        message.error("Error while calling editor: {}".format(messages[error]))
+        self._cleanup()
+
+    def edit(self, text):
+        """Edit a given text.
+
+        Args:
+            text: The initial text to edit.
+
+        Emit:
+            editing_finished with the new text if editing finshed successfully.
+        """
+        if self.text is not None:
+            raise ValueError("Already editing a file!")
+        self.text = text
+        self.oshandle, self.filename = mkstemp(text=True)
+        if not text:
+            with open(self.filename, 'w') as f:
+                f.write(text)
+        self.proc = QProcess(self)
+        self.proc.finished.connect(self.on_proc_closed)
+        self.proc.error.connect(self.on_proc_error)
+        editor = config.get('general', 'editor')
+        executable = editor[0]
+        args = [arg.replace('{}', self.filename) for arg in editor[1:]]
+        logging.debug("Calling \"{}\" with args {}".format(executable, args))
+        self.proc.start(executable, args)

qutebrowser/utils/misc.py

@@ -27,18 +27,14 @@ import re
 import sys
 import shlex
 import os.path
-import logging
 import urllib.request
-from tempfile import mkstemp
 from urllib.parse import urljoin, urlencode
 from functools import reduce
 
-from PyQt5.QtCore import (pyqtSignal, QCoreApplication, QStandardPaths,
+from PyQt5.QtCore import QCoreApplication, QStandardPaths
-                          QProcess, QObject)
 from pkg_resources import resource_string
 
 import qutebrowser
-import qutebrowser.config.config as config
 import qutebrowser.utils.message as message
 
 
@@ -245,90 +241,3 @@ def actute_warning():
                       "https://bugs.freedesktop.org/show_bug.cgi?id=69476 for "
                       "details.")
                 break
-
-
-class ExternalEditor(QObject):
-
-    """Class to simplify editing a text in an external editor."""
-
-    editing_finished = pyqtSignal(str)
-
-    def __init__(self, parent=None):
-        super().__init__(parent)
-        self.text = None
-        self.oshandle = None
-        self.filename = None
-        self.proc = None
-
-    def _cleanup(self):
-        os.close(self.oshandle)
-        try:
-            os.remove(self.filename)
-        except PermissionError:
-            message.error("Failed to delete tempfile...")
-        self.text = None
-        self.oshandle = None
-        self.filename = None
-        self.proc = None
-
-    def on_proc_closed(self, exitcode, exitstatus):
-        """Write the editor text into the form field and clean up tempfile.
-
-        Callback for QProcess when the editor was closed.
-
-        Emit:
-            editing_finished: If process exited normally.
-        """
-        logging.debug("Editor closed")
-        if exitcode != 0:
-            message.error("Editor did quit abnormally (status {})!".format(
-                exitcode))
-            return
-        if exitstatus != QProcess.NormalExit:
-            # No error here, since we already handle this in on_editor_error
-            return
-        with open(self.filename, 'r') as f:
-            text = ''.join(f.readlines())
-        logging.debug("Read back: {}".format(text))
-        self._cleanup()
-        self.editing_finished.emit(text)
-
-    def on_proc_error(self, error):
-        """Display an error message and clean up when editor crashed."""
-        messages = {
-            QProcess.FailedToStart: "The process failed to start.",
-            QProcess.Crashed: "The process crashed.",
-            QProcess.Timedout: "The last waitFor...() function timed out.",
-            QProcess.WriteError: ("An error occurred when attempting to write "
-                                  "to the process."),
-            QProcess.ReadError: ("An error occurred when attempting to read "
-                                "from the process."),
-            QProcess.UnknownError: "An unknown error occurred.",
-        }
-        message.error("Error while calling editor: {}".format(messages[error]))
-        self._cleanup()
-
-    def edit(self, text):
-        """Edit a given text.
-
-        Args:
-            text: The initial text to edit.
-
-        Emit:
-            editing_finished with the new text if editing finshed successfully.
-        """
-        if self.text is not None:
-            raise ValueError("Already editing a file!")
-        self.text = text
-        self.oshandle, self.filename = mkstemp(text=True)
-        if not text:
-            with open(self.filename, 'w') as f:
-                f.write(text)
-        self.proc = QProcess(self)
-        self.proc.finished.connect(self.on_proc_closed)
-        self.proc.error.connect(self.on_proc_error)
-        editor = config.get('general', 'editor')
-        executable = editor[0]
-        args = [arg.replace('{}', self.filename) for arg in editor[1:]]
-        logging.debug("Calling \"{}\" with args {}".format(executable, args))
-        self.proc.start(executable, args)