NotificationsYou must be signed in to change notification settings
Fork32k
Star67.2k

gh-101100: Fix Sphinx warnings in`library/unittest.mock.rst`#124106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

hugovk merged 2 commits intopython:mainfromhugovk:docs-fix-sphinx-warnings-unittest.mock

Oct 9, 2024

Merged

gh-101100: Fix Sphinx warnings in`library/unittest.mock.rst`#124106

hugovk merged 2 commits intopython:mainfromhugovk:docs-fix-sphinx-warnings-unittest.mock

Oct 9, 2024

Conversation

Copy link

Member

hugovk commentedSep 15, 2024•
edited by github-actionsbot
Loading

Fix 26 warnings inlibrary/unittest.mock.rst:

Before:

❯make -C Doc html SPHINXOPTS="-n -W --keep-going" SOURCES="library/unittest.mock.rst"2>&1| grep WARNING| tee>(wc -l)library/unittest.mock.rst:71: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:740: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec_set [ref.attr]library/unittest.mock.rst:1177: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1199: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1199: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1215: WARNING: py:attr reference target not found: mock.return_value [ref.attr]library/unittest.mock.rst:1215: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1234: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1234: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1248: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:1287: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:1458: WARNING: py:class reference target not found: TestCase [ref.class]library/unittest.mock.rst:1495: WARNING: py:attr reference target not found: return_value [ref.attr]library/unittest.mock.rst:1818: WARNING: py:meth reference target not found: start [ref.meth]library/unittest.mock.rst:1818: WARNING: py:meth reference target not found: stop [ref.meth]library/unittest.mock.rst:1822: WARNING: py:meth reference target not found: start [ref.meth]library/unittest.mock.rst:1822: WARNING: py:meth reference target not found: stop [ref.meth]library/unittest.mock.rst:1840: WARNING: py:class reference target not found: TestCase [ref.class]library/unittest.mock.rst:2204: WARNING: py:meth reference target not found: MagicMock.__iter__ [ref.meth]library/unittest.mock.rst:2512: WARNING: py:const reference target not found: mock.FILTER_DIR [ref.const]library/unittest.mock.rst:2529: WARNING: py:meth reference target not found: io.IOBase.read [ref.meth]library/unittest.mock.rst:2540: WARNING: py:meth reference target not found: io.IOBase.read [ref.meth]library/unittest.mock.rst:2593: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:2618: WARNING: py:mod reference target not found: mock [ref.mod]library/unittest.mock.rst:2618: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:2657: WARNING: py:class reference target not found: request.Request [ref.class]library/unittest.mock.rst:2657: WARNING: py:class reference target not found: request.Request [ref.class]library/unittest.mock.rst:2673: WARNING: py:class reference target not found: Request [ref.class]library/unittest.mock.rst:2673: WARNING: py:class reference target not found: request.Request [ref.class]library/unittest.mock.rst:2826: WARNING: py:attr reference target not found: side_effect [ref.attr]library/unittest.mock.rst:2826: WARNING: py:attr reference target not found: return_value [ref.attr]      33

After:

❯make -C Doc html SPHINXOPTS="-n -W --keep-going" SOURCES="library/unittest.mock.rst"2>&1| grep WARNING| tee>(wc -l)library/unittest.mock.rst:740: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:763: WARNING: py:attr reference target not found: spec_set [ref.attr]library/unittest.mock.rst:1287: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:2204: WARNING: py:meth reference target not found: MagicMock.__iter__ [ref.meth]library/unittest.mock.rst:2593: WARNING: py:attr reference target not found: spec [ref.attr]library/unittest.mock.rst:2618: WARNING: py:attr reference target not found: spec [ref.attr]       7

Issue:Fix all Sphinx reference warnings in the documentation #101100

📚 Documentation preview 📚:https://cpython-previews--124106.org.readthedocs.build/

Fix Sphinx warnings in library/unittest.mock.rst

f77e1a6

hugovk added docs

Documentation in the Doc dir

skip news labels

Sep 15, 2024

bedevere-appbot added the awaiting core review label

Sep 15, 2024

bedevere-appbot mentioned this pull request

Sep 15, 2024

Fix all Sphinx reference warnings in the documentation#101100

Open

picnixz reviewed

Sep 16, 2024

View reviewed changes

Doc/library/unittest.mock.rst Outdated

		Normally the :attr:`__class__` attribute of an object will return its type.
		For a mock object with a :attr:`spec`,``__class__`` returns the spec class
		Normally the :attr:`!__class__` attribute of an object will return its type.
		For a mock object with a :attr:`spec`,:attr:`!__class__` returns the spec class

