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

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

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

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

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

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

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

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

@@ -38,7 +38,7 @@ std::optional<std::string>  read_file(const std::string &file_path) {
     return file_content;
 }
 
-std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const DocstringFormatStyle &formatStyle) {
+std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const DocstringFormatStyle &formatStyle, const bool ignore_magic) {
     std::vector<FunctionInfo> infos{};
     py::module ast_module = py::module_::import("ast");
     const py::object generator_result = ast_module.attr("walk")(ast_module.attr("parse")(text));
@@ -49,7 +49,11 @@ std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const Doc
                 obj,
                 ast_module.attr("AsyncFunctionDef")
             )) {
-            FunctionInfo function_info = analyze_function(obj, ast_module);
+            const auto res = analyze_function(obj, ast_module, ignore_magic);
+            if (!res.has_value()) {
+                continue;
+            }
+            FunctionInfo function_info = *res;
             function_info.update_descriptions(formatStyle);
             infos.emplace_back(function_info);
             }
@@ -58,13 +62,13 @@ std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const Doc
     return infos;
 }
 
-void parse_file(const std::string &file_path, const DocstringFormatStyle &formatStyle, const bool &allow_overwrite) {
+void parse_file(const std::string &file_path, const DocstringFormatStyle &formatStyle, const bool &allow_overwrite, const bool &ignore_magic) {
     const auto result = read_file(file_path);
     if (!result.has_value()) {
         throw py::value_error(file_path + " is not a valid path.");
     }
 
-    std::vector<FunctionInfo> infos = createFunctionInfos(*result, formatStyle);
+    std::vector<FunctionInfo> infos = createFunctionInfos(*result, formatStyle, ignore_magic);
 
     std::ranges::sort(
         infos,
@@ -92,7 +96,7 @@ void parse_file(const std::string &file_path, const DocstringFormatStyle &format
 #endif
 }
 
-std::map<std::string, int> check_docstrings(std::string &file_path) {
+std::map<std::string, int> check_docstrings(std::string &file_path, const bool &ignore_magic) {
     int function_checked = 0;
     int complete_docstring = 0;
     int partial_docstring = 0;
@@ -109,7 +113,12 @@ std::map<std::string, int> check_docstrings(std::string &file_path) {
             )) {
             ++function_checked;
 
-            const FunctionInfo function_info = analyze_function(obj, ast_module);
+            const auto res = analyze_function(obj, ast_module, ignore_magic);
+            if (!res.has_value()) {
+                continue;
+            }
+
+            const FunctionInfo function_info = *res;
 
             switch (compare_docstrings(function_info.docstring, function_info)) {
                 case IS_EMPTY:
@@ -231,13 +240,15 @@ PYBIND11_MODULE(docstring_generator_ext, m) {
         py::arg("file_path"),
         py::arg("formatStyle"),
         py::arg("allow_overwrite") = false,
+        py::arg("ignore_magic") = false,
         "The file_path where automatically docstrings should be added.",
         "In which style should the Docstring be written."
     );
     m.def(
         "check_docstring",
         &check_docstrings,
-        py::arg("file_path")
+        py::arg("file_path"),
+        py::arg("ignore_magic") = false
     );
 
     py::enum_<DocstringFormatStyle>(m, "DocstringFormatStyle")

{docstring_generator_ext-2.0.6 → docstring_generator_ext-2.0.7}/src/docstringFormat.hpp

@@ -16,9 +16,9 @@ enum WriteResult {
 
 void get_docstring_arg_descr(FunctionInfo &functionInfo) noexcept;
 
-[[nodiscard]] std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const DocstringFormatStyle &formatStyle);
+[[nodiscard]] std::vector<FunctionInfo> createFunctionInfos(const std::string &text, const DocstringFormatStyle &formatStyle, bool ignore_magic = false);
 
-void parse_file(const std::string &file_path, const DocstringFormatStyle &formatStyle, const bool &allow_overwrite = false);
+void parse_file(const std::string &file_path, const DocstringFormatStyle &formatStyle, const bool &allow_overwrite = false, const bool &ignore_magic = false);
 
 /*
  * {
@@ -28,6 +28,6 @@ void parse_file(const std::string &file_path, const DocstringFormatStyle &format
  *    'no_docstrings': 0,
  * }
  */
-std::map<std::string, int> check_docstrings(std::string &file_path);
+std::map<std::string, int> check_docstrings(std::string &file_path, const bool &ignore_magic = false);
 
 #endif //DOCSTRING_GENERATOR_EXT_DOCSTRINGFORMAT_HPP

{docstring_generator_ext-2.0.6 → docstring_generator_ext-2.0.7}/src/parser.cpp

@@ -454,9 +454,10 @@ void get_exception(
     }
 }
 
-FunctionInfo analyze_function(
+std::optional<FunctionInfo> analyze_function(
     const pybind11::handle &obj,
-    py::module &ast_module
+    py::module &ast_module,
+    bool ignore_magic
 ) noexcept {
     std::vector<FunctionException> function_exceptions{};
 
@@ -468,6 +469,10 @@ FunctionInfo analyze_function(
     auto name = py::cast<std::string>(py::getattr(obj, "name"));
     auto offset = py::cast<uint32_t>(py::getattr(obj, "col_offset"));
 
+    if (ignore_magic && name.starts_with("__")) {
+        return std::nullopt;
+    }
+
     FunctionDocstring doc_str = get_docstring(py::reinterpret_borrow<py::object>(obj), ast_module);
     doc_str.detect_format_style();
 

{docstring_generator_ext-2.0.6 → docstring_generator_ext-2.0.7}/src/parser.hpp

@@ -47,9 +47,10 @@ void get_exception(
     const py::object &parent = py::none()
 ) noexcept;
 
-FunctionInfo analyze_function(
+[[nodiscard]] std::optional<FunctionInfo> analyze_function(
     const pybind11::handle &obj,
-    py::module &ast_module
+    py::module &ast_module,
+    bool ignore_magic
 ) noexcept;
 
 #endif //DOCSTRING_GENERATOR_EXT_PARSER_HPP