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

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

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

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

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

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

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

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

@@ -4,12 +4,12 @@
 #include "parser.hpp"
 
 const std::map<std::string, ParameterKind> ParameterKinds = {
-    {"argument", ParameterKind::ARG},
-    {"positional only argument", ParameterKind::POS_ONLY},
-    {"keyword only argument", ParameterKind::KW_ONLY},
-    {"variadic argument", ParameterKind::VARIADIC_ARG},
-    {"keyword arguments", ParameterKind::KEYWORD_ARG},
-};
+            {"argument", ParameterKind::ARG},
+            {"positional only argument", ParameterKind::POS_ONLY},
+            {"keyword only argument", ParameterKind::KW_ONLY},
+            {"variadic argument", ParameterKind::VARIADIC_ARG},
+            {"keyword arguments", ParameterKind::KEYWORD_ARG},
+        };
 
 
 ParameterKind from_str(const std::string &kind) {
@@ -37,6 +37,24 @@ std::ostream &operator<<(std::ostream &out, ParameterKind const &obj) noexcept {
     return out;
 }
 
+std::string parameter_kind::to_str(const ParameterKind &kind) {
+    std::string name = "UNKNOWN";
+    switch (kind) {
+        case ParameterKind::ARG: name = "Argument";
+            break;
+        case ParameterKind::POS_ONLY: name = "Positional only argument";
+            break;
+        case ParameterKind::KW_ONLY: name = "Keyword only argument";
+            break;
+        case ParameterKind::VARIADIC_ARG: name = "Variadic arguments";
+            break;
+        case ParameterKind::KEYWORD_ARG: name = "Keyword arguments";
+            break;
+    }
+
+    return name;
+}
+
 void FunctionParameter::update_description(const std::string &descr, const DocstringFormatStyle &formatStyle) noexcept {
     switch (formatStyle) {
         case DocstringFormatStyle::reST:
@@ -61,7 +79,7 @@ void FunctionParameter::update_description(const std::string &descr) noexcept {
     auto start_pos = descr.find(kind_name);
 
     if (start_pos == std::string::npos)
-       start_pos = 0;
+        start_pos = 0;
     else {
         start_pos += kind_name.size() + 2;
     }
@@ -157,20 +175,29 @@ void FunctionDocstring::detect_format_style() noexcept {
     bool could_be_google = false;
     bool could_be_rest = false;
 
-    could_be_google = std::ranges::any_of(TypicalFormatStyle[1].second, [this](const auto &part) {
-        return docstring.find(part) != std::string::npos;
-    });
+    could_be_google = std::ranges::any_of(
+        TypicalFormatStyle[1].second,
+        [this](const auto &part) {
+            return docstring.find(part) != std::string::npos;
+        }
+    );
 
     // Numpy uses `Returns` as the keyword for the return value description and Google uses `Returns:` as the keyword for the return value description
     // so if it's not google, it could be numpy
     if (!could_be_google)
-        could_be_numpy = std::ranges::any_of(TypicalFormatStyle[0].second, [this](const auto &part) {
-            return docstring.find(part) != std::string::npos;
-        });
+        could_be_numpy = std::ranges::any_of(
+            TypicalFormatStyle[0].second,
+            [this](const auto &part) {
+                return docstring.find(part) != std::string::npos;
+            }
+        );
 
-    could_be_rest = std::ranges::any_of(TypicalFormatStyle[2].second, [this](const auto &part) {
-        return docstring.find(part) != std::string::npos;
-    });
+    could_be_rest = std::ranges::any_of(
+        TypicalFormatStyle[2].second,
+        [this](const auto &part) {
+            return docstring.find(part) != std::string::npos;
+        }
+    );
 
     const int total = could_be_numpy + could_be_google + could_be_rest;
 
@@ -194,23 +221,25 @@ void FunctionDocstring::detect_format_style() noexcept {
     if (!detected_format_style.has_value())
         return -1;
 
-    const auto get_end_pos = [](std::string& _docstring, StyleSections sections) {
+    const auto get_end_pos = [](std::string &_docstring, StyleSections sections) {
         std::vector<size_t> res;
-        std::ranges::for_each(sections, [&](const auto& line) {
+        std::ranges::for_each(
+            sections,
+            [&](const auto &line) {
                 res.emplace_back(_docstring.find(line));
-            });
+            }
+        );
         std::ranges::sort(res, std::less<>());
         return res[0];
     };
 
-    switch (*detected_format_style)
-    {
-    case DocstringFormatStyle::NUMPY:
-        return get_end_pos(docstring, TypicalFormatStyle[0].second);
-    case DocstringFormatStyle::GOOGLE:
-        return get_end_pos(docstring, TypicalFormatStyle[1].second);
-    case DocstringFormatStyle::reST:
-        return get_end_pos(docstring, TypicalFormatStyle[2].second);
+    switch (*detected_format_style) {
+        case DocstringFormatStyle::NUMPY:
+            return get_end_pos(docstring, TypicalFormatStyle[0].second);
+        case DocstringFormatStyle::GOOGLE:
+            return get_end_pos(docstring, TypicalFormatStyle[1].second);
+        case DocstringFormatStyle::reST:
+            return get_end_pos(docstring, TypicalFormatStyle[2].second);
     }
 
     return -1;

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

@@ -1,6 +1,7 @@
 #ifndef DOCSTRING_GENERATOR_EXT_FUNCTIONFORMAT_HPP
 #define DOCSTRING_GENERATOR_EXT_FUNCTIONFORMAT_HPP
 
+#include <format>
 #include <map>
 #include <set>
 #include <string>
@@ -33,6 +34,31 @@ constexpr std::array<std::pair<std::string_view, StyleSections>, 3> TypicalForma
 ParameterKind from_str(const std::string &kind);
 std::ostream &operator<<(std::ostream &out, ParameterKind const &obj) noexcept;
 
+namespace parameter_kind{
+    std::string to_str(const ParameterKind &kind);
+}
+
+template<>
+struct std::formatter<ParameterKind> : std::formatter<std::string_view> {
+    // Format the enum by mapping it to a string_view
+    auto format(ParameterKind kind, std::format_context &ctx) const {
+        std::string_view name = "UNKNOWN";
+        switch (kind) {
+            case ParameterKind::ARG: name = "Argument";
+                break;
+            case ParameterKind::POS_ONLY: name = "Positional only argument";
+                break;
+            case ParameterKind::KW_ONLY: name = "Keyword only argument";
+                break;
+            case ParameterKind::VARIADIC_ARG: name = "Variadic arguments";
+                break;
+            case ParameterKind::KEYWORD_ARG: name = "Keyword arguments";
+                break;
+        }
+        return std::formatter<std::string_view>::format(name, ctx);
+    }
+};
+
 struct FunctionParameter {
     std::string name;
     std::string default_value;

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

@@ -1,7 +1,3 @@
-//
-// Created by felix on 11.07.26.
-//
-
 #include "NumpyDocstring.hpp"
 
 #include "parser.hpp"

{docstring_generator_ext-2.0.3 → docstring_generator_ext-2.0.4}/src/parser.cpp

@@ -186,8 +186,8 @@ std::vector<FunctionParameter> generate_function_parameters(
             }
 
             std::string parameter_name = py::cast<std::string>(py::getattr(elem, "arg"));
-            if (parameter_name == "self") {
-                annotation_str = "object";
+            if (parameter_name == "self" || parameter_name == "cls") {
+                continue;
             }
 
             result.emplace_back(
@@ -364,7 +364,8 @@ void get_docstring_return_descr(FunctionInfo &functionInfo) noexcept {
         const auto end = functionInfo.docstring.docstring.find('\n', start);
         if (end != std::string::npos && start > 0) {
             functionInfo.returns.description = functionInfo.docstring.docstring.substr(start, end - start);
-            functionInfo.docstring.docstring.erase(start - 2, functionInfo.returns.description.size() + 3); // 3 = '>>' + '\n'
+            functionInfo.docstring.docstring.erase(start - 2, functionInfo.returns.description.size() + 3);
+            // 3 = '>>' + '\n'
         }
     }
 }

{docstring_generator_ext-2.0.3 → docstring_generator_ext-2.0.4}/src/parser.hpp

@@ -2,7 +2,6 @@
 #define DOCSTRING_GENERATOR_EXT_PARSER_HPP
 
 #include <memory>
-#include <set>
 #include <string>
 #include <vector>
 #include "FunctionFormat.hpp"