Refactor inspect info reply logic #13863
Merged
Conversation
This file contains 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
… behavior. This factors out the logic to append an info field to the inspect_reply mimebundle and the logic for what information is in the mimebundle into separate functions that can easily be overridden by an inspector subclass. This allows a subclass to easily: * format information into yet another mimetype besides text/plain and text/html * modify or add to the default information without having to copy the default implementation.
Also simplify the formatting of the inspect reply text/plain logic
jasongrout
force-pushed
the
inspectinfo
branch
from
1e7afc7
to
eae299e
Compare
Otherwise, the default docstring <no docstring> was not displayed in html because it was acting as an html tag.
|
I was recently looking at these very lines and thinking about making the mime bundle more extendable in python-lsp/docstring-to-markdown#25 (comment). I thought it's worth a mention in case if you find that discussion useful. |
|
Nice, thanks for pointing to your other discussion there. Do you think these changes are enough to experiment with the ideas you proposed in that other comment? (I think probably they are?). Also #13865 is important to make it easy for a user to change the inspector from configuration or command line, so they can easily use a subclass that is distributed separately. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This refactors the logic of the inspector
_get_infofunction to make it easier to override and extend its behavior. This PR should not affect the overall function of_get_info.We factor out the logic to append an info field to the inspect_reply mimebundle and the logic for what information is in the mimebundle into separate functions that can easily be overridden by an inspector subclass. This allows a subclass to easily:
without having to copy the default implementation.
We also refactor and simplify the logic around formatting text/plain and text/html mimetypes in the inspect reply.
We also fix an escaping bug with the default html formatter so that the default docstrings
<no docstring>appears instead of being interpreted as an HTML tag.