use Eldev and test.

Author: douglasdavis

.github/workflows/ci.yml

@@ -4,6 +4,9 @@ on:
   push:
     paths-ignore:
     - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
 
 jobs:
   build:
@@ -19,10 +22,17 @@ jobs:
           - snapshot
 
     steps:
-    - uses: purcell/setup-emacs@master
+    - name: Setup GNU Emacs
+      uses: purcell/setup-emacs@master
       with:
         version: ${{ matrix.emacs_version }}
 
-    - uses: actions/checkout@v2
-    - name: Byte compile
-      run: make
+    - name: Install Eldev
+      run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Test
+      run: |
+        eldev -p -dtT test

Eldev

@@ -0,0 +1,6 @@
+; -*- mode: emacs-lisp; lexical-binding: t; no-byte-compile: t -*-
+
+;; Autodetermined by `eldev init'.
+(eldev-use-package-archive 'melpa)
+
+(eldev-use-plugin 'autoloads)

Makefile

@@ -153,16 +153,23 @@ The argument takes on one of four possible styles:
                (setq cursor i)))))
     (setq strs (append strs (list (substring fnargs (1+ cursor)))))))
 
-(defun numpydoc--parse-def ()
-  "Parse a Python function definition; return instance of numpydoc--def."
+
+(defun numpydoc--extract-def ()
+  "Extract function definition string from the buffer.
+This function expects the cursor to be in the function body."
+  (save-excursion
+    (buffer-substring-no-properties
+     (progn
+       (python-nav-beginning-of-defun)
+       (point))
+     (progn
+       (python-nav-end-of-statement)
+       (point)))))
+
+(defun numpydoc--parse-def (buffer-substr)
+  "Parse the BUFFER-SUBSTR; return instance of numpydoc--def."
   (save-excursion
-    (let* ((fnsig (buffer-substring-no-properties
-                   (progn
-                     (python-nav-beginning-of-defun)
-                     (point))
-                   (progn
-                     (python-nav-end-of-statement)
-                     (point))))
+    (let* ((fnsig buffer-substr)
            ;; trimmed string of the function signature
            (trimmed (s-collapse-whitespace fnsig))
            ;; split into parts (args and return type)
@@ -357,7 +364,8 @@ MODES is the list of modes where the function is interactive in
 (defun numpydoc-generate ()
   "Generate NumPy style docstring for Python function."
   (numpydoc--interactive nil python-mode)
-  (let ((good-to-go t))
+  (let ((good-to-go t)
+        (fnsig (numpydoc--extract-def)))
     (when (numpydoc--has-existing-docstring-p)
       (if (y-or-n-p "Docstring exists; destroy and start new? ")
           (numpydoc--delete-existing)
@@ -366,7 +374,7 @@ MODES is the list of modes where the function is interactive in
       (python-nav-beginning-of-defun)
       (python-nav-end-of-statement)
       (numpydoc--insert-docstring (numpydoc--detect-indent)
-                                  (numpydoc--parse-def)))))
+                                  (numpydoc--parse-def fnsig)))))
 
 (provide 'numpydoc)
 ;;; numpydoc.el ends here

numpydoc.el

@@ -0,0 +1,30 @@
+(require 'buttercup)
+(require 'numpydoc)
+
+(defvar fsig1
+  "def f(a: int, b: float = 5.5, c: Optional[Union[str, int]] = None) -> float:")
+
+(defvar fsig2 "def f(x, y=5, z=None):")
+
+(describe "Arg check"
+  (it "Checks arg parsing 1"
+    (let ((manual-a (make-numpydoc--arg :name "a" :type "int" :defval nil))
+          (manual-b (make-numpydoc--arg :name "b" :type "float" :defval "5.5"))
+          (manual-c (make-numpydoc--arg :name "c"
+                                        :type "Optional[Union[str, int]]"
+                                        :defval "None"))
+          (parsed (numpydoc--parse-def fsig1)))
+      (expect manual-a :to-equal (car (numpydoc--def-args parsed)))
+      (expect manual-b :to-equal (nth 1 (numpydoc--def-args parsed)))
+      (expect manual-c :to-equal (nth 2 (numpydoc--def-args parsed)))
+      (expect "float" :to-equal (numpydoc--def-rtype parsed))))
+
+  (it "Checks arg parsing 2"
+    (let ((manual-x (make-numpydoc--arg :name "x" :type nil :defval nil))
+          (manual-y (make-numpydoc--arg :name "y" :type nil :defval "5"))
+          (manual-z (make-numpydoc--arg :name "z" :type nil :defval "None"))
+          (parsed (numpydoc--parse-def fsig2)))
+      (expect manual-x :to-equal (car (numpydoc--def-args parsed)))
+      (expect manual-y :to-equal (nth 1 (numpydoc--def-args parsed)))
+      (expect manual-z :to-equal (nth 2 (numpydoc--def-args parsed)))
+      (expect (numpydoc--def-rtype parsed) :to-be nil))))