Merge pull request #6 from jferguson-gnubio/python_arg_docstring

Automatic arguments to Python def docstrings

Author: AndreaCrotti

python-mode/.yas-setup.el

@@ -0,0 +1,17 @@
+(defun python-split-args (arg-string)
+  "Split a python argument string into ((name, default)..) tuples"
+  (mapcar '(lambda (x)
+             (split-string x "[[:blank:]]*=[[:blank:]]*" t))
+          (split-string arg-string "[[:blank:]]*,[[:blank:]]*" t)))
+
+(defun python-args-to-docstring ()
+  "return docstring format for the python arguments in yas-text"
+  (let* ((indent (concat "\n" (make-string (current-column) 32)))
+         (args (mapconcat
+                '(lambda (x)
+                   (concat (nth 0 x) " -- "
+                           (if (nth 1 x) (concat "\(default " (nth 1 x) "\)"))))
+                (python-split-args yas-text)
+                indent)))
+    (unless (string= args "")
+      (mapconcat 'identity (list "Keyword Arguments:" args) indent))))

python-mode/function_docstring

@@ -0,0 +1,10 @@
+# -*- mode: snippet -*-
+# name: function_docstring
+# key: fd
+# group: definitions
+# --
+def ${1:name}($2):
+    \"\"\"$3
+    ${2:$(python-args-to-docstring)}
+    \"\"\"
+    $0

python-mode/init_docstring

@@ -0,0 +1,10 @@
+# -*- mode: snippet -*-
+# name: init_docstring
+# key: id
+# group : definitions
+# --
+def __init__(self$1):
+    \"\"\"$2
+    ${1:$(python-args-to-docstring)}
+    \"\"\"
+    $0

python-mode/method_docstring

@@ -0,0 +1,10 @@
+# -*- mode: snippet -*-
+# name: method_docstring
+# key: md
+# group: object oriented
+# --
+def ${1:name}(self$2):
+    \"\"\"$3
+    ${2:$(python-args-to-docstring)}
+    \"\"\"
+    $0