Sphinx 7.3.5__tar.gz → 7.3.6__tar.gz

{sphinx-7.3.5 → sphinx-7.3.6}/CHANGES.rst

@@ -1,3 +1,15 @@
+Release 7.3.6 (released Apr 17, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #12295: Re-export all AST types in the C and C++ domains.
+  Patch by Adam Turner.
+* #12295: Re-export various objects from ``sphinx.domains.python._annotations``
+  in ``sphinx.domains.python``.
+  Patch by Jacob Chesslo and Adam Turner.
+
 Release 7.3.5 (released Apr 17, 2024)
 =====================================
 

{sphinx-7.3.5 → sphinx-7.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 7.3.5
+Version: 7.3.6
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.9

{sphinx-7.3.5 → sphinx-7.3.6}/doc/usage/configuration.rst

@@ -345,7 +345,7 @@ General configuration
    * ``app.add_role``
    * ``app.add_generic_role``
    * ``app.add_source_parser``
-   * ``autosectionlabel.*``
+   * ``config.cache``
    * ``download.not_readable``
    * ``epub.unknown_project_files``
    * ``epub.duplicated_toc_entry``
@@ -367,7 +367,14 @@ General configuration
    * ``toc.not_readable``
    * ``toc.secnum``
 
-   Then extensions can also define their own warning types.
+   Extensions can also define their own warning types.
+   Those defined by the first-party ``sphinx.ext`` extensions are:
+
+   * ``autodoc``
+   * ``autodoc.import_object``
+   * ``autosectionlabel.<document name>``
+   * ``autosummary``
+   * ``intersphinx.external``
 
    You can choose from these types.  You can also give only the first
    component to exclude all warnings attached to it.
@@ -388,7 +395,7 @@ General configuration
 
    .. versionchanged:: 2.1
 
-      Added ``autosectionlabel.*``
+      Added ``autosectionlabel.<document name>``
 
    .. versionchanged:: 3.3.0
 
@@ -402,9 +409,13 @@ General configuration
 
       Added ``i18n.inconsistent_references``
 
-    .. versionadded:: 7.1
+   .. versionadded:: 7.1
+
+      Added ``index`` warning type.
+
+   .. versionadded:: 7.3
 
-        Added ``index`` warning type.
+      Added ``config.cache`` warning type.
 
 .. confval:: needs_sphinx
 

{sphinx-7.3.5 → sphinx-7.3.6}/sphinx/__init__.py

@@ -1,6 +1,6 @@
 """The Sphinx documentation toolchain."""
 
-__version__ = '7.3.5'
+__version__ = '7.3.6'
 __display_version__ = __version__  # used for command line version
 
 # Keep this file executable as-is in Python 3!
@@ -28,7 +28,7 @@ warnings.filterwarnings(
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info = (7, 3, 5, 'final', 0)
+version_info = (7, 3, 6, 'final', 0)
 
 package_dir = path.abspath(path.dirname(__file__))
 

{sphinx-7.3.5 → sphinx-7.3.6}/sphinx/config.py

@@ -51,30 +51,28 @@ class ConfigValue(NamedTuple):
     rebuild: _ConfigRebuild
 
 
-def is_serializable(obj: object, *, _recursive_guard: frozenset[int] = frozenset()) -> bool:
-    """Check if object is serializable or not."""
+def is_serializable(obj: object, *, _seen: frozenset[int] = frozenset()) -> bool:
+    """Check if an object is serializable or not."""
     if isinstance(obj, UNSERIALIZABLE_TYPES):
         return False
 
     # use id() to handle un-hashable objects
-    if id(obj) in _recursive_guard:
+    if id(obj) in _seen:
         return True
 
     if isinstance(obj, dict):
-        guard = _recursive_guard | {id(obj)}
-        for key, value in obj.items():
-            if (
-                not is_serializable(key, _recursive_guard=guard)
-                or not is_serializable(value, _recursive_guard=guard)
-            ):
-                return False
+        seen = _seen | {id(obj)}
+        return all(
+            is_serializable(key, _seen=seen) and is_serializable(value, _seen=seen)
+            for key, value in obj.items()
+        )
     elif isinstance(obj, (list, tuple, set, frozenset)):
-        guard = _recursive_guard | {id(obj)}
-        return all(is_serializable(item, _recursive_guard=guard) for item in obj)
+        seen = _seen | {id(obj)}
+        return all(is_serializable(item, _seen=seen) for item in obj)
 
     # if an issue occurs for a non-serializable type, pickle will complain
-    # since the object is likely coming from a third-party extension (we
-    # natively expect 'simple' types and not weird ones)
+    # since the object is likely coming from a third-party extension
+    # (we natively expect 'simple' types and not weird ones)
     return True
 
 
@@ -473,7 +471,8 @@ class Config:
                     # will always mark the config value as changed,
                     # and thus always invalidate the cache and perform a rebuild.
                     logger.warning(
-                        __('cannot cache unpickable configuration value: %r'),
+                        __('cannot cache unpickable configuration value: %r '
+                           '(because it contains a function, class, or module object)'),
                         name,
                         type='config',
                         subtype='cache',

{sphinx-7.3.5 → sphinx-7.3.6}/sphinx/domains/c/__init__.py

@@ -44,6 +44,59 @@ if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
+# re-export objects for backwards compatibility
+# xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.c._ast import (  # NoQA: F401
+    ASTAlignofExpr,
+    ASTArray,
+    ASTAssignmentExpr,
+    ASTBase,
+    ASTBinOpExpr,
+    ASTBooleanLiteral,
+    ASTBracedInitList,
+    ASTCastExpr,
+    ASTCharLiteral,
+    ASTDeclarator,
+    ASTDeclaratorNameBitField,
+    ASTDeclaratorNameParam,
+    ASTDeclaratorParen,
+    ASTDeclaratorPtr,
+    ASTDeclSpecs,
+    ASTDeclSpecsSimple,
+    ASTEnum,
+    ASTEnumerator,
+    ASTExpression,
+    ASTFallbackExpr,
+    ASTFunctionParameter,
+    ASTIdExpression,
+    ASTInitializer,
+    ASTLiteral,
+    ASTMacro,
+    ASTMacroParameter,
+    ASTNumberLiteral,
+    ASTParameters,
+    ASTParenExpr,
+    ASTParenExprList,
+    ASTPostfixArray,
+    ASTPostfixCallExpr,
+    ASTPostfixDec,
+    ASTPostfixExpr,
+    ASTPostfixInc,
+    ASTPostfixMemberOfPointer,
+    ASTPostfixOp,
+    ASTSizeofExpr,
+    ASTSizeofType,
+    ASTStringLiteral,
+    ASTStruct,
+    ASTTrailingTypeSpec,
+    ASTTrailingTypeSpecFundamental,
+    ASTTrailingTypeSpecName,
+    ASTType,
+    ASTTypeWithInit,
+    ASTUnaryOpExpr,
+    ASTUnion,
+)
+
 logger = logging.getLogger(__name__)
 
 

{sphinx-7.3.5 → sphinx-7.3.6}/sphinx/domains/cpp/__init__.py

@@ -48,6 +48,98 @@ if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
     from sphinx.util.typing import ExtensionMetadata, OptionSpec
 
+# re-export objects for backwards compatibility
+# xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.cpp._ast import (  # NoQA: F401
+    ASTAlignofExpr,
+    ASTArray,
+    ASTAssignmentExpr,
+    ASTBase,
+    ASTBaseClass,
+    ASTBinOpExpr,
+    ASTBooleanLiteral,
+    ASTBracedInitList,
+    ASTCastExpr,
+    ASTCharLiteral,
+    ASTClass,
+    ASTCommaExpr,
+    ASTConcept,
+    ASTConditionalExpr,
+    ASTDeclarator,
+    ASTDeclaratorMemPtr,
+    ASTDeclaratorNameBitField,
+    ASTDeclaratorNameParamQual,
+    ASTDeclaratorParamPack,
+    ASTDeclaratorParen,
+    ASTDeclaratorPtr,
+    ASTDeclaratorRef,
+    ASTDeclSpecs,
+    ASTDeclSpecsSimple,
+    ASTDeleteExpr,
+    ASTEnum,
+    ASTEnumerator,
+    ASTExplicitCast,
+    ASTExplicitSpec,
+    ASTExpression,
+    ASTFallbackExpr,
+    ASTFoldExpr,
+    ASTFunctionParameter,
+    ASTIdExpression,
+    ASTInitializer,
+    ASTLiteral,
+    ASTNewExpr,
+    ASTNoexceptExpr,
+    ASTNoexceptSpec,
+    ASTNumberLiteral,
+    ASTOperator,
+    ASTOperatorBuildIn,
+    ASTOperatorLiteral,
+    ASTOperatorType,
+    ASTPackExpansionExpr,
+    ASTParametersQualifiers,
+    ASTParenExpr,
+    ASTParenExprList,
+    ASTPointerLiteral,
+    ASTPostfixArray,
+    ASTPostfixCallExpr,
+    ASTPostfixDec,
+    ASTPostfixExpr,
+    ASTPostfixInc,
+    ASTPostfixMember,
+    ASTPostfixMemberOfPointer,
+    ASTPostfixOp,
+    ASTRequiresClause,
+    ASTSizeofExpr,
+    ASTSizeofParamPack,
+    ASTSizeofType,
+    ASTStringLiteral,
+    ASTTemplateArgConstant,
+    ASTTemplateArgs,
+    ASTTemplateDeclarationPrefix,
+    ASTTemplateIntroduction,
+    ASTTemplateIntroductionParameter,
+    ASTTemplateKeyParamPackIdDefault,
+    ASTTemplateParam,
+    ASTTemplateParamConstrainedTypeWithInit,
+    ASTTemplateParamNonType,
+    ASTTemplateParams,
+    ASTTemplateParamTemplateType,
+    ASTTemplateParamType,
+    ASTThisLiteral,
+    ASTTrailingTypeSpec,
+    ASTTrailingTypeSpecDecltype,
+    ASTTrailingTypeSpecDecltypeAuto,
+    ASTTrailingTypeSpecFundamental,
+    ASTTrailingTypeSpecName,
+    ASTType,
+    ASTTypeId,
+    ASTTypeUsing,
+    ASTTypeWithInit,
+    ASTUnaryOpExpr,
+    ASTUnion,
+    ASTUserDefinedLiteral,
+)
+
 logger = logging.getLogger(__name__)
 
 

{sphinx-7.3.5 → sphinx-7.3.6}/sphinx/domains/python/__init__.py

@@ -38,12 +38,15 @@ if TYPE_CHECKING:
 
 # re-export objects for backwards compatibility
 # xref https://github.com/sphinx-doc/sphinx/issues/12295
+from sphinx.domains.python._annotations import (  # NoQA: F401
+    _parse_arglist,  # for sphinx-immaterial
+    type_to_xref,
+)
 from sphinx.domains.python._object import (  # NoQA: F401
     PyField,
     PyGroupedField,
     PyTypedField,
     PyXrefMixin,
-    py_sig_re,
 )
 
 logger = logging.getLogger(__name__)

{sphinx-7.3.5 → sphinx-7.3.6}/tests/test_builders/test_build_warnings.py

@@ -73,8 +73,8 @@ def test_texinfo_warnings(app, warning):
 
 
 def test_uncacheable_config_warning(make_app, tmp_path):
-    """Test than an unpickleable config value raises a warning."""
-    tmp_path.joinpath('conf.py').write_text("""
+    """Test that an unpickleable config value raises a warning."""
+    tmp_path.joinpath('conf.py').write_text("""\
 my_config = lambda: None
 show_warning_types = True
 def setup(app):
@@ -84,5 +84,6 @@ def setup(app):
     app = make_app(srcdir=tmp_path)
     app.build()
     assert strip_colors(app.warning.getvalue()).strip() == (
-        "WARNING: cannot cache unpickable configuration value: 'my_config' [config.cache]"
+        "WARNING: cannot cache unpickable configuration value: 'my_config' "
+        "(because it contains a function, class, or module object) [config.cache]"
     )

{sphinx-7.3.5 → sphinx-7.3.6}/tests/test_config/test_config.py

@@ -46,7 +46,7 @@ def check_is_serializable(subject: object, *, circular: bool) -> None:
 
         # check that without recursive guards, a recursion error occurs
         with pytest.raises(RecursionError):
-            assert is_serializable(subject, _recursive_guard=UselessGuard())
+            assert is_serializable(subject, _seen=UselessGuard())
 
 
 def test_is_serializable() -> None: