Skip to content

Commit 2c5e529

Browse files
authored
Merge pull request #809 from fasiha/blocklist-for-inspector
Send omit_sections to IPython to choose which sections of documentation you don't want
2 parents 1309925 + ff8d5ea commit 2c5e529

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

ipykernel/ipkernel.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -459,19 +459,27 @@ def _experimental_do_complete(self, code, cursor_pos):
459459
'metadata': {_EXPERIMENTAL_KEY_NAME: comps},
460460
'status': 'ok'}
461461

462-
def do_inspect(self, code, cursor_pos, detail_level=0):
462+
def do_inspect(self, code, cursor_pos, detail_level=0, omit_sections=()):
463463
name = token_at_cursor(code, cursor_pos)
464464

465465
reply_content = {'status' : 'ok'}
466466
reply_content['data'] = {}
467467
reply_content['metadata'] = {}
468468
try:
469-
reply_content['data'].update(
470-
self.shell.object_inspect_mime(
469+
if release.version_info >= (8,):
470+
# `omit_sections` keyword will be available in IPython 8, see
471+
# https://github.com/ipython/ipython/pull/13343
472+
bundle = self.shell.object_inspect_mime(
473+
name,
474+
detail_level=detail_level,
475+
omit_sections=omit_sections,
476+
)
477+
else:
478+
bundle = self.shell.object_inspect_mime(
471479
name,
472480
detail_level=detail_level
473481
)
474-
)
482+
reply_content['data'].update(bundle)
475483
if not self.shell.enable_html_pager:
476484
reply_content['data'].pop('text/html')
477485
reply_content['found'] = True

ipykernel/kernelbase.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,7 @@ async def inspect_request(self, stream, ident, parent):
702702
reply_content = self.do_inspect(
703703
content['code'], content['cursor_pos'],
704704
content.get('detail_level', 0),
705+
set(content.get('omit_sections', [])),
705706
)
706707
if inspect.isawaitable(reply_content):
707708
reply_content = await reply_content
@@ -712,7 +713,7 @@ async def inspect_request(self, stream, ident, parent):
712713
reply_content, parent, ident)
713714
self.log.debug("%s", msg)
714715

715-
def do_inspect(self, code, cursor_pos, detail_level=0):
716+
def do_inspect(self, code, cursor_pos, detail_level=0, omit_sections=()):
716717
"""Override in subclasses to allow introspection.
717718
"""
718719
return {'status': 'ok', 'data': {}, 'metadata': {}, 'found': False}

0 commit comments

Comments
 (0)