Merge pull request #6 from Wilfred/import_positions

Wilfred · web-flow · commit 8ce419c91468 · 2018-03-08T17:27:52.000Z
Find correct import location when there's a module docstring
diff --git a/pyimport.el b/pyimport.el
@@ -129,11 +129,18 @@ To terminate the loop early, throw 'break."
             ;; Find the first non-comment non-blank line.
             (dotimes (_ 30)
               (forward-line 1)
-              (when (and (not (looking-at "\n"))
-                         (not (looking-at "#"))
-                         (not (looking-at "\"")))
-                (setq insert-pos (point))
-                (throw 'found nil))))
+              (let* ((ppss (syntax-ppss))
+                     ;; Since point is at the start of the line, we
+                     ;; are outside single line comments or
+                     ;; strings. However, we might be in a multiline
+                     ;; comment.
+                     (string-comment-p (nth 8 ppss)))
+                (when (and (not (looking-at "\n"))
+                           (not (looking-at "#"))
+                           (not (looking-at "\""))
+                           (or (not string-comment-p) t))
+                  (setq insert-pos (point))
+                  (throw 'found nil)))))
           (insert line "\n"))))))
 
 (defun pyimport--get-alias (import-as symbol)
diff --git a/test/pyimport-test.el b/test/pyimport-test.el
@@ -160,6 +160,15 @@
      (equal (buffer-string)
             "from foo import x\n"))))
 
+(ert-deftest pyimport-insert-import-module-docstring ()
+  "Test inserting an import when the module starts with a docstring."
+  (with-temp-buffer
+    (insert "\"\"\"hello world.\n\n\"\"\"\n\nfrom bar import y")
+    (pyimport--insert-import "from foo import x")
+    (should
+     (equal (buffer-string)
+            "\"\"\"hello world.\n\n\"\"\"\n\nfrom foo import x\nfrom bar import y"))))
+
 (ert-deftest pyimport-extract-simple-import ()
   (should
    (equal
