Skip to content

Only build the fancy docstring when in an IPython context #774

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

Jump to bottom
Merged
merged 1 commit into from
Jul 24, 2023
Merged

Only build the fancy docstring when in an IPython context #774

merged 1 commit into from
Jul 24, 2023

Conversation

maximlt
Copy link
Member

@maximlt maximlt commented Jun 28, 2023 •
edited
Loading

I was a little surprised to see that Param was always building a docstring for IPython even not in an IPython context. This also came with some side-effects as the pager calls .param.objects() which leads to the Parameters being cached on the class:

param/param/ipython.py

Line 63 in b96169f

params = dict(obj.param.objects('existing'))

This can only improve the performance of loading modules with lots of Parameterized classes that have lots of Parameters, no idea by how much though!

However, this of course also affects how the docstring look like in a non IPython context, e.g. in the Python REPL.

Before (colorized output):

>>> import param
>>> class P(param.Parameterized):
...   """The class docstring"""
...   x = param.Parameter()
... 
>>> p = P()
>>> print(p.__doc__)
params(x=Parameter, name=String)
The class docstring
Parameters of 'P'
=================

Parameters changed from their default values are marked in red.
Soft bound values are marked in cyan.
C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None

NameValue     Type      Mode  

x   None  Parameter  V RW AN 

Parameter docstrings:
=====================

x: < No docstring available >

With this change:

>>> import param
>>> class P(param.Parameterized):
...   """The class docstring"""
...   x = param.Parameter()
... 
>>> p = P()
>>> print(p.__doc__)
params(x=Parameter, name=String)
The class docstring

jbednar
jbednar approved these changes Jul 23, 2023
View reviewed changes
Copy link
Member

@jbednar jbednar left a comment

Choose a reason for hiding this comment

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

Sounds like a good idea!

@maximlt maximlt merged commit 00a5b85 into main Jul 24, 2023
@maximlt maximlt deleted the check_ipython branch July 24, 2023 08:53
@maximlt maximlt mentioned this pull request Jul 30, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jbednar jbednar jbednar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maximlt @jbednar