Fix for widgets displaying code in commandline

[shreyas3156]

📝 Description

Type: 🪲 bugfix

resolves #1976

The widgets displayed code when called from the command-line as shown in the issue above. This PR adds a check so that the display() methods in the widgets run only for notebooks. When called from command-line, a message "Please use a notebook to display the widget" is printed.

For the tests, I have used a pytest.Monkeypatch context manager to use a session-scoped fixture and mock the is_notebook() response.

📌 Resources

Monkeypatch.context

🚦 Testing

How did you test these changes?

• Testing pipeline
• Other method - Ran the widgets in the command-line
• My changes can't be tested (explain why)

☑️ Checklist

• I requested two reviewers for this pull request
• I updated the documentation according to my changes
• I built the documentation by applying the build_docs label

@wkerzendorf @atharva-2001

[codecov]

Codecov Report

Attention: Patch coverage is 91.76471% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 68.06%. Comparing base (f515d16) to head (6adf924).
Report is 2 commits behind head on master.

Files	Patch %	Lines
tardis/simulation/base.py	50.00%	4 Missing ⚠️
tardis/visualization/widgets/custom_abundance.py	95.83%	1 Missing ⚠️
tardis/visualization/widgets/line_info.py	93.75%	1 Missing ⚠️
tardis/visualization/widgets/shell_info.py	93.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2253      +/-   ##
==========================================
- Coverage   68.73%   68.06%   -0.68%     
==========================================
  Files         165      166       +1     
  Lines       14001    14161     +160     
==========================================
+ Hits         9624     9639      +15     
- Misses       4377     4522     +145     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[atharva-2001]

Was the issue for Convergence plots or for the custom abundance widget?
Also, I think we should raise an error but I also would like to hear what others say about this. If we do so, maybe then we would want a test that mimics the command line and see if it raises an error?

[shreyas3156]

Was the issue for Convergence plots or for the custom abundance widget?

You're right. I just noticed that the issue was created for the convergence plots. But the code was also visible for the three Widgets, so I made the changes.

I will add the checks for command-line in the Convergence plots.

Also, I think we should raise an error but I also would like to hear what others say about this. If we do so, maybe then we would want a test that mimics the command line and see if it raises an error?

Raising an error would definitely be a more prudent way to handle it.

[shreyas3156]

@atharva-2001 I have added a check where RuntimeError is raised if run_tardis is called from the command line and if show_convergence_plots is set to True (which was the only case where the code was being printed).

The default value of show_convergence_plots was set to True in simulation/base.py but False in tardis/base.py. I changed the former to False as well, otherwise the tests which simply call Simulation.from_config using the default as True would've failed.

[jamesgillanders]

@atharva-2001 Can you take a look at this please and let us know what you think?

[jamesgillanders]

@atharva-2001 Can you take a look at this please and let us know what you think?