-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Proof of Principle for inline variables #382
Closed
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
Codecov Report
@@ Coverage Diff @@
## master #382 +/- ##
==========================================
- Coverage 87.35% 79.25% -8.10%
==========================================
Files 12 15 +3
Lines 1368 1986 +618
==========================================
+ Hits 1195 1574 +379
- Misses 173 412 +239
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See https://myst-nb--382.org.readthedocs.build/en/382/use/inline_execution.html 🎉
(this is based on top of #380, see also jupyter/nbclient#160)
The idea at present, is that these inline variables are restricted to matching the regex
r"^[a-zA-Z_][a-zA-Z0-9_]*$"
, i.e. they should be variable names, so that when they are called by the kernel, they do not change its state, e.g. you can calla
, but nota=3
.This is not strictly necessary (you can call kernel execution at any point during the parse), but it means you maintain the "mapping" with other notebook environments, wherby only code cells change the state of the kernel.
The only drawback really, is that caching execution would be a little tricky, since you would basically have to run the full docutils/sphinx parse, to see if any new variables have been inserted.