Copy link

Member

picnixzSep 16, 2024•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thespec attribute seems to be missing or is it an inherited one? (Maybe we could fix it in this PR directly?). Or is it a Sphinx issue?

Copy link

MemberAuthor

hugovkSep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think it (andspec_set) are just missing documentation underhttps://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock

For example, here'sside_effect:

https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.side_effect

Would you like to suggest some text?

Copy link

Member

picnixzSep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I never used it so I cannot really suggest a good text. I'll leave that task to unittest experts! but we can do it in another PR otherwise.

hugovk added needs backport to 3.12

only security fixes

needs backport to 3.13bugs and security fixes labels

Sep 16, 2024

vstinner reviewed

Sep 16, 2024

View reviewed changes

Doc/library/unittest.mock.rst Outdated

		@@ -2615,7 +2615,7 @@ unit tests. Testing everything in isolation is all fine and dandy, but if you
		don't test how your units are "wired together" there is still lots of room
		for bugs that tests might have caught.

		:mod:`mock` already provides a feature to help with this, called speccing. If you
		:mod:`unittest.mock` already provides a feature to help with this, called speccing. If you
		use a class or instance as the :attr:`spec` for a mock then you can only access

Copy link

Member

vstinnerSep 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

There is a warning on "spec" here.

Copy link

MemberAuthor

hugovkSep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Yep, it's not yet documented, can you suggest some text for it? Also forspec_set?

Copy link

Member

vstinnerSep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Maybe just write:attr:`!spec`.

Copy link

MemberAuthor

hugovkSep 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Done, and also forspec_set.

Silence Sphinx warnings for spec and spec_set

5e8e6b8

hugovk merged commita5716a3 intopython:main

Oct 9, 2024

23 checks passed

hugovk deleted the docs-fix-sphinx-warnings-unittest.mock branch

October 9, 2024 14:02

Copy link

miss-islington-appbot commentedOct 9, 2024

Thanks@hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

bedevere-appbot removed the awaiting core review label

Oct 9, 2024

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Oct 9, 2024

pythongh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst(p…

4d33e2a

…ythonGH-124106)(cherry picked from commita5716a3)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Oct 9, 2024

pythongh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst(p…

25fe750

…ythonGH-124106)(cherry picked from commita5716a3)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

Copy link

bedevere-appbot commentedOct 9, 2024

GH-125190 is a backport of this pull request to the3.13 branch.

bedevere-appbot removed the needs backport to 3.13bugs and security fixes label

Oct 9, 2024

Copy link

bedevere-appbot commentedOct 9, 2024

GH-125191 is a backport of this pull request to the3.12 branch.

bedevere-appbot removed the needs backport to 3.12only security fixes label

Oct 9, 2024

hugovk added a commit that referenced this pull request

Oct 9, 2024

[3.13]gh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst(G…

ab5f179

…H-124106) (#125190)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

hugovk added a commit that referenced this pull request

Oct 9, 2024

[3.12]gh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst(G…

7187d4f

…H-124106) (#125191)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

Labels

docs

Documentation in the Doc dir

skip news

3 participants

Movatterモバイル変換

Uh oh!

gh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst#124106

gh-101100: Fix Sphinx warnings inlibrary/unittest.mock.rst#124106

Uh oh!

Conversation

hugovk commentedSep 15, 2024• edited by github-actionsbotLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

picnixzSep 16, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hugovkSep 16, 2024

Choose a reason for hiding this comment

Uh oh!

picnixzSep 16, 2024

Choose a reason for hiding this comment

Uh oh!

vstinnerSep 16, 2024

Choose a reason for hiding this comment

Uh oh!

hugovkSep 17, 2024

Choose a reason for hiding this comment

Uh oh!

vstinnerSep 17, 2024

Choose a reason for hiding this comment

Uh oh!

hugovkSep 23, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-appbot commentedOct 9, 2024

Uh oh!

bedevere-appbot commentedOct 9, 2024

Uh oh!

bedevere-appbot commentedOct 9, 2024

Uh oh!

Uh oh!

gh-101100: Fix Sphinx warnings in`library/unittest.mock.rst`#124106

gh-101100: Fix Sphinx warnings in`library/unittest.mock.rst`#124106

hugovk commentedSep 15, 2024•
edited by github-actionsbot
Loading

picnixzSep 16, 2024•
edited
Loading