Show subprocess.Popen instead of the defused wrapper in annotations - #896
Open
DSeaStar wants to merge 1 commit into
Open
Show subprocess.Popen instead of the defused wrapper in annotations#896DSeaStar wants to merge 1 commit into
DSeaStar wants to merge 1 commit into
Conversation
Import-time mocking replaced Popen with _PdocDefusedPopen, so evaluated annotations leaked the internal class name into generated docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #819.
During import, pdoc replaces
subprocess.Popenwith_PdocDefusedPopenso modules cannot spawn unexpected processes. Evaluated annotations such asfoo: subprocess.Popen[str]then stored the wrapper type, andformatannotationrendered it aspdoc.extract._PdocDefusedPopen.Give the wrapper the same
__name__/__qualname__/__module__assubprocess.Popenso generated docs show the original type. The no-op behavior is unchanged.Test plan
test_defused_popen_annotation_displays_as_subprocess_popencoversformatannotationand a module imported throughload_module(class attribute + return annotation).