-install with --keep-* options #188
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
* Add command line argument keep-id, which maintiains randomly generated cell ids. Otherwise cell ids are assigned incrementally (after the removal of cells), which should keep them consistent across runs in version control * Modify test_cell and test_exception in test_keep_output_tags.py to use the new strip_output signature * Fix failed test_end_to_end_nbstripout with test_max_size by passing --keep-id for keeping the existing ids * Add tests for notebooks with and without the --keep-id flag. A new extension expected_id was added for expected output with ordered ids * Modify the readme to include the --include-id flag * Add keyword arguments for None inputs in test_keep_output_tags.py * Rename expected output files to make desired sequential ids more explicit Co-authored-by: Florian Rathgeber <[email protected]>
* Clarify that extra keys may _only_ specify notebook and cell metadata to be stripped. * Update metadata stripped by default. Addresses #187
kynan
reviewed
Jan 26, 2024
README.rst
Outdated
| @@ -34,7 +34,7 @@ Based on https://gist.github.com/minrk/6176788. | |||
| Python 3 only | |||
| ============= | |||
|
|
|||
| As of version 0.6.1, nbstripout supports Python 3 *only*. If you need to use | |||
| As of version 0.6.2, nbstripout supports Python 3 *only*. If you need to use | |||
nbstripout/_nbstripout.py
Outdated
Comment on lines
221
to
222
| if keep_args: | ||
| filepath = filepath + ' '.join(keep_args) |
There was a problem hiding this comment.
I think I'd rather configure these options via the git config directly i.e. if you want to use keep_output with the git filter, you set git config --type bool filter.nbstripout.keepOutput true and then we read that value to provide the default for keep_output.
There was a problem hiding this comment.
Makes sense. Here's my take on this:
- I am passing
extra_flagstoinstall()anduninstall()that keep track of the three flagskeep_output,keep_idandkeep_count, so they can be cleaned up. - Since the underscores don't work for git config names, I am converting to camelCase
- If these flags are set in the cmd args, that will override whatever git config values are
- If the flags are not passed as the cmd args, do not exist in git config (e.g. running nbstripout without install), then they will be False
kynan
reviewed
Feb 10, 2024
There was a problem hiding this comment.
Sorry for my lack of follow up: I think I'd prefer addressing this differently, see #189. I have some preliminary implementation for this which I've pushed to a branch, PTAL :)
Comment on lines
+159
to
+165
| def snake_to_camel_case(string): | ||
| """Converts snake_case string to camelCase.""" | ||
| if '_' not in string: | ||
| return string | ||
| string_parts = string.split('_') | ||
| camel_parts = [part[0].upper() + part[1:] for part in string_parts[1:] if part != ''] | ||
| return string_parts[0] + ''.join(camel_parts) |
There was a problem hiding this comment.
Suggested change
| def snake_to_camel_case(string): | |
| """Converts snake_case string to camelCase.""" | |
| if '_' not in string: | |
| return string | |
| string_parts = string.split('_') | |
| camel_parts = [part[0].upper() + part[1:] for part in string_parts[1:] if part != ''] | |
| return string_parts[0] + ''.join(camel_parts) | |
| def to_lower_camel_case(s): | |
| """Converts snake_case string to lowerCamelCase.""" | |
| head, *tail = s.split('_') | |
| return head + ''.join(p.title() for p in tail) |
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.
Hi, I would like to contribute a PR that resolves this issue:
#150 :
--installwith other (--keep-*) optionsinstall()function, which concatenates those options into the.git/configLet me know what you think. Thank you!