You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With undoc-members and v3.2.0 I get an exception. I do not get an exception with v3.1.2. Per my local bisecting it was introduced specifically in 88b2ec6.
Exception occurred:
File "/home/altendky/.pyenv/versions/3.8.3/lib/python3.8/typing.py", line 1223, in get_type_hints
base_globals = sys.modules[base.__module__].__dict__KeyError: 'Shiboken'
In case you aren't familiar, Shiboken2 is the wrapper generator used by PySide2 to wrap the C++ Qt library. Shiboken filled that role for PySide. I am using PySide2. I'm not sure if the lack of the 2 is relevant or not.
altendky@p1:~/repos/preqtrio/tmp/qtrio$ git checkout e0d526808a924c95d4c6191070ca21ab9ddab54c
Note: switching to 'e0d526808a924c95d4c6191070ca21ab9ddab54c'.
You are in'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.
If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:
git switch -c <new-branch-name>
Or undo this operation with:
git switch -
Turn off this advice by setting config variable advice.detachedHead to false
HEAD is now at e0d5268 add newsfragments/146.doc.rst
(venv) altendky@p1:~/repos/preqtrio/tmp/qtrio$ cd docs
(venv) altendky@p1:~/repos/preqtrio/tmp/qtrio/docs$ make html
Running Sphinx v3.2.0
making output directory... done
loading intersphinx inventory from https://outcome.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.riverbankcomputing.com/static/Docs/PyQt5/objects.inv...
loading intersphinx inventory from https://docs.pytest.org/en/stable/objects.inv...
loading intersphinx inventory from https://trio.readthedocs.io/en/stable/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 13 source files that are out of date
updating environment: [new config] 13 added, 0 changed, 0 removed
reading sources... [ 7%] core
Exception occurred:
File "/home/altendky/.pyenv/versions/3.8.3/lib/python3.8/typing.py", line 1223, in get_type_hints
base_globals = sys.modules[base.__module__].__dict__
KeyError: 'Shiboken'
The full traceback has been saved in /tmp/sphinx-err-3wvywl4z.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:20: html] Error 2
(venv) altendky@p1:~/repos/preqtrio/tmp/qtrio/docs$ cat /tmp/sphinx-err-3wvywl4z.log
# Sphinx version: 3.2.0# Python version: 3.8.3 (CPython)# Docutils version: 0.16 release# Jinja2 version: 2.11.2# Last messages:# loading intersphinx inventory from https://docs.python.org/3/objects.inv...# loading intersphinx inventory from https://www.riverbankcomputing.com/static/Docs/PyQt5/objects.inv...# loading intersphinx inventory from https://docs.pytest.org/en/stable/objects.inv...# loading intersphinx inventory from https://trio.readthedocs.io/en/stable/objects.inv...# building [mo]: targets for 0 po files that are out of date# building [html]: targets for 13 source files that are out of date# updating environment:# [new config]# 13 added, 0 changed, 0 removed# reading sources... [ 7%] core# Loaded extensions:# sphinx.ext.mathjax (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/mathjax.py# sphinxcontrib.applehelp (1.0.2) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib/applehelp/__init__.py# sphinxcontrib.devhelp (1.0.2) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib/devhelp/__init__.py# sphinxcontrib.htmlhelp (1.0.3) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib/htmlhelp/__init__.py# sphinxcontrib.serializinghtml (1.1.4) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib/serializinghtml/__init__.py# sphinxcontrib.qthelp (1.0.3) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib/qthelp/__init__.py# alabaster (0.7.12) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/alabaster/__init__.py# sphinx.ext.autodoc.type_comment (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/type_comment.py# sphinx.ext.autodoc (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py# sphinx.ext.intersphinx (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/intersphinx.py# sphinx.ext.coverage (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/coverage.py# sphinx.ext.napoleon (3.2.0) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/napoleon/__init__.py# sphinx_qt_documentation (0.1) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx_qt_documentation/__init__.py# sphinxcontrib_trio (1.1.2) from /home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinxcontrib_trio/__init__.py
Traceback (most recent call last):
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/cmd/build.py", line 280, in build_main
app.build(args.force_all, filenames)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/application.py", line 348, in build
self.builder.build_update()
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 297, in build_update
self.build(to_build,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 311, in build
updated_docnames = set(self.read())
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 418, inread
self._read_serial(docnames)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 439, in _read_serial
self.read_doc(docname)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 479, in read_doc
doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/io.py", line 223, in read_doc
pub.publish()
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/core.py", line 217, in publish
self.document = self.reader.read(self.source, self.parser,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/io.py", line 128, inreadself.parse()
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/readers/__init__.py", line 77, in parse
self.parser.parse(self.input, document)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/parsers.py", line 102, in parse
self.statemachine.run(inputlines, document, inliner=self.inliner)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 170, in run
results = StateMachineWS.run(self, input_lines, input_offset,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 241, in run
context, next_state, result = self.check_line(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 459, in check_line
return method(match, context, next_state)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2769, in underline
self.section(title, source, style, lineno - 1, messages)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 327, in section
self.new_subsection(title, lineno, messages)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 393, in new_subsection
newabsoffset = self.nested_parse(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 281, in nested_parse
state_machine.run(block, input_offset, memo=self.memo,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 196, in run
results = StateMachineWS.run(self, input_lines, input_offset)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 241, in run
context, next_state, result = self.check_line(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 459, in check_line
return method(match, context, next_state)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2769, in underline
self.section(title, source, style, lineno - 1, messages)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 327, in section
self.new_subsection(title, lineno, messages)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 393, in new_subsection
newabsoffset = self.nested_parse(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 281, in nested_parse
state_machine.run(block, input_offset, memo=self.memo,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 196, in run
results = StateMachineWS.run(self, input_lines, input_offset)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 241, in run
context, next_state, result = self.check_line(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 459, in check_line
return method(match, context, next_state)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2344, in explicit_markup
self.explicit_list(blank_finish)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2369, in explicit_list
newline_offset, blank_finish = self.nested_list_parse(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 318, in nested_list_parse
state_machine.run(block, input_offset, memo=self.memo,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 196, in run
results = StateMachineWS.run(self, input_lines, input_offset)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 241, in run
context, next_state, result = self.check_line(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/statemachine.py", line 459, in check_line
return method(match, context, next_state)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2647, in explicit_markup
nodelist, blank_finish = self.explicit_construct(match)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2354, in explicit_construct
return method(self, expmatch)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2096, in directive
return self.run_directive(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/docutils/parsers/rst/states.py", line 2146, in run_directive
result = directive_instance.run()
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/directive.py", line 146, in run
documenter.generate(more_content=self.content)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 1568, in generate
returnsuper().generate(more_content=more_content,
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 894, in generate
self.document_members(all_members)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 1559, in document_members
super().document_members(all_members)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 775, in document_members
documenter.generate(
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 884, in generate
self.add_directive_header(sig)
File "/home/altendky/repos/preqtrio/tmp/qtrio/venv/lib/python3.8/site-packages/sphinx/ext/autodoc/__init__.py", line 1980, in add_directive_header
annotations = get_type_hints(self.parent)
File "/home/altendky/.pyenv/versions/3.8.3/lib/python3.8/typing.py", line 1223, in get_type_hints
base_globals = sys.modules[base.__module__].__dict__
KeyError: 'Shiboken'
Expected behavior
No exception. Though sure, I have not dug into this and an error message from Sphinx may be the appropriate substitute for the raw exception.
Ha, I literally just noticed 3.2.1 and started running against it right before seeing your note. And yes, that does address the exception. Thank you. That's what I get for checking against the tag I knew about rather than just latest 3.x or such...
Describe the bug
With
undoc-members
and v3.2.0 I get an exception. I do not get an exception with v3.1.2. Per my local bisecting it was introduced specifically in 88b2ec6.In case you aren't familiar, Shiboken2 is the wrapper generator used by PySide2 to wrap the C++ Qt library. Shiboken filled that role for PySide. I am using PySide2. I'm not sure if the lack of the 2 is relevant or not.
QTrio: altendky/qtrio@e0d5268
Sphinx: 88b2ec6
To Reproduce
Steps to reproduce the behavior:
Steps with output including complete traceback
altendky@p1:~/repos/preqtrio/tmp/qtrio$ python3.8 -m venv venv
altendky@p1:~/repos/preqtrio/tmp/qtrio$ venv/bin/pip freeze alabaster==0.7.12 async-generator==1.10 attrs==19.3.0 Babel==2.8.0 certifi==2020.6.20 chardet==3.0.4 click==7.1.2 click-default-group==1.2.2 decorator==4.4.2 docutils==0.16 idna==2.10 imagesize==1.2.0 incremental==17.5.0 iniconfig==1.0.1 Jinja2==2.11.2 MarkupSafe==1.1.1 more-itertools==8.4.0 outcome==1.0.1 packaging==20.4 pluggy==0.13.1 py==1.9.0 Pygments==2.6.1 pyparsing==2.4.7 PySide2==5.15.0 pytest==6.0.1 pytz==2020.1 QtPy==1.9.0 qtrio @ file:///home/altendky/repos/preqtrio/tmp/qtrio requests==2.24.0 shiboken2==5.15.0 six==1.15.0 sniffio==1.1.0 snowballstemmer==2.0.0 sortedcontainers==2.2.2 Sphinx @ git+https://github.com/sphinx-doc/sphinx@88b2ec6c34fb405cf468475e6f2a7754e2c705eb sphinx-autodoc-typehints==1.11.0 sphinx-qt-documentation==0.3 sphinx-rtd-theme==0.5.0 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==1.0.3 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.4 sphinxcontrib-trio==1.1.2 toml==0.10.1 towncrier==19.9.0rc1 trio==0.16.0 urllib3==1.25.10
Expected behavior
No exception. Though sure, I have not dug into this and an error message from Sphinx may be the appropriate substitute for the raw exception.
Your project
altendky/qtrio#146
Environment info
The text was updated successfully, but these errors were encountered: