Adds incremental module creator to magic #883
Merged
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
The idea is simple. Allow one to build up a module easily and quickly. This is useful when explaining a concept. Example use: ``` %%incr_cell_to_module -m doc_pipeline -i 5 --display ``` The idea is that you can partition creating a module over multiple cells. The ONLY CAVEAT is that you maintain a unique identifier (int or string) for each cell so that they can are distinct; i.e. it's possible to override an earlier cell if you use the same identifier. Note: we use the sorted set of identifiers and build the module up in order of that. This is probably an unused feature, since we expect most people to logically increment the identifier and order things correctly top to bottom. There are some utility methods to help reset state. Otherwise I duplicate some logic, since it wasn't easy to refactor. I centralized logic where it made sense, and then removed rebuild drivers from incremental -- we can always add it in.
elijahbenizzy
approved these changes
May 3, 2024
hamilton/plugins/jupyter_magic.py
Outdated
| @@ -260,6 +248,157 @@ def insert_module(self, line): | |||
| # insert source code as text in the next cell | |||
| self.shell.set_next_input(header + module_source, replace=False) | |||
|
|
|||
| @magic_arguments() # needed on top to enable parsing | |||
| @argument( | |||
There was a problem hiding this comment.
Better to use a deafult value here? See docs: https://ipython.readthedocs.io/en/stable/api/generated/IPython.core.magic_arguments.html.
There was a problem hiding this comment.
we'll refactor to match jupyter v2 once we're there
Propagates that to other functions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The idea is simple. Allow one to build up a module easily and quickly. This is useful when explaining a concept.
Example use:
The idea is that you can partition creating a module over multiple cells. The ONLY CAVEAT is that you maintain a unique identifier (int or string) for each cell so that they can are distinct; i.e. it's possible to override an earlier cell if you use the same identifier. Note: we use the sorted set of identifiers and build the module up in order of that. This is probably an unused feature, since we expect most people to logically increment the identifier and order things correctly top to bottom.
There are some utility methods to help reset state. Otherwise I duplicate some logic, since it wasn't easy to refactor. I centralized logic where it made sense.
Changes
incr_cell_to_modulecell magic.print_moduleline magic to print what's createdreset_moduleline magic to reset an incremental module.How I tested this
Notes
Checklist