Logger Widget Panel #2872

atharva-2001 · 2024-11-11T09:07:27Z

📝 Description

Write a complete description of your changes, including the necessary context or any piece of information required to understand your work.

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

Testing pipeline
Other method (describe)
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

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

review-notebook-app · 2024-11-11T09:07:32Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

tardis-bot · 2024-11-11T09:09:03Z

*beep* *bop*
Hi human,
I ran ruff on the latest commit (e2db2b1).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

17	W293  	[*] Blank line contains whitespace
8	G004  	[ ] Logging statement uses f-string
5	F405  	[ ] `exclude_patterns` may be undefined, or defined from star imports
3	FA102 	[*] Missing `from __future__ import annotations`, but uses PEP 585 collection
3	F401  	[*] `IPython.display.display` imported but unused
3	UP015 	[*] Unnecessary open mode parameters
2	I001  	[*] Import block is un-sorted or un-formatted
2	E402  	[ ] Module level import not at top of file
2	W291  	[*] Trailing whitespace
2	W605  	[*] Invalid escape sequence: `\A`
1	RET505	[ ] Unnecessary `else` after `return` statement
1	RET506	[ ] Unnecessary `else` after `raise` statement
1	E712  	[*] Avoid equality comparisons to `True`; use `if toml_config_tool_dict["tardis"]['edit_on_github']:` for truth checks
1	E902  	[ ] No such file or directory (os error 2)
1	W292  	[*] No newline at end of file
1	D204  	[*] 1 blank line required after class docstring
1	PGH004	[ ] Use specific rule codes when using `noqa`
1	UP009 	[*] UTF-8 encoding declaration is unnecessary
1	UP030 	[*] Use implicit references for positional format fields
1	UP032 	[*] Use f-string instead of `format` call
1	TRY300	[ ] Consider moving this statement to an `else` block

Complete output(might be large):

docs/conf.py:1:1: UP009 [*] UTF-8 encoding declaration is unnecessary
docs/conf.py:27:1: I001 [*] Import block is un-sorted or un-formatted
docs/conf.py:30:8: F401 [*] `tardis` imported but unused
docs/conf.py:36:43: PGH004 Use specific rule codes when using `noqa`
docs/conf.py:46:6: UP015 [*] Unnecessary open mode parameters
docs/conf.py:67:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:68:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:69:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:70:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:71:1: F405 `exclude_patterns` may be undefined, or defined from star imports
docs/conf.py:140:1: W293 Blank line contains whitespace
docs/conf.py:175:1: W293 Blank line contains whitespace
docs/conf.py:192:13: UP030 Use implicit references for positional format fields
docs/conf.py:192:13: UP032 [*] Use f-string instead of `format` call
docs/conf.py:219:1: E402 Module level import not at top of file
docs/conf.py:292:4: E712 Avoid equality comparisons to `True`; use `if toml_config_tool_dict["tardis"]['edit_on_github']:` for truth checks
docs/conf.py:359:1: E402 Module level import not at top of file
docs/conf.py:374:10: UP015 [*] Unnecessary open mode parameters, use ""w""
docs/conf.py:389:10: UP015 [*] Unnecessary open mode parameters, use ""w""
docs/quickstart.ipynb:cell 13:1:39: W291 [*] Trailing whitespace
docs/quickstart.ipynb:cell 13:5:35: W291 [*] Trailing whitespace
docs/quickstart.ipynb:cell 18:10:26: W605 [*] Invalid escape sequence: `\A`
docs/quickstart.ipynb:cell 18:11:40: W605 [*] Invalid escape sequence: `\A`
tardis/io/logger/__init__.py:4:37: F401 `tardis.io.logger.logger.logger_widget` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/io/logger/__init__.py:4:50: W292 [*] No newline at end of file
tardis/io/logger/colored_logger.py:1:1: E902 No such file or directory (os error 2)
tardis/io/logger/logger.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/logger/logger.py:41:13: FA102 Missing `from __future__ import annotations`, but uses PEP 585 collection
tardis/io/logger/logger.py:50:13: FA102 Missing `from __future__ import annotations`, but uses PEP 585 collection
tardis/io/logger/logger.py:50:18: FA102 Missing `from __future__ import annotations`, but uses PEP 604 union
tardis/io/logger/logger.py:58:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:80:21: G004 Logging statement uses f-string
tardis/io/logger/logger.py:126:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:128:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:137:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:140:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:149:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:160:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:166:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:170:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:176:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:180:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:187:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:191:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:194:1: W293 [*] Blank line contains whitespace
tardis/io/logger/logger.py:204:5: D204 [*] 1 blank line required after class docstring
tardis/io/logger/logger.py:207:1: W293 [*] Blank line contains whitespace
tardis/simulation/base.py:8:29: F401 [*] `IPython.display.display` imported but unused
tardis/simulation/base.py:197:13: RET506 Unnecessary `else` after `raise` statement
tardis/simulation/base.py:261:17: G004 Logging statement uses f-string
tardis/simulation/base.py:268:9: RET505 Unnecessary `else` after `return` statement
tardis/simulation/base.py:449:13: G004 Logging statement uses f-string
tardis/simulation/base.py:547:13: G004 Logging statement uses f-string
tardis/simulation/base.py:636:21: G004 Logging statement uses f-string
tardis/simulation/base.py:639:13: G004 Logging statement uses f-string
tardis/simulation/base.py:644:13: G004 Logging statement uses f-string
tardis/simulation/base.py:695:13: TRY300 Consider moving this statement to an `else` block
tardis/simulation/base.py:697:26: G004 Logging statement uses f-string
Found 58 errors.
[*] 30 fixable with the `--fix` option (7 hidden fixes can be enabled with the `--unsafe-fixes` option).

