Merge pull request #655 from kkoomen/release/v4.6.3

v4.6.3

.version

@@ -1 +1 @@
-4.6.2
+4.6.3

helper/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vim-doge-helper"
-version = "4.6.2"
+version = "4.6.3"
 edition = "2021"
 publish = false
 include = ["src"]

helper/src/python/parser.rs

@@ -25,15 +25,23 @@ impl<'a> BaseParser for PythonParser<'a> {
     fn postprocess_line(&self, line: usize) -> usize {
         for node in traverse::PreOrder::new(self.tree.root_node().walk()) {
             if node.start_position().row + 1 == line {
-                // Find the body of the function,
-                // that's where the insert position is.
-                let body_node = node
+                // Find the body of the function, that's where the insert
+                // position should be, but rather finding the actual body, we
+                // find the colon after the return type, because there might be
+                // a docblock after the colon and before the body and we still
+                // want to insert before this.
+                //
+                // Example:
+                //      def foo() -> int:   <-- insert after here
+                //          # Comment       <-- considered separate from body
+                //          pass            <-- start of the body
+                let colon_node = node
                     .children(&mut node.walk())
-                    .filter(|node| node.kind() == "block")
+                    .filter(|node| node.kind() == ":")
                     .next();
 
-                if body_node.is_some() {
-                    return body_node.unwrap().prev_sibling().unwrap().start_position().row + 1;
+                if colon_node.is_some() {
+                    return colon_node.unwrap().start_position().row + 1;
                 }
             }
         }
@@ -78,7 +86,10 @@ impl<'a> PythonParser<'a> {
         for child_node in node.children(&mut node.walk()) {
             match child_node.kind() {
                 "type" => {
-                    tokens.insert("return_type".to_string(), Value::String(self.get_node_text(&child_node)));
+                    let value = Value::String(self.get_node_text(&child_node));
+                    if value != "None" {
+                        tokens.insert("return_type".to_string(), value);
+                    }
                 },
                 "parameters" => {
                     let mut params = Vec::new();

test/filetypes/python/functions.vader

@@ -2,17 +2,19 @@
 # Functions without parameters.
 # ==============================================================================
 Given python (function without parameters):
-  def myFunc(): # inline comment
+  def myFunc():
+    # inline comment
     pass
 
 Do (trigger doge):
   \<C-d>
 
 Expect python (no changes):
-  def myFunc(): # inline comment
+  def myFunc():
     """
     [TODO:description]
     """
+    # inline comment
     pass
 
 # ==============================================================================
@@ -57,14 +59,14 @@ Expect python (generated comment with :param tags):
 # Functions with parameters.
 # ==============================================================================
 Given python (function with parameters):
-  def myFunc(p1: str = 'string', p2: int = 5):
+  def myFunc(p1: str = 'string', p2: int = 5) -> None:
     pass
 
 Do (trigger doge):
   \<C-d>
 
 Expect python (generated comment with :param tags):
-  def myFunc(p1: str = 'string', p2: int = 5):
+  def myFunc(p1: str = 'string', p2: int = 5) -> None:
     """
     [TODO:description]