docstring-generator-ext 0.0.26__tar.gz → 0.0.28__tar.gz

docstring_generator_ext-0.0.28/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: docstring_generator_ext
+Version: 0.0.28
+Summary: Generate Docstrings with type-hint information
+Home-page: https://github.com/FelixTheC/docstring_generator
+Author: FelixTheC
+Author-email: fberndt87@gmail.com
+License: MIT
+Description: #### Versioning
+        - For the versions available, see the tags on this repository.
+        
+        ### Authors
+        - Felix Eisenmenger
+        
+        ### License
+        - This project is licensed under the MIT License - see the LICENSE.md file for details
+        
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Typing :: Typed
+Requires-Python: <=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: test

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: docstring-generator-ext
+Version: 0.0.28
+Summary: Generate Docstrings with type-hint information
+Home-page: https://github.com/FelixTheC/docstring_generator
+Author: FelixTheC
+Author-email: fberndt87@gmail.com
+License: MIT
+Description: #### Versioning
+        - For the versions available, see the tags on this repository.
+        
+        ### Authors
+        - Felix Eisenmenger
+        
+        ### License
+        - This project is licensed under the MIT License - see the LICENSE.md file for details
+        
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Typing :: Typed
+Requires-Python: <=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: test

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+setup.py
+docstring_generator_ext.egg-info/PKG-INFO
+docstring_generator_ext.egg-info/SOURCES.txt
+docstring_generator_ext.egg-info/dependency_links.txt
+docstring_generator_ext.egg-info/not-zip-safe
+docstring_generator_ext.egg-info/requires.txt
+docstring_generator_ext.egg-info/top_level.txt
+src/docstringFormat.cpp
+src/docstringFormat.hpp

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[test]
+pytest

docstring_generator_ext-0.0.28/docstring_generator_ext.egg-info/top_level.txt

@@ -0,0 +1 @@
+docstring_generator_ext

{docstring_generator_ext-0.0.26 → docstring_generator_ext-0.0.28}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docstring_generator_ext"
-version = "0.0.26"
+version = "0.0.27"
 description = "Auto generate docstring from type-hints."
 authors = ["FelixTheC <felixeisenmenger@gmx.net>"]
 readme = "README.md"
@@ -11,6 +11,7 @@ classifiers=[
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Topic :: Utilities",
@@ -19,9 +20,9 @@ classifiers=[
 ]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.8"
 pybind11 = "^2.8"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+requires = ["setuptools>=42", "wheel", "pybind11~=2.6.1"]
+build-backend = "setuptools.build_meta"

docstring_generator_ext-0.0.28/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

docstring_generator_ext-0.0.28/setup.py

@@ -0,0 +1,64 @@
+# Available at setup time due to pyproject.toml
+import pathlib
+from glob import glob
+
+from pybind11.setup_helpers import Pybind11Extension, build_ext
+from setuptools import find_packages, setup
+
+__version__ = "0.0.28"
+
+HERE = pathlib.Path(__file__).parent
+README = (HERE / "README.md").read_text()
+
+# The main interface is through Pybind11Extension.
+# * You can add cxx_std=11/14/17, and then build_ext can be removed.
+# * You can set include_pybind11=false to add the include directory yourself,
+#   say from a submodule.
+#
+# Note:
+#   Sort input source files if you glob sources to ensure bit-for-bit
+#   reproducible builds (https://github.com/pybind/python_example/pull/53)
+
+
+class CustomBuildExt(build_ext):
+    def run(self):
+        # Include additional header file directories
+        self.include_dirs.append('src/docstringFormat.hpp')
+        super().run()
+
+
+ext_modules = [
+    Pybind11Extension(
+        "docstring_generator_ext",
+        [
+            "src/docstringFormat.cpp",
+        ],
+    ),
+]
+
+setup(
+    name="docstring_generator_ext",
+    version=__version__,
+    url="https://github.com/FelixTheC/docstring_generator",
+    license="MIT",
+    author="FelixTheC",
+    author_email="fberndt87@gmail.com",
+    description="Generate Docstrings with type-hint information",
+    long_description=README,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Topic :: Utilities",
+        "Topic :: Software Development :: Documentation",
+        "Typing :: Typed",
+    ],
+    ext_modules=ext_modules,
+    extras_require={"test": "pytest"},
+    # Currently, build_ext only provides an optional "highest supported C++
+    # level" feature, but in the future it may provide more features.
+    cmdclass={"build_ext": CustomBuildExt},
+    zip_safe=False,
+    python_requires="<=3.11",
+)

{docstring_generator_ext-0.0.26 → docstring_generator_ext-0.0.28}/src/docstringFormat.hpp

