docstring-generator-ext 2.0.4__tar.gz → 2.0.6__tar.gz

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/PKG-INFO

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

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/docstring_generator_ext.egg-info/PKG-INFO

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

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/pyproject.toml

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

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/FunctionFormat.cpp

@@ -1,6 +1,8 @@
 #include "FunctionFormat.hpp"
 
 #include <map>
+#include <ranges>
+
 #include "parser.hpp"
 
 const std::map<std::string, ParameterKind> ParameterKinds = {
@@ -221,27 +223,62 @@ void FunctionDocstring::detect_format_style() noexcept {
     if (!detected_format_style.has_value())
         return -1;
 
-    const auto get_end_pos = [](std::string &_docstring, StyleSections sections) {
-        std::vector<size_t> res;
+    std::vector<std::string> lines;
+    lines.reserve(256);
+
+    for (const auto&line : std::views::split(docstring, '\n') | std::views::transform([](const auto &obj){ return std::string(obj.begin(), obj.end()); })) {
+        lines.emplace_back(remove_whitespace(line));
+    }
+
+    const auto get_end_pos = [](std::vector<std::string> &_lines, StyleSections sections) {
+        std::vector<int> res;
         std::ranges::for_each(
             sections,
             [&](const auto &line) {
-                res.emplace_back(_docstring.find(line));
+                int idx = 0;
+                for (const auto &obj: _lines) {
+                   if (obj.find(line) != std::string::npos) {
+                       res.emplace_back(idx);
+                   }
+                   idx++;
+                }
             }
         );
         std::ranges::sort(res, std::less<>());
+        if (res.empty())
+            return -1;
         return res[0];
     };
 
+    int end_pos{};
     switch (*detected_format_style) {
         case DocstringFormatStyle::NUMPY:
-            return get_end_pos(docstring, TypicalFormatStyle[0].second);
+            end_pos = get_end_pos(lines, TypicalSectionStyle[0].second);
+            break;
         case DocstringFormatStyle::GOOGLE:
-            return get_end_pos(docstring, TypicalFormatStyle[1].second);
+            end_pos = get_end_pos(lines, TypicalSectionStyle[1].second);
+            break;
         case DocstringFormatStyle::reST:
-            return get_end_pos(docstring, TypicalFormatStyle[2].second);
+            end_pos = get_end_pos(lines, TypicalSectionStyle[2].second);
+            break;
     }
 
+    if (end_pos == -1 || static_cast<size_t>(end_pos) > lines.size())
+        return -1;
+
+    std::string tmp = "";
+    lines.clear();
+    for (const auto&line : std::views::split(docstring, '\n') | std::views::transform([](const auto &obj){ return std::string(obj.begin(), obj.end()); })) {
+        lines.emplace_back(line);
+    }
+    for (int idx = 0; idx < end_pos; idx++) {
+        tmp += lines[idx];
+        if (idx + 1 < end_pos)
+            tmp += "\n";
+    }
+
+    docstring = tmp;
+
     return -1;
 }
 

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/FunctionFormat.hpp

@@ -31,6 +31,12 @@ constexpr std::array<std::pair<std::string_view, StyleSections>, 3> TypicalForma
     {"rest",   {":param", ":returns:", ":raises"}}
 }};
 
+constexpr std::array<std::pair<std::string_view, StyleSections>, 3> TypicalSectionStyle = {{
+    {"numpy",  {"Parameters", "Returns", "Raises"}},
+    {"google", {"Args:", "Returns:", "Raises:"}},
+    {"rest",   {":param", ":returns:", ":raises"}}
+}};
+
 ParameterKind from_str(const std::string &kind);
 std::ostream &operator<<(std::ostream &out, ParameterKind const &obj) noexcept;
 

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/GoogleDocstring.cpp