docs/quickstart.ipynb

tardis-bot · 2024-11-25T14:47:36Z

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

tardis/io/logger/logger.py

andrewfullard · 2024-11-26T15:14:33Z

tardis/io/logger/logger.py

+        self.futures = []
+
+        # Single event loop and thread for all environments
+        self.loop = asyncio.new_event_loop()


Why do we need this to be created for environments outside of a notebook? e.g. what happens if you run TARDIS in the command line?

I'm afraid it creates a new loop there too. Do we want to show the logs in the terminal or do we want to show it as a Panel widget in the browser(it would be deployed on some port)? If it is the first case then I will change it so that this mechanism only works with VSCode and Jupyter Notebooks(since those are the places where we would be seeing the widget). Does that sound alright to you?

Yes, please make the logs just print to terminal for CLI use of TARDIS.

Sure, this change does that- 03d34f1#diff-2f4aaca893bcc603dd023f49b86f7243a7a52d1078eec0b6fa5742dd8da8d882

tardis/base.py

andrewfullard · 2024-12-02T15:03:26Z

tardis_env3.yml

@@ -37,6 +37,9 @@ dependencies:
  - matplotlib-base
  - ipywidgets
  - plotly
+  - panel
+  - watchfiles


What is this used for?

Panel recommends this library during installation, so I put it there.
https://panel.holoviz.org/getting_started/installation.html#installing-panel

Hmm, seems to be for development purposes. I'm not sure if we want it as part of the standard TARDIS environment. @wkerzendorf thoughts?

andrewfullard · 2024-12-11T14:05:19Z

I really don't like pinning notebook to an earlier version. There were major improvements in 7.x.

Also by default widget is disable in CLI

atharva-2001 added the documentation label Nov 11, 2024

atharva-2001 added the build-docs label Nov 15, 2024

atharva-2001 marked this pull request as ready for review November 15, 2024 08:16

andrewfullard reviewed Nov 18, 2024

View reviewed changes

docs/quickstart.ipynb Outdated Show resolved Hide resolved

atharva-2001 mentioned this pull request Nov 25, 2024