@@ -226,7 +226,7 @@ struct FunctionInfo
     
     void update_descriptions(DocstringFormatStyle &formatStyle)
     {
-        for (int idx = 0; idx < args.size(); ++idx)
+        for (size_t idx = 0; idx < args.size(); ++idx)
         {
             size_t start_pos;
             

docstring_generator_ext-0.0.26/PKG-INFO

@@ -1,34 +0,0 @@
-Metadata-Version: 2.1
-Name: docstring-generator-ext
-Version: 0.0.26
-Summary: Auto generate docstring from type-hints.
-Home-page: https://github.com/FelixTheC/docstring_generator
-License: MIT
-Author: FelixTheC
-Author-email: felixeisenmenger@gmx.net
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Utilities
-Classifier: Typing :: Typed
-Requires-Dist: pybind11 (>=2.8,<3.0)
-Project-URL: Repository, https://github.com/FelixTheC/docstring_generator
-Description-Content-Type: text/markdown
-
-#### Versioning
-- For the versions available, see the tags on this repository.
-
-### Authors
-- Felix Eisenmenger
-
-### License
-- This project is licensed under the MIT License - see the LICENSE.md file for details
-

docstring_generator_ext-0.0.26/src/CMakeLists.txt

@@ -1,53 +0,0 @@
-cmake_minimum_required(VERSION 3.24)
-project(src VERSION 1.0 LANGUAGES CXX)
-
-if ("$ENV{TESTING}")
-    enable_testing()
-
-    include(FetchContent)
-    FetchContent_Declare(
-            googletest
-            URL https://github.com/google/googletest/archive/refs/tags/release-1.12.1.zip
-    )
-
-    FetchContent_MakeAvailable(googletest)
-    include_directories(${GTEST_INCLUDE_DIRS})
-
-    add_executable(src main.cpp)
-    target_link_libraries(src gtest_main)
-
-    include(GoogleTest)
-
-else ()
-    find_package(Python 3.10 COMPONENTS Interpreter Development REQUIRED)
-    add_subdirectory(extern/pybind11)
-
-    add_executable(src main.cpp docstringFormat.hpp)
-    pybind11_add_module(src example.cpp)
-
-    target_link_libraries(src PRIVATE pybind11::module pybind11::lto pybind11::windows_extras)
-endif ()
-
-
-if ("$ENV{GCC}")
-    target_compile_options(src PRIVATE
-            -Wall
-            -Wextra
-            -Werror
-            -Wpedantic
-            -Wshadow
-            -Wnon-virtual-dtor
-            -Wold-style-cast
-            -Wcast-align
-            -Wfloat-conversion
-            -fno-omit-frame-pointer
-            -fsanitize=address
-            )
-    target_link_options(src PRIVATE -fsanitize=address)
-endif ()
-
-target_compile_features(src PUBLIC cxx_std_20)
-set_target_properties(src PROPERTIES
-        CXX_STANDARD 20
-        CXX_STANDARD_REQUIRED YES
-        CXX_EXTENSIONS NO)

docstring_generator_ext-0.0.26/src/extern/pybind11/.appveyor.yml

@@ -1,35 +0,0 @@
-version: 1.0.{build}
-image:
-- Visual Studio 2017
-test: off
-skip_branch_with_pr: true
-build:
-  parallel: true
-platform:
-- x86
-environment:
-  matrix:
-  - PYTHON: 36
-    CONFIG: Debug
-install:
-- ps: |
-    $env:CMAKE_GENERATOR = "Visual Studio 15 2017"
-    if ($env:PLATFORM -eq "x64") { $env:PYTHON = "$env:PYTHON-x64" }
-    $env:PATH = "C:\Python$env:PYTHON\;C:\Python$env:PYTHON\Scripts\;$env:PATH"
-    python -W ignore -m pip install --upgrade pip wheel
-    python -W ignore -m pip install pytest numpy --no-warn-script-location pytest-timeout
-- ps: |
-    Start-FileDownload 'https://gitlab.com/libeigen/eigen/-/archive/3.3.7/eigen-3.3.7.zip'
-    7z x eigen-3.3.7.zip -y > $null
-    $env:CMAKE_INCLUDE_PATH = "eigen-3.3.7;$env:CMAKE_INCLUDE_PATH"
-build_script:
-- cmake -G "%CMAKE_GENERATOR%" -A "%CMAKE_ARCH%"
-    -DCMAKE_CXX_STANDARD=14
-    -DPYBIND11_WERROR=ON
-    -DDOWNLOAD_CATCH=ON
-    -DCMAKE_SUPPRESS_REGENERATION=1
-    .
-- set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
-- cmake --build . --config %CONFIG% --target pytest -- /m /v:m /logger:%MSBuildLogger%
-- cmake --build . --config %CONFIG% --target cpptest -- /m /v:m /logger:%MSBuildLogger%
-on_failure: if exist "tests\test_cmake_build" type tests\test_cmake_build\*.log*

docstring_generator_ext-0.0.26/src/extern/pybind11/.clang-format

@@ -1,38 +0,0 @@
----
-# See all possible options and defaults with:
-# clang-format --style=llvm --dump-config
-BasedOnStyle: LLVM
-AccessModifierOffset: -4
-AllowShortLambdasOnASingleLine: true
-AlwaysBreakTemplateDeclarations: Yes
-BinPackArguments: false
-BinPackParameters: false
-BreakBeforeBinaryOperators: All
-BreakConstructorInitializers: BeforeColon
-ColumnLimit: 99
-CommentPragmas: 'NOLINT:.*|^ IWYU pragma:'
-IncludeBlocks: Regroup
-IndentCaseLabels: true
-IndentPPDirectives: AfterHash
-IndentWidth: 4
-Language: Cpp
-SpaceAfterCStyleCast: true
-Standard: Cpp11
-StatementMacros: ['PyObject_HEAD']
-TabWidth: 4
-IncludeCategories:
-  - Regex:           '<pybind11/.*'
-    Priority:        -1
-  - Regex:           'pybind11.h"$'
-    Priority:        1
-  - Regex:           '^".*/?detail/'
-    Priority:        1
-    SortPriority:    2
-  - Regex:           '^"'
-    Priority:        1
-    SortPriority:    3
-  - Regex:           '<[[:alnum:]._]+>'
-    Priority:        4
-  - Regex:           '.*'
-    Priority:        5
-...

docstring_generator_ext-0.0.26/src/extern/pybind11/.clang-tidy

@@ -1,77 +0,0 @@
-FormatStyle: file
-
-Checks: |
-  *bugprone*,
-  *performance*,
-  clang-analyzer-optin.cplusplus.VirtualCall,
-  clang-analyzer-optin.performance.Padding,
-  cppcoreguidelines-init-variables,
-  cppcoreguidelines-prefer-member-initializer,
-  cppcoreguidelines-pro-type-static-cast-downcast,
-  cppcoreguidelines-slicing,
-  google-explicit-constructor,
-  llvm-namespace-comment,
-  misc-definitions-in-headers,
-  misc-misplaced-const,
-  misc-non-copyable-objects,
-  misc-static-assert,
-  misc-throw-by-value-catch-by-reference,
-  misc-uniqueptr-reset-release,
-  misc-unused-parameters,
-  modernize-avoid-bind,
-  modernize-loop-convert,
-  modernize-make-shared,
-  modernize-redundant-void-arg,
-  modernize-replace-auto-ptr,
-  modernize-replace-disallow-copy-and-assign-macro,
-  modernize-replace-random-shuffle,
-  modernize-shrink-to-fit,
-  modernize-use-auto,
-  modernize-use-bool-literals,
-  modernize-use-default-member-init,
-  modernize-use-emplace,
-  modernize-use-equals-default,
-  modernize-use-equals-delete,
-  modernize-use-noexcept,
-  modernize-use-nullptr,
-  modernize-use-override,
-  modernize-use-using,
-  readability-avoid-const-params-in-decls,
-  readability-braces-around-statements,
-  readability-const-return-type,
-  readability-container-size-empty,
-  readability-delete-null-pointer,
-  readability-else-after-return,
-  readability-implicit-bool-conversion,
-  readability-inconsistent-declaration-parameter-name,
-  readability-make-member-function-const,
-  readability-misplaced-array-index,
-  readability-non-const-parameter,
-  readability-qualified-auto,
-  readability-redundant-function-ptr-dereference,
-  readability-redundant-smartptr-get,
-  readability-redundant-string-cstr,
-  readability-simplify-subscript-expr,
-  readability-static-accessed-through-instance,
-  readability-static-definition-in-anonymous-namespace,
-  readability-string-compare,
-  readability-suspicious-call-argument,
-  readability-uniqueptr-delete-release,
-  -bugprone-easily-swappable-parameters,
-  -bugprone-exception-escape,
-  -bugprone-reserved-identifier,
-  -bugprone-unused-raii,
-
-CheckOptions:
-- key:             modernize-use-equals-default.IgnoreMacros
-  value:           false
-- key:             performance-for-range-copy.WarnOnAllAutoCopies
-  value:           true
-- key:             performance-inefficient-string-concatenation.StrictMode
-  value:           true
-- key:             performance-unnecessary-value-param.AllowedTypes
-  value:           'exception_ptr$;'
-- key:             readability-implicit-bool-conversion.AllowPointerConditions
-  value:           true
-
-HeaderFilterRegex: 'pybind11/.*h'

docstring_generator_ext-0.0.26/src/extern/pybind11/.cmake-format.yaml

@@ -1,73 +0,0 @@
-parse:
-  additional_commands:
-    pybind11_add_module:
-      flags:
-        - THIN_LTO
-        - MODULE
-        - SHARED
-        - NO_EXTRAS
-        - EXCLUDE_FROM_ALL
-        - SYSTEM
-
-format:
-  line_width: 99
-  tab_size: 2
-
-  # If an argument group contains more than this many sub-groups
-  # (parg or kwarg groups) then force it to a vertical layout.
-  max_subgroups_hwrap: 2
-
-  # If a positional argument group contains more than this many
-  # arguments, then force it to a vertical layout.
-  max_pargs_hwrap: 6
-
-  # If a cmdline positional group consumes more than this many
-  # lines without nesting, then invalidate the layout (and nest)
-  max_rows_cmdline: 2
-  separate_ctrl_name_with_space: false
-  separate_fn_name_with_space: false
-  dangle_parens: false
-
-  # If the trailing parenthesis must be 'dangled' on its on
-  # 'line, then align it to this reference: `prefix`: the start'
-  # 'of the statement,  `prefix-indent`: the start of the'
-  # 'statement, plus one indentation  level, `child`: align to'
-  # the column of the arguments
-  dangle_align: prefix
-  # If the statement spelling length (including space and
-  # parenthesis) is smaller than this amount, then force reject
-  # nested layouts.
-  min_prefix_chars: 4
-
-  # If the statement spelling length (including space and
-  # parenthesis) is larger than the tab width by more than this
-  # amount, then force reject un-nested layouts.
-  max_prefix_chars: 10
-
-  # If a candidate layout is wrapped horizontally but it exceeds
-  # this many lines, then reject the layout.
-  max_lines_hwrap: 2
-
-  line_ending: unix
-
-  # Format command names consistently as 'lower' or 'upper' case
-  command_case: canonical
-
-  # Format keywords consistently as 'lower' or 'upper' case
-  # unchanged is valid too
-  keyword_case: 'upper'
-
-  # A list of command names which should always be wrapped
-  always_wrap: []
-
-  # If true, the argument lists which are known to be sortable
-  # will be sorted lexicographically
-  enable_sort: true
-
-  # If true, the parsers may infer whether or not an argument
-  # list is sortable (without annotation).
-  autosort: false
-
-# Causes a few issues - can be solved later, possibly.
-markup:
-  enable_markup: false

docstring_generator_ext-0.0.26/src/extern/pybind11/.codespell-ignore-lines

@@ -1,24 +0,0 @@
-template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t>
-    template <typename ThisT>
-        auto &this_ = static_cast<ThisT &>(*this);
-                if (load_impl<ThisT>(temp, false)) {
-        ssize_t nd = 0;
-        auto trivial = broadcast(buffers, nd, shape);
-        auto ndim = (size_t) nd;
-    int nd;
-    ssize_t ndim() const { return detail::array_proxy(m_ptr)->nd; }
-        using op = op_impl<id, ot, Base, L_type, R_type>;
-template <op_id id, op_type ot, typename L, typename R>
-    template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra>
-    class_ &def(const detail::op_<id, ot, L, R> &op, const Extra &...extra) {
-    class_ &def_cast(const detail::op_<id, ot, L, R> &op, const Extra &...extra) {
-@pytest.mark.parametrize("access", ["ro", "rw", "static_ro", "static_rw"])
-struct IntStruct {
-    explicit IntStruct(int v) : value(v){};
-    ~IntStruct() { value = -value; }
-    IntStruct(const IntStruct &) = default;
-    IntStruct &operator=(const IntStruct &) = default;
-    py::class_<IntStruct>(m, "IntStruct").def(py::init([](const int i) { return IntStruct(i); }));
-    py::implicitly_convertible<int, IntStruct>();
-    m.def("test", [](int expected, const IntStruct &in) {
-        [](int expected, const IntStruct &in) {

docstring_generator_ext-0.0.26/src/extern/pybind11/.gitattributes

@@ -1 +0,0 @@
-docs/*.svg binary

docstring_generator_ext-0.0.26/src/extern/pybind11/.github/CODEOWNERS

@@ -1,9 +0,0 @@
-*.cmake @henryiii
-CMakeLists.txt @henryiii
-*.yml @henryiii
-*.yaml @henryiii
-/tools/ @henryiii
-/pybind11/ @henryiii
-noxfile.py @henryiii
-.clang-format @henryiii
-.clang-tidy @henryiii