Skip to content

Send omit_sections to IPython to choose which sections of documentation you don't want #809

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
blink1073 merged 3 commits into from
Nov 29, 2021
Merged

Send omit_sections to IPython to choose which sections of documentation you don't want #809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77cdd28
Send omit_sections to IPython if available
Nov 19, 2021
0bdfd0b
Make backwards-compatible
Nov 29, 2021
ff8d5ea
clean up accidental import added by editor
Nov 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions ipykernel/ipkernel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,19 +459,27 @@ def _experimental_do_complete(self, code, cursor_pos):
'metadata': {_EXPERIMENTAL_KEY_NAME: comps},
'status': 'ok'}

def do_inspect(self, code, cursor_pos, detail_level=0):
def do_inspect(self, code, cursor_pos, detail_level=0, omit_sections=()):
name = token_at_cursor(code, cursor_pos)

reply_content = {'status' : 'ok'}
reply_content['data'] = {}
reply_content['metadata'] = {}
try:
reply_content['data'].update(
self.shell.object_inspect_mime(
if release.version_info >= (8,):
# `omit_sections` keyword will be available in IPython 8, see
# https://github.com/ipython/ipython/pull/13343
bundle = self.shell.object_inspect_mime(
name,
detail_level=detail_level,
omit_sections=omit_sections,
)
else:
bundle = self.shell.object_inspect_mime(
name,
detail_level=detail_level
)
)
reply_content['data'].update(bundle)
if not self.shell.enable_html_pager:
reply_content['data'].pop('text/html')
reply_content['found'] = True
Expand Down
3 changes: 2 additions & 1 deletion ipykernel/kernelbase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,7 @@ async def inspect_request(self, stream, ident, parent):
reply_content = self.do_inspect(
content['code'], content['cursor_pos'],
content.get('detail_level', 0),
set(content.get('omit_sections', [])),
)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
Expand All @@ -712,7 +713,7 @@ async def inspect_request(self, stream, ident, parent):
reply_content, parent, ident)
self.log.debug("%s", msg)

def do_inspect(self, code, cursor_pos, detail_level=0):
def do_inspect(self, code, cursor_pos, detail_level=0, omit_sections=()):
"""Override in subclasses to allow introspection.
"""
return {'status': 'ok', 'data': {}, 'metadata': {}, 'found': False}
Expand Down