@@ -26,6 +26,8 @@ std::string GoogleDocstring::cleanArgsDescription(const std::string &arg, const
 
     if (const auto startPos = res.find(arg); startPos < std::string::npos) {
         const auto pos = startPos + arg.size() + 1;
+        if (pos > res.size())
+            return res;
         res = res.substr(pos, res.size() - pos);
     }
 

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/NumpyDocstring.cpp

@@ -24,6 +24,9 @@ std::string NumpyDocstring::docstringArgs() noexcept {
         docstream << "\n";
     }
 
+    if (functionInfo.args.empty())
+        return "";
+
     docstream << current_py_tab << "Parameters\n";
     docstream << current_py_tab << "----------\n";
     std::ranges::for_each(

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/docComparator.cpp

@@ -13,7 +13,10 @@ DocstringComparisonResult compare_docstrings(
     bool return_information_visible = false;
     bool exception_information_visible = false;
 
-    size_t last_pos = 0;
+    if (function_info.returns.type == "None" || function_info.returns.line_no == 0)
+        return_information_visible = true;
+
+    size_t last_pos = current_docstring.end_line - current_docstring.start_line;
 
     // check function arguments from FunctionInfo
     function_arguments_visible = std::ranges::all_of(
@@ -29,11 +32,17 @@ DocstringComparisonResult compare_docstrings(
                     last_pos = pos + arg.name.size();
             }
 
-            if (!arg.type.empty())
-                match &= current_docstring.docstring.find(arg.type, last_pos) != std::string::npos;
+            if (!arg.type.empty()) {
+                const auto pos = current_docstring.docstring.find(arg.type, last_pos);
+                match &= pos != std::string::npos;
+                if (pos != std::string::npos)
+                    last_pos = pos + arg.type.size();
+            }
 
-            if (!arg.default_value.empty())
+            if (!arg.default_value.empty()) {
                 match &= current_docstring.docstring.find(arg.default_value, last_pos) != std::string::npos;
+                last_pos += arg.default_value.size();
+            }
 
             if (!arg.description.empty()) {
                 const auto pos = current_docstring.docstring.find(arg.description, last_pos);
@@ -51,14 +60,9 @@ DocstringComparisonResult compare_docstrings(
         bool match = false;
         if (!function_info.returns.type.empty()) {
             const auto pos = current_docstring.docstring.find(function_info.returns.type, last_pos);
+            match = pos != std::string::npos;
             if (pos != std::string::npos) {
-                auto end_pos = current_docstring.docstring.find('\n', pos);
-                if (end_pos == std::string::npos)
-                    end_pos = current_docstring.docstring.size();
-                const auto tmp = current_docstring.docstring.substr(pos, end_pos);
-                last_pos = end_pos;
-                if (tmp.size() == function_info.returns.type.size())
-                    match = true;
+                last_pos = pos + function_info.returns.type.size() + function_info.returns.description.size();
             }
         }
 
@@ -70,12 +74,12 @@ DocstringComparisonResult compare_docstrings(
     // check exception information from FunctionInfo
     exception_information_visible = std::ranges::all_of(
         function_info.exceptions,
-        [&current_docstring](const auto &exception) {
+        [&last_pos, &current_docstring](const auto &exception) {
             bool match = false;
             if (!exception.name.empty())
-                match = current_docstring.docstring.find(exception.name) != std::string::npos;
+                match = current_docstring.docstring.find(exception.name, last_pos) != std::string::npos;
             if (!exception.description.empty())
-                match &= current_docstring.docstring.find(exception.description) != std::string::npos;
+                match &= current_docstring.docstring.find(exception.description, last_pos) != std::string::npos;
             return match;
         }
     );

{docstring_generator_ext-2.0.4 → docstring_generator_ext-2.0.6}/src/docstringFormat.cpp

@@ -170,8 +170,7 @@ std::map<std::string, int> check_docstrings(std::string &file_path) {
             }
             if (allow_overwrite && *val.docstring.detected_format_style != formatStyle) {
                 const auto pos = val.docstring.remove_old_format_style();
-                if (pos >= 0)
-                    start_pos = pos;
+                if (pos >= 0) {}
             }
         }