Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9dc09b9e79 | ||
|
|
f0f09a5087 | ||
|
|
cc7f8dfbf3 | ||
|
|
924f1b1e38 | ||
|
|
0453f9e3b7 | ||
|
|
eb75429039 | ||
|
|
d76c73ce9e | ||
|
|
04e7c13b7b | ||
|
|
1376b3f859 | ||
|
|
25af7978b4 | ||
|
|
2fb9084204 | ||
|
|
12770577f7 | ||
|
|
4459819cfc | ||
|
|
5c12b53641 | ||
|
|
f7572144d2 | ||
|
|
4500554943 | ||
|
|
82817e3a80 | ||
|
|
daad1311b1 | ||
|
|
67bdc19f10 | ||
|
|
bcde98f61b | ||
|
|
9e608a0fa5 | ||
|
|
976a71363d |
7
.gitignore
vendored
7
.gitignore
vendored
@@ -25,3 +25,10 @@
|
||||
/Sphinx-3.1.1.tar.gz
|
||||
/Sphinx-3.1.2.tar.gz
|
||||
/Sphinx-3.2.1.tar.gz
|
||||
/Sphinx-3.3.1.tar.gz
|
||||
/Sphinx-3.4.3.tar.gz
|
||||
/Sphinx-3.5.2.tar.gz
|
||||
/Sphinx-3.5.3.tar.gz
|
||||
/Sphinx-3.5.4.tar.gz
|
||||
/Sphinx-4.0.2.tar.gz
|
||||
/Sphinx-4.1.2.tar.gz
|
||||
|
||||
35
display-typing-objects-correctly-with-Python-310.patch
Normal file
35
display-typing-objects-correctly-with-Python-310.patch
Normal file
@@ -0,0 +1,35 @@
|
||||
From 648af37d864b5d76bbe833785d664e40d56d9768 Mon Sep 17 00:00:00 2001
|
||||
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
||||
Date: Wed, 11 Aug 2021 01:36:46 +0900
|
||||
Subject: [PATCH] Fix #9537: autodoc: Some typing.* objects are broken
|
||||
|
||||
At the HEAD of 3.10, the implementation of `typing._GenericAlias` has
|
||||
been changed to have correct _name and __name__.
|
||||
---
|
||||
sphinx/util/typing.py | 6 ++++--
|
||||
2 files changed, 6 insertions(+), 2 deletions(-)
|
||||
|
||||
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
|
||||
index f856950bf2..df5277ae7b 100644
|
||||
--- a/sphinx/util/typing.py
|
||||
+++ b/sphinx/util/typing.py
|
||||
@@ -148,7 +148,9 @@ def _restify_py37(cls: Optional[Type]) -> str:
|
||||
args = ', '.join(restify(a) for a in cls.__args__)
|
||||
return ':obj:`~typing.Union`\\ [%s]' % args
|
||||
elif inspect.isgenericalias(cls):
|
||||
- if getattr(cls, '_name', None):
|
||||
+ if isinstance(cls.__origin__, typing._SpecialForm):
|
||||
+ text = restify(cls.__origin__) # type: ignore
|
||||
+ elif getattr(cls, '_name', None):
|
||||
if cls.__module__ == 'typing':
|
||||
text = ':class:`~%s.%s`' % (cls.__module__, cls._name)
|
||||
else:
|
||||
@@ -344,7 +346,7 @@ def _stringify_py37(annotation: Any) -> str:
|
||||
if not isinstance(annotation.__args__, (list, tuple)):
|
||||
# broken __args__ found
|
||||
pass
|
||||
- elif qualname == 'Union':
|
||||
+ elif qualname in ('Optional', 'Union'):
|
||||
if len(annotation.__args__) > 1 and annotation.__args__[-1] is NoneType:
|
||||
if len(annotation.__args__) > 2:
|
||||
args = ', '.join(stringify(a) for a in annotation.__args__[:-1])
|
||||
62
fix-tests-with-pygments-210.patch
Normal file
62
fix-tests-with-pygments-210.patch
Normal file
@@ -0,0 +1,62 @@
|
||||
From 06ec5b027d01e8f7717e4687f89f335e83545ff9 Mon Sep 17 00:00:00 2001
|
||||
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
||||
Date: Wed, 18 Aug 2021 01:50:08 +0900
|
||||
Subject: [PATCH] Fix test: Tests has been broken with pygments-2.10+
|
||||
|
||||
---
|
||||
tests/test_intl.py | 21 +++++++++++++++++----
|
||||
1 file changed, 17 insertions(+), 4 deletions(-)
|
||||
|
||||
diff --git a/tests/test_intl.py b/tests/test_intl.py
|
||||
index 7791b4aeed5..e9e7ee9e24b 100644
|
||||
--- a/tests/test_intl.py
|
||||
+++ b/tests/test_intl.py
|
||||
@@ -12,6 +12,7 @@
|
||||
import os
|
||||
import re
|
||||
|
||||
+import pygments
|
||||
import pytest
|
||||
from babel.messages import mofile, pofile
|
||||
from babel.messages.catalog import Catalog
|
||||
@@ -30,6 +31,8 @@
|
||||
},
|
||||
)
|
||||
|
||||
+pygments_version = tuple(int(v) for v in pygments.__version__.split('.'))
|
||||
+
|
||||
|
||||
def read_po(pathname):
|
||||
with pathname.open() as f:
|
||||
@@ -1060,8 +1063,13 @@ def test_additional_targets_should_not_be_translated(app):
|
||||
assert_count(expected_expr, result, 1)
|
||||
|
||||
# C code block with lang should not be translated but be *C* highlighted
|
||||
- expected_expr = ("""<span class="cp">#include</span> """
|
||||
- """<span class="cpf"><stdio.h></span>""")
|
||||
+ if pygments_version < (2, 10, 0):
|
||||
+ expected_expr = ("""<span class="cp">#include</span> """
|
||||
+ """<span class="cpf"><stdio.h></span>""")
|
||||
+ else:
|
||||
+ expected_expr = ("""<span class="cp">#include</span>"""
|
||||
+ """<span class="w"> </span>"""
|
||||
+ """<span class="cpf"><stdio.h></span>""")
|
||||
assert_count(expected_expr, result, 1)
|
||||
|
||||
# literal block in list item should not be translated
|
||||
@@ -1138,8 +1146,13 @@ def test_additional_targets_should_be_translated(app):
|
||||
assert_count(expected_expr, result, 1)
|
||||
|
||||
# C code block with lang should be translated and be *C* highlighted
|
||||
- expected_expr = ("""<span class="cp">#include</span> """
|
||||
- """<span class="cpf"><STDIO.H></span>""")
|
||||
+ if pygments_version < (2, 10, 0):
|
||||
+ expected_expr = ("""<span class="cp">#include</span> """
|
||||
+ """<span class="cpf"><STDIO.H></span>""")
|
||||
+ else:
|
||||
+ expected_expr = ("""<span class="cp">#include</span>"""
|
||||
+ """<span class="w"> </span>"""
|
||||
+ """<span class="cpf"><STDIO.H></span>""")
|
||||
assert_count(expected_expr, result, 1)
|
||||
|
||||
# literal block in list item should be translated
|
||||
36
generate-correct-reference-to-parent-class.patch
Normal file
36
generate-correct-reference-to-parent-class.patch
Normal file
@@ -0,0 +1,36 @@
|
||||
From d0c97e9eb57126e38b7b018a101df1ecb1ad12b8 Mon Sep 17 00:00:00 2001
|
||||
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
||||
Date: Sat, 31 Jul 2021 01:41:35 +0900
|
||||
Subject: [PATCH] Fix #9504: autodoc: generate incorrect reference to the
|
||||
parent class
|
||||
|
||||
Autodoc generates incorrect references to the parent class the target
|
||||
class inherites the class having `_name` attribute. It conciders the
|
||||
parent is a kind of SpecialForm'ed class by mistake. This uses
|
||||
`isinstance(X, SpecialForm)` to check that.
|
||||
|
||||
Note: SpecialForm became a class since Python 3.7.
|
||||
---
|
||||
CHANGES | 2 ++
|
||||
sphinx/util/typing.py | 8 ++------
|
||||
2 files changed, 4 insertions(+), 6 deletions(-)
|
||||
|
||||
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
|
||||
index 012d32e524..f856950bf2 100644
|
||||
--- a/sphinx/util/typing.py
|
||||
+++ b/sphinx/util/typing.py
|
||||
@@ -171,12 +171,8 @@ def _restify_py37(cls: Optional[Type]) -> str:
|
||||
text += r"\ [%s]" % ", ".join(restify(a) for a in cls.__args__)
|
||||
|
||||
return text
|
||||
- elif hasattr(cls, '_name'):
|
||||
- # SpecialForm
|
||||
- if cls.__module__ == 'typing':
|
||||
- return ':obj:`~%s.%s`' % (cls.__module__, cls._name)
|
||||
- else:
|
||||
- return ':obj:`%s.%s`' % (cls.__module__, cls._name)
|
||||
+ elif isinstance(cls, typing._SpecialForm):
|
||||
+ return ':obj:`~%s.%s`' % (cls.__module__, cls._name)
|
||||
elif hasattr(cls, '__qualname__'):
|
||||
if cls.__module__ == 'typing':
|
||||
return ':class:`~%s.%s`' % (cls.__module__, cls.__qualname__)
|
||||
@@ -4,6 +4,9 @@
|
||||
# Also, we don't have all the tests requirements
|
||||
%bcond_without tests
|
||||
|
||||
# Unset -s on python shebang to allow RPM-installed sphinx to be used
|
||||
# with user-installed modules (#1903763)
|
||||
%global py3_shebang_flags %nil
|
||||
|
||||
# No internet in Koji
|
||||
%bcond_with internet
|
||||
@@ -21,11 +24,11 @@
|
||||
%global upstream_name Sphinx
|
||||
|
||||
Name: python-sphinx
|
||||
%global general_version 3.2.1
|
||||
%global general_version 4.1.2
|
||||
#global prerel ...
|
||||
%global upstream_version %{general_version}%{?prerel}
|
||||
Version: %{general_version}%{?prerel:~%{prerel}}
|
||||
Release: 1%{?dist}
|
||||
Release: 3%{?dist}
|
||||
Epoch: 1
|
||||
Summary: Python documentation generator
|
||||
|
||||
@@ -41,26 +44,29 @@ Source0: %{pypi_source %{upstream_name} %{upstream_version}}
|
||||
# Allow extra themes to exist. We pull in python3-sphinx-theme-alabaster
|
||||
# which causes that test to fail.
|
||||
Patch1: sphinx-test_theming.diff
|
||||
# `types.Union` was renamed to `types.UnionType` on the HEAD of Python 3.10
|
||||
# (refs: python/cpython#27342). Afterwars, sphinx-build crashes because of ImportError
|
||||
# Merged upstream: https://github.com/sphinx-doc/sphinx/pull/9513
|
||||
Patch2: rename-types-Union-to-types-UnionType.patch
|
||||
# Fix test failures with python-pygments 2.10+
|
||||
# https://github.com/sphinx-doc/sphinx/pull/9557
|
||||
Patch3: fix-tests-with-pygments-210.patch
|
||||
# Some objects under ``typing`` module are not displayed well
|
||||
# with the HEAD of Python 3.10.0rc2+
|
||||
# Merged upstream: https://github.com/sphinx-doc/sphinx/pull/9538
|
||||
Patch4: display-typing-objects-correctly-with-Python-310.patch
|
||||
# Render typing.Annotated correctly with Python 3.10
|
||||
# Merged upstream: https://github.com/sphinx-doc/sphinx/pull/9590
|
||||
Patch5: render-typing-Annotated-correctly-with-Python-3.10.patch
|
||||
# Generate correct reference to the parent class
|
||||
# Merged upstream: https://github.com/sphinx-doc/sphinx/pull/9515/
|
||||
Patch6: generate-correct-reference-to-parent-class.patch
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
BuildRequires: make
|
||||
BuildRequires: python%{python3_pkgversion}-devel
|
||||
BuildRequires: python%{python3_pkgversion}-setuptools
|
||||
|
||||
BuildRequires: python%{python3_pkgversion}-babel
|
||||
BuildRequires: python%{python3_pkgversion}-docutils
|
||||
BuildRequires: python%{python3_pkgversion}-imagesize
|
||||
BuildRequires: python%{python3_pkgversion}-jinja2
|
||||
BuildRequires: python%{python3_pkgversion}-packaging
|
||||
BuildRequires: python%{python3_pkgversion}-pygments
|
||||
BuildRequires: python%{python3_pkgversion}-requests
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-applehelp
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-devhelp
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-htmlhelp
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-jsmath
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-qthelp
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-serializinghtml
|
||||
BuildRequires: python%{python3_pkgversion}-sphinx-theme-alabaster
|
||||
BuildRequires: pyproject-rpm-macros
|
||||
|
||||
%if %{with websupport}
|
||||
BuildRequires: python%{python3_pkgversion}-sphinxcontrib-websupport
|
||||
@@ -73,11 +79,7 @@ BuildRequires: dos2unix
|
||||
# tests import _testcapi
|
||||
BuildRequires: python%{python3_pkgversion}-test
|
||||
|
||||
BuildRequires: python%{python3_pkgversion}-html5lib
|
||||
BuildRequires: python%{python3_pkgversion}-mock
|
||||
BuildRequires: python%{python3_pkgversion}-pytest
|
||||
BuildRequires: python%{python3_pkgversion}-snowballstemmer
|
||||
|
||||
BuildRequires: gcc
|
||||
BuildRequires: gettext
|
||||
BuildRequires: graphviz
|
||||
BuildRequires: texinfo
|
||||
@@ -154,22 +156,12 @@ Summary: Python documentation generator
|
||||
|
||||
Recommends: graphviz
|
||||
Recommends: ImageMagick
|
||||
%{?python_provide:%python_provide python%{python3_pkgversion}-sphinx}
|
||||
|
||||
# Bundled JavaScript
|
||||
Provides: bundled(jquery) = 3.2.1
|
||||
Provides: bundled(jquery) = 3.5.1
|
||||
Provides: bundled(underscore) = 1.3.1
|
||||
Provides: bundled(css3-mediaqueries) = 1.0
|
||||
|
||||
# Remove in F33
|
||||
Obsoletes: python-sphinx-locale < 1:2
|
||||
Provides: python-sphinx-locale = %{epoch}:%{version}-%{release}
|
||||
Obsoletes: python%{python3_pkgversion}-sphinxcontrib-napoleon < 0.3.0
|
||||
Provides: python%{python3_pkgversion}-sphinxcontrib-napoleon = %{epoch}:%{version}-%{release}
|
||||
Conflicts: python2-Sphinx < 1:2
|
||||
Conflicts: python2-sphinx < 1:2
|
||||
Provides: python(Sphinx) = %{epoch}:%{version}-%{release}
|
||||
|
||||
%description -n python%{python3_pkgversion}-sphinx
|
||||
Sphinx is a tool that makes it easy to create intelligent and
|
||||
beautiful documentation for Python projects (or other documents
|
||||
@@ -233,11 +225,8 @@ Requires: tex(upquote.sty)
|
||||
Requires: tex(utf8x.def)
|
||||
Requires: tex(wrapfig.sty)
|
||||
|
||||
%{?python_provide:%python_provide python%{python3_pkgversion}-sphinx-latex}
|
||||
|
||||
# Remove in F33
|
||||
Obsoletes: python-sphinx-latex < 1:2
|
||||
Provides: python-sphinx-latex = %{epoch}:%{version}-%{release}
|
||||
# No files in this package, automatic provides don't work:
|
||||
%py_provides python%{python3_pkgversion}-sphinx-latex
|
||||
|
||||
%description -n python%{python3_pkgversion}-sphinx-latex
|
||||
Sphinx is a tool that makes it easy to create intelligent and
|
||||
@@ -277,13 +266,22 @@ dos2unix -k ./sphinx/themes/basic/static/jquery.js
|
||||
rm tests/test_ext_imgconverter.py
|
||||
%endif
|
||||
|
||||
# Don't measure coverage:
|
||||
sed -i '/pytest-cov/d' setup.py
|
||||
# Not needed on recent Pythons, https://github.com/sphinx-doc/sphinx/pull/8483
|
||||
sed -i '/typed_ast/d' setup.py
|
||||
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -r %{?with_tests:-x test}
|
||||
|
||||
|
||||
%build
|
||||
%py3_build
|
||||
%pyproject_wheel
|
||||
|
||||
export PYTHONPATH=$PWD
|
||||
pushd doc
|
||||
export SPHINXBUILD="%{__python3} ../sphinx/cmd/build.py"
|
||||
export SPHINXBUILD="%{python3} ../sphinx/cmd/build.py"
|
||||
make html SPHINXBUILD="$SPHINXBUILD"
|
||||
make man SPHINXBUILD="$SPHINXBUILD"
|
||||
rm -rf _build/html/.buildinfo
|
||||
@@ -292,7 +290,7 @@ popd
|
||||
|
||||
|
||||
%install
|
||||
%py3_install
|
||||
%pyproject_install
|
||||
|
||||
# For backwards compatibility. Remove with care, if at all
|
||||
for i in sphinx-{apidoc,autogen,build,quickstart}; do
|
||||
@@ -366,7 +364,7 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
|
||||
%{_bindir}/sphinx-*
|
||||
%{python3_sitelib}/sphinx/
|
||||
%dir %{python3_sitelib}/sphinxcontrib/
|
||||
%{python3_sitelib}/Sphinx-%{upstream_version}-py%{python3_version}.egg-info/
|
||||
%{python3_sitelib}/Sphinx-%{upstream_version}.dist-info/
|
||||
%dir %{_datadir}/sphinx/
|
||||
%dir %{_datadir}/sphinx/locale
|
||||
%dir %{_datadir}/sphinx/locale/*
|
||||
@@ -383,6 +381,62 @@ mkdir %{buildroot}%{python3_sitelib}/sphinxcontrib
|
||||
|
||||
|
||||
%changelog
|
||||
* Thu Sep 16 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-3
|
||||
- Display typing objects correctly with Python 3.10 (fix FTBFS)
|
||||
- Generate correct reference to parent class if class has `_name` attribute
|
||||
- Enable previously deselected test
|
||||
|
||||
* Wed Aug 18 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-2
|
||||
- Patch python-sphinx to work with python-pygments >=2.10
|
||||
|
||||
* Mon Aug 02 2021 Karolina Surma <ksurma@redhat.com> - 1:4.1.2-1
|
||||
- Update to 4.1.2
|
||||
- Fixes rhbz#1979326
|
||||
- Backport commit to fix python-sphinx with Python 3.10-rc1
|
||||
|
||||
* Fri Jul 23 2021 Fedora Release Engineering <releng@fedoraproject.org> - 1:4.0.2-4
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_35_Mass_Rebuild
|
||||
|
||||
* Fri Jun 11 2021 Karolina Surma <ksurma@redhat.com> - 1:4.0.2-1
|
||||
- Update to 4.0.2
|
||||
- Fixes rhbz#1948279
|
||||
|
||||
* Thu Jun 03 2021 Python Maint <python-maint@redhat.com> - 1:3.5.4-3
|
||||
- Rebuilt for Python 3.10
|
||||
|
||||
* Wed Jun 02 2021 Python Maint <python-maint@redhat.com> - 1:3.5.4-2
|
||||
- Bootstrap for Python 3.10
|
||||
|
||||
* Mon May 10 2021 Karolina Surma <ksurma@redhat.com> - 1:3.5.4-1
|
||||
- Update to 3.5.4
|
||||
- Fixes rhbz#1949477
|
||||
|
||||
* Thu Apr 01 2021 Karolina Surma <ksurma@redhat.com> - 1:3.5.3-1
|
||||
- Update to 3.5.3
|
||||
- Fixes rhbz#1941161
|
||||
|
||||
* Wed Mar 10 2021 Charalampos Stratakis <cstratak@redhat.com> - 1:3.5.2-1
|
||||
- Update 3.5.2
|
||||
- Fixes rhbz#1928459
|
||||
|
||||
* Wed Jan 27 2021 Fedora Release Engineering <releng@fedoraproject.org> - 1:3.4.3-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_34_Mass_Rebuild
|
||||
|
||||
* Tue Jan 19 2021 Charalampos Stratakis <cstratak@redhat.com> - 1:3.4.3-1
|
||||
- Update to 3.4.3
|
||||
- Fixes rhbz#1909494
|
||||
|
||||
* Sat Dec 05 2020 Mattia Verga <mattia.verga@protonmail.com> - 1:3.3.1-2
|
||||
- Unset -s from python shebang
|
||||
- Fixes: rhbz#1903763
|
||||
|
||||
* Mon Nov 23 2020 Miro Hrončok <mhroncok@redhat.com> - 1:3.3.1-1
|
||||
- Update to 3.3.1
|
||||
- Fixes: rhbz#1893752
|
||||
|
||||
* Wed Oct 14 2020 Tomas Hrnciar <thrnciar@redhat.com> - 1:3.2.1-2
|
||||
- Backport commit to fix python-sphinx with python-pygments v2.7.1
|
||||
|
||||
* Tue Aug 18 2020 Miro Hrončok <mhroncok@redhat.com> - 1:3.2.1-1
|
||||
- Update to 3.2.1
|
||||
- Remove compatibility symbolic links from /usr/libexec/
|
||||
|
||||
49
rename-types-Union-to-types-UnionType.patch
Normal file
49
rename-types-Union-to-types-UnionType.patch
Normal file
@@ -0,0 +1,49 @@
|
||||
From 8b2031c747e7c7e6b845ee2e3db47de617d33cc6 Mon Sep 17 00:00:00 2001
|
||||
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
||||
Date: Fri, 30 Jul 2021 01:27:38 +0900
|
||||
Subject: [PATCH] Fix #9512: sphinx-build: crashed with the HEAD of Python 3.10
|
||||
|
||||
Recently, `types.Union` was renamed to `types.UnionType` on the HEAD
|
||||
of 3.10 (refs: python/cpython#27342). After this change, sphinx-build
|
||||
has been crashed because of ImportError.
|
||||
---
|
||||
sphinx/util/typing.py | 12 ++++++------
|
||||
1 files changed, 8 insertions(+), 6 deletions(-)
|
||||
|
||||
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
|
||||
index f1723c035a..012d32e524 100644
|
||||
--- a/sphinx/util/typing.py
|
||||
+++ b/sphinx/util/typing.py
|
||||
@@ -33,10 +33,10 @@ def _evaluate(self, globalns: Dict, localns: Dict) -> Any:
|
||||
ref = _ForwardRef(self.arg)
|
||||
return ref._eval_type(globalns, localns)
|
||||
|
||||
-if sys.version_info > (3, 10):
|
||||
- from types import Union as types_Union
|
||||
-else:
|
||||
- types_Union = None
|
||||
+try:
|
||||
+ from types import UnionType # type: ignore # python 3.10 or above
|
||||
+except ImportError:
|
||||
+ UnionType = None
|
||||
|
||||
if False:
|
||||
# For type annotation
|
||||
@@ -114,7 +114,7 @@ def restify(cls: Optional[Type]) -> str:
|
||||
return ':class:`%s`' % INVALID_BUILTIN_CLASSES[cls]
|
||||
elif inspect.isNewType(cls):
|
||||
return ':class:`%s`' % cls.__name__
|
||||
- elif types_Union and isinstance(cls, types_Union):
|
||||
+ elif UnionType and isinstance(cls, UnionType):
|
||||
if len(cls.__args__) > 1 and None in cls.__args__:
|
||||
args = ' | '.join(restify(a) for a in cls.__args__ if a)
|
||||
return 'Optional[%s]' % args
|
||||
@@ -337,7 +337,7 @@ def _stringify_py37(annotation: Any) -> str:
|
||||
elif hasattr(annotation, '__origin__'):
|
||||
# instantiated generic provided by a user
|
||||
qualname = stringify(annotation.__origin__)
|
||||
- elif types_Union and isinstance(annotation, types_Union): # types.Union (for py3.10+)
|
||||
+ elif UnionType and isinstance(annotation, UnionType): # types.Union (for py3.10+)
|
||||
qualname = 'types.Union'
|
||||
else:
|
||||
# we weren't able to extract the base type, appending arguments would
|
||||
26
render-typing-Annotated-correctly-with-Python-3.10.patch
Normal file
26
render-typing-Annotated-correctly-with-Python-3.10.patch
Normal file
@@ -0,0 +1,26 @@
|
||||
From b82d3ef05a75b6dad9679f8746db5ef89785c7c0 Mon Sep 17 00:00:00 2001
|
||||
From: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
||||
Date: Sun, 29 Aug 2021 15:40:49 +0900
|
||||
Subject: [PATCH] Fix #9589: autodoc: typing.Annotated has wrongly been
|
||||
rendered
|
||||
|
||||
At the HEAD of 3.10, the implementation of `typing.Annotated` has
|
||||
been changed to have __qualname__.
|
||||
---
|
||||
CHANGES | 4 ++--
|
||||
sphinx/util/typing.py | 2 ++
|
||||
2 files changed, 4 insertions(+), 2 deletions(-)
|
||||
|
||||
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
|
||||
index df5277ae7b..35f808211b 100644
|
||||
--- a/sphinx/util/typing.py
|
||||
+++ b/sphinx/util/typing.py
|
||||
@@ -306,6 +306,8 @@ def stringify(annotation: Any) -> str:
|
||||
return 'None'
|
||||
elif annotation in INVALID_BUILTIN_CLASSES:
|
||||
return INVALID_BUILTIN_CLASSES[annotation]
|
||||
+ elif str(annotation).startswith('typing.Annotated'): # for py310+
|
||||
+ pass
|
||||
elif (getattr(annotation, '__module__', None) == 'builtins' and
|
||||
getattr(annotation, '__qualname__', None)):
|
||||
return annotation.__qualname__
|
||||
2
sources
2
sources
@@ -1 +1 @@
|
||||
SHA512 (Sphinx-3.2.1.tar.gz) = 3f0f49036a44938abd470c2f825a0eeeeb818daf3dfbb3bc5c746b64305b5fe66c1c34d9703eb9420b2b347247c122825ddae1b6c28c88c249206151f39e3bdb
|
||||
SHA512 (Sphinx-4.1.2.tar.gz) = 1fe998de7b8fc47989e186835748b7fb5d0b523db95434515b6af29b56d28372f2f92ab917c27cbed51aa0cad13175eda8bf4fc93a8726eb5e93e9bc6995e457
|
||||
|
||||
Reference in New Issue
Block a user