Make ITables robust to HTML display order (offline mode, VS Code) #427
Conversation
|
Thank you for making this pull request. Did you know? You can try it on Binder: Also, the version of ITables developed in this PR can be installed with (this requires |
There was a problem hiding this comment.
Pull Request Overview
This PR makes ITables robust to HTML display order in offline mode by implementing event-driven initialization that works even when the initialization cell is rendered after the table cells. This addresses issues in VS Code where display order isn't guaranteed.
- Refactored offline mode to use event-driven initialization with custom events
- Split template files for cleaner separation between online and offline modes
- Updated test expectations to match new error message format and file size changes
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/itables/javascript.py | Refactored replace_value function and offline template generation with event-driven approach |
| src/itables/html/init_notebook_offline.html | New template for offline initialization with event dispatching |
| src/itables/html/datatables_template_offline.html | New offline-specific table template with event listening |
| tests/test_javascript.py | Updated tests for improved replace_value function with expected_count parameter |
| tests/test_connected_notebook_is_small.py | Adjusted file size expectations for offline notebooks |
| src/itables/version.py | Bumped version to 2.5.0-dev |
| docs/changelog.md | Added changelog entry for the fix |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| count = template.count(pattern) | ||
| if not count: | ||
| raise ValueError("pattern={} was not found in template".format(pattern)) | ||
| elif count > 1: | ||
| if count != expected_count: | ||
| raise ValueError( | ||
| "pattern={} was found multiple times ({}) in template".format( | ||
| pattern, count | ||
| ) | ||
| f"{pattern=} was found {count} times in template, expected {expected_count}." |
There was a problem hiding this comment.
The error message should use consistent formatting. Either use f-string format for both pattern and count, or use traditional string formatting for consistency with the rest of the codebase.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #427 +/- ##
==========================================
+ Coverage 88.11% 88.14% +0.02%
==========================================
Files 50 50
Lines 2020 2025 +5
==========================================
+ Hits 1780 1785 +5
Misses 240 240 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Closes #424