docstring-generator-ext 2.0.10.post1__tar.gz → 2.0.11__tar.gz

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring_generator_ext
-Version: 2.0.10.post1
+Version: 2.0.11
 Summary: Generate Docstrings with type-hint information.
 Author-email: FelixTheC <fberndt87@gmail.com>
 Classifier: Environment :: Console

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/docstring_generator_ext.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring_generator_ext
-Version: 2.0.10.post1
+Version: 2.0.11
 Summary: Generate Docstrings with type-hint information.
 Author-email: FelixTheC <fberndt87@gmail.com>
 Classifier: Environment :: Console

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring_generator_ext"
-version = "2.0.10.post1"
+version = "2.0.11"
 description = "Generate Docstrings with type-hint information."
 authors = [
     { name = "FelixTheC", email = "fberndt87@gmail.com" },

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/src/FunctionFormat.cpp

@@ -133,6 +133,10 @@ void FunctionParameter::update_rest_description(const std::string &descr) noexce
         return docstring.start_line;
     }
 
+    if (body_start > 0) {
+        return static_cast<int>(body_start);
+    }
+
     if (returns.line_no > 0) {
         return static_cast<int>(returns.line_no + 1);
     }

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/src/FunctionFormat.hpp

@@ -106,6 +106,7 @@ struct FunctionException {
 struct FunctionInfo {
     std::vector<FunctionParameter> args{};
     uint32_t offset{};
+    uint64_t body_start{};
     FunctionDocstring docstring;
     FunctionReturn returns;
     std::set<FunctionException> exceptions {};

{docstring_generator_ext-2.0.10.post1 → docstring_generator_ext-2.0.11}/src/parser.cpp

@@ -306,39 +306,51 @@ void get_docstring_arg_descr(FunctionInfo &functionInfo) noexcept {
     }
 
     auto start = functionInfo.docstring.docstring.find('$');
-    if (start < std::string::npos) {
-        auto end = functionInfo.docstring.docstring.find('\n', start + 1);
-        std::string description;
-
-        if (end >= std::string::npos) {
+    if (start != std::string::npos) {
+        // we need to check if this is a an expected placeholder
+        const auto end_placeholder = functionInfo.docstring.docstring.find(' ', start + 1);
+        const auto possible_placeholder_num = functionInfo.docstring.docstring.substr(start + 1, end_placeholder - start - 1);
+
+        if (possible_placeholder_num.empty() ||
+            !std::all_of(possible_placeholder_num.begin(), possible_placeholder_num.end(),
+                         [](unsigned char c) { return std::isdigit(c); })) {
             return;
         }
 
+        int id = -1;
         try {
-            description = functionInfo.docstring.docstring.substr(start, end - start);
-        } catch (std::out_of_range &) {
+            id = std::stoi(possible_placeholder_num);
+        } catch (const std::exception &) {
             return;
         }
 
-        auto end_id = description.find(' ');
-        if (end_id == std::string::npos)
+        if (id < 0)
+            return;
+
+        auto end = functionInfo.docstring.docstring.find('\n', end_placeholder + 1);
+        if (end == std::string::npos) {
             return;
+        }
 
-        int id = std::stoi(description.substr(1, end_id)) - 1;
+        std::string description;
+        description.reserve(end - start);
 
-        if (static_cast<size_t>(id) < functionInfo.args.size()) {
+        try {
+            description = functionInfo.docstring.docstring.substr(end_placeholder + 1, end - end_placeholder - 1);
+        } catch (std::out_of_range &) {
+            return;
+        }
+
+        if (static_cast<size_t>(id - 1) < functionInfo.args.size()) {
             try {
-                functionInfo.args[id].description = description.substr(end_id);
+                functionInfo.args[id - 1].description = description;
             } catch (std::out_of_range &) {
                 return;
             }
 
-            auto reduce = functionInfo.offset > 0 ? 2 * functionInfo.offset + 2 : 4 + 2;
-
             try {
                 functionInfo.docstring.docstring.erase(
-                    start - reduce,
-                    end - start + reduce
+                    start, description.size() + possible_placeholder_num.size() + 3
                 );
             } catch (std::out_of_range &) {
                 // no further action needed
@@ -461,8 +473,15 @@ std::optional<FunctionInfo> analyze_function(
 ) noexcept {
     std::vector<FunctionException> function_exceptions{};
 
+    uint64_t body_start = 0;
     if (py::hasattr(obj, "body")) {
         auto inner = py::getattr(obj, "body");
+        for (auto &elem: py::iter(inner)) {
+            if (py::hasattr(elem, "lineno")) {
+                body_start = py::cast<int>(py::getattr(elem, "lineno"));
+                break;
+            }
+        }
         get_exception(inner, ast_module, function_exceptions);
     }
 
@@ -479,7 +498,7 @@ std::optional<FunctionInfo> analyze_function(
     auto returns = py::getattr(obj, "returns");
 
     std::string return_str{};
-    uint32_t return_end_line_no = 0;
+    uint32_t return_end_line_no = body_start;
 
     if (!returns.is_none()) {
         return_str = parse_ast_obj(returns, ast_module);
@@ -498,6 +517,7 @@ std::optional<FunctionInfo> analyze_function(
     FunctionInfo functionInfo{
                 .args = f_args,
                 .offset = offset,
+                .body_start = body_start,
                 .docstring = doc_str,
                 .returns = functionReturn,
                 .exceptions = {}