sphinx-autoapi 3.3.2__tar.gz → 3.3.3__tar.gz

{sphinx_autoapi-3.3.2/sphinx_autoapi.egg-info → sphinx_autoapi-3.3.3}/PKG-INFO

@@ -1,15 +1,12 @@
 Metadata-Version: 2.1
 Name: sphinx-autoapi
-Version: 3.3.2
+Version: 3.3.3
 Summary: Sphinx API documentation generator
-Home-page: http://github.com/readthedocs/sphinx-autoapi
-Author: Eric Holscher
-Author-email: eric@ericholscher.com
-Maintainer: Ashley Whetter
-Maintainer-email: ashley@awhetter.co.uk
-License: MIT
-Project-URL: Documentation, https://sphinx-autoapi.readthedocs.io/en/latest/
-Classifier: Development Status :: 4 - Beta
+Author-email: Eric Holscher <eric@ericholscher.com>
+Maintainer-email: Ashley Whetter <ashley@awhetter.co.uk>
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Plugins
 Classifier: Framework :: Sphinx :: Extension
 Classifier: Intended Audience :: Developers
@@ -21,19 +18,16 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-License-File: LICENSE.rst
-Requires-Dist: astroid>=2.7; python_version < "3.12"
-Requires-Dist: astroid>=3.0.0a1; python_version >= "3.12"
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: astroid>=2.7;python_version<"3.12"
+Requires-Dist: astroid>=3.0.0a1;python_version>="3.12"
 Requires-Dist: Jinja2
 Requires-Dist: PyYAML
 Requires-Dist: sphinx>=6.1.0
-Requires-Dist: stdlib_list; python_version < "3.10"
-Provides-Extra: docs
-Requires-Dist: furo; extra == "docs"
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: stdlib_list;python_version<"3.10"
+Project-URL: Documentation, https://sphinx-autoapi.readthedocs.io/en/latest/
+Project-URL: Homepage, http://github.com/readthedocs/sphinx-autoapi
 
 Sphinx AutoAPI
 ==============
@@ -156,3 +150,4 @@ License
 
 This project is licensed under the MIT License.
 See the `LICENSE.rst <LICENSE.rst>`_ file for details.
+

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/__init__.py

@@ -3,5 +3,5 @@
 from .extension import setup
 
 __all__ = ("setup",)
-__version__ = "3.3.2"
-__version_info__ = (3, 3, 2)
+__version__ = "3.3.3"
+__version_info__ = (3, 3, 3)

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/_astroid_utils.py

@@ -129,7 +129,7 @@ def get_full_basenames(node: astroid.nodes.ClassDef) -> Iterable[str]:
         node: The class definition node to resolve the bases of.
 
     Returns:
-        The fullly qualified names.
+        The fully qualified names.
     """
     for base in node.bases:
         yield _resolve_annotation(base)

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/_objects.py

@@ -506,6 +506,9 @@ class PythonClass(PythonObject):
     def constructor(self):
         for child in self.children:
             if child.short_name == "__init__":
+                if not child.type == "method":
+                    break
+
                 return child
 
         return None

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/_parser.py

@@ -267,6 +267,26 @@ class Parser:
         if node.name == "__init__":
             for child in node.get_children():
                 if isinstance(child, (astroid.nodes.Assign, astroid.nodes.AnnAssign)):
+                    # Verify we are assigning to self.
+                    if isinstance(child, astroid.nodes.Assign):
+                        targets = child.targets
+                    else:
+                        targets = [child.target]
+
+                    target_ok = True
+                    for target in targets:
+                        if not isinstance(target, astroid.nodes.AssignAttr):
+                            target_ok = False
+                            break
+                        _object = target.expr
+                        if (
+                            not isinstance(_object, astroid.nodes.Name)
+                            or _object.name != "self"
+                        ):
+                            target_ok = False
+                            break
+                    if not target_ok:
+                        continue
                     child_data = self._parse_assign(child)
                     result.extend(data for data in child_data)
 

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/templates/python/module.rst

@@ -12,24 +12,10 @@
 
       {% endif %}
 
-      {% block subpackages %}
-         {% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
-         {% if visible_subpackages %}
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 1
-
-            {% for subpackage in visible_subpackages %}
-   {{ subpackage.include_path }}
-            {% endfor %}
-
-
-         {% endif %}
-      {% endblock %}
       {% block submodules %}
+         {% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
          {% set visible_submodules = obj.submodules|selectattr("display")|list %}
+         {% set visible_submodules = (visible_subpackages + visible_submodules)|sort %}
          {% if visible_submodules %}
 Submodules
 ----------

{sphinx_autoapi-3.3.2 → sphinx_autoapi-3.3.3}/autoapi/templates/python/property.rst

@@ -15,6 +15,7 @@
    {% endfor %}
 
    {% if obj.docstring %}
+
    {{ obj.docstring|indent(3) }}
    {% endif %}
 {% endif %}

sphinx_autoapi-3.3.3/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "sphinx-autoapi"
+authors = [{name = "Eric Holscher", email = "eric@ericholscher.com"}]
+maintainers = [{name = "Ashley Whetter", email = "ashley@awhetter.co.uk"}]
+description = "Sphinx API documentation generator"
+license = {text = "LICENSE.rst"}
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Plugins",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.8"
+dependencies = [
+    'astroid>=2.7;python_version<"3.12"',
+    'astroid>=3.0.0a1;python_version>="3.12"',
+    "Jinja2",
+    "PyYAML",
+    "sphinx>=6.1.0",
+    'stdlib_list;python_version<"3.10"',
+]
+dynamic = ["version"]
+
+[project.readme]
+file = "README.rst"
+content-type = "text/x-rst"
+
+[project.urls]
+Homepage = "http://github.com/readthedocs/sphinx-autoapi"
+Documentation = "https://sphinx-autoapi.readthedocs.io/en/latest/"
+
+[tool.flit.module]
+name = "autoapi"
+
+[tool.mypy]
+# Start off with these
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+# Getting these passing should be easy
+strict_equality = true
+
+# These shouldn't be too much additional work, but may be tricky to
+# get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+# This one isn't too hard to get passing, but return on investment is lower
+no_implicit_reexport = true
+
+[[tool.mypy.overrides]]
+module = "astroid.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "autoapi.documenters"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "autoapi._astroid_utils"
+
+# Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+# These next few are various gradations of forcing use of type annotations
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+
+# This one can be tricky to get passing if you use a lot of untyped libraries
+# Ignore until astroid is typed (https://github.com/pylint-dev/astroid/issues/2060)
+warn_return_any = false
+
+[tool.pytest.ini_options]
+markers = [
+    "network: Tests that use network access.",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.towncrier]
+directory = "docs/changes"
+filename = "CHANGELOG.rst"
+package = "autoapi"
+title_format = "v{version} ({project_date})"
+underlines = ["-", "^", "\""]