Logger Widget 2 (based on #2700) #2867

Closed

6 tasks

KasukabeDefenceForce removed the build-docs label Nov 25, 2024

atharva-2001 force-pushed the logger_widget_panel branch from 8902d28 to 75f09b9 Compare November 25, 2024 14:40

wkerzendorf reviewed Nov 25, 2024

View reviewed changes

tardis/io/logger/logger.py Outdated Show resolved Hide resolved

andrewfullard reviewed Nov 26, 2024

View reviewed changes

atharva-2001 requested review from andrewfullard and wkerzendorf December 2, 2024 13:54

atharva-2001 force-pushed the logger_widget_panel branch from 0ab316e to 8fa0692 Compare December 2, 2024 13:55

andrewfullard reviewed Dec 2, 2024

View reviewed changes

atharva-2001 force-pushed the logger_widget_panel branch from b4f07d3 to 1483ee1 Compare December 9, 2024 10:15

atharva-2001 force-pushed the logger_widget_panel branch 2 times, most recently from cc35495 to 1a0d44e Compare December 16, 2024 08:11

atharva-2001 added 10 commits December 16, 2024 16:00

Add widget in a separate cell

c00d1c5

Add Panel based logger widget

bd888c3

Panel pyodide settings

7eb850b

Modify quickstart to embed the widget

43dbb92

Delete coloured logger and plasma dataframes output

af7d676

Install panel in actions

cb645cc

Run workflow

ed9de21

Add panel, watchfiles and nbsite to environment

f7e2c48

Change action.yml to use current lockfile

7f3d903

Trigger documentation

4e9fbdc

atharva-2001 added 27 commits December 16, 2024 16:00

Reset setup_env

d779149

Reset quickstart

ddad301

replace recfromtext with genfromtxt

d5a6985

Rename TardisLogger to TARDISLogger

9e49dc3

Remove comment

18ea788

Refactor code and make warnings module logger global

b59c799

Close loop and clean up tasks

41eb4d1

Remove unused Future variable

7750254

Add option to disable widget and display logs without formatting

f150ea1

Also by default widget is disable in CLI

Replacing HTML with Panel terminal

1a1c6df

logger run_thread

256e8d8

Works without async in both environments

11184c0

Remove test logger file

5f4134e

Add LOGGING_LEVELS back

e57b0dd

Ruff safe fixes

cd733ad

Ruff annotations fix

db80a24

Change parameter to display_logging_widget

3a2bd66

Make docs build verbose

5416e51

Options for genfromtxt

152c998

Replace panel.pane.HTML with panel Feed

e08800a

Update all items all at once instead of modifying the list

7095c8d

Modify conf.py for sphinx error due to update

d9162a4

Update display mechanism

2176fb5

New environment

71bd597

Reset Makefile

6797c67

Minor bugfix

a700ca7

Try conda as environment type asv for benchmarks

5738a20

atharva-2001 force-pushed the logger_widget_panel branch from 72de203 to 5738a20 Compare December 16, 2024 10:30

atharva-2001 added 2 commits December 16, 2024 18:09

Disable widget to test documentation

3dd2e4b

Replace feed with html for performance tests

571b4c9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logger Widget Panel #2872

Logger Widget Panel #2872

atharva-2001 commented Nov 11, 2024

review-notebook-app bot commented Nov 11, 2024

tardis-bot commented Nov 11, 2024 •

edited

Loading

tardis-bot commented Nov 25, 2024 •

edited

Loading

andrewfullard Nov 26, 2024

atharva-2001 Nov 27, 2024

andrewfullard Nov 27, 2024

atharva-2001 Nov 29, 2024

andrewfullard Dec 2, 2024

atharva-2001 Dec 4, 2024

andrewfullard Dec 4, 2024

andrewfullard commented Dec 11, 2024

Logger Widget Panel #2872

Are you sure you want to change the base?

Logger Widget Panel #2872

Conversation

atharva-2001 commented Nov 11, 2024

📝 Description

📌 Resources

🚦 Testing

☑️ Checklist

review-notebook-app bot commented Nov 11, 2024

tardis-bot commented Nov 11, 2024 • edited Loading

tardis-bot commented Nov 25, 2024 • edited Loading

andrewfullard Nov 26, 2024

Choose a reason for hiding this comment

atharva-2001 Nov 27, 2024

Choose a reason for hiding this comment

andrewfullard Nov 27, 2024

Choose a reason for hiding this comment

atharva-2001 Nov 29, 2024

Choose a reason for hiding this comment

andrewfullard Dec 2, 2024

Choose a reason for hiding this comment

atharva-2001 Dec 4, 2024

Choose a reason for hiding this comment

andrewfullard Dec 4, 2024

Choose a reason for hiding this comment

andrewfullard commented Dec 11, 2024

tardis-bot commented Nov 11, 2024 •

edited

Loading

tardis-bot commented Nov 25, 2024 •

edited

Loading