Expand a bit the documentation about transformers. #10391
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
Mostly answering questions I had myself while trying to write some stuff and while trying to get a simple example working.
takluyver
reviewed
Mar 15, 2017
IPython/core/inputsplitter.py
Outdated
| @@ -687,7 +686,6 @@ def push(self, lines): | |||
| """ | |||
|
|
|||
| # We must ensure all input is pure unicode | |||
| lines = cast_unicode(lines, self.encoding) | |||
There was a problem hiding this comment.
Why is this changed in a doc PR? If you're sure removing it is OK, please remove the comment too.
takluyver
reviewed
Mar 15, 2017
| :class:`~IPython.core.inputtransformer.Inputtransformer` and overwriting the | ||
| ``push`` and ``reset`` methods. The reset method should send the full block of | ||
| transformed text. As an example a transformer the reversed the lines from last | ||
| to first. |
There was a problem hiding this comment.
We should say that this will break the automatic 'is this input complete' detection in console interfaces - with a transformer like this added, it will always think more input is needed, and you will need to use a shortcut to force it to execute.
takluyver
reviewed
Mar 15, 2017
| This code in IPython strips a constant amount of leading indentation from each | ||
| line in a cell:: | ||
|
|
||
| from IPython.core.inputtransformer import CoroutineInputTransformer |
There was a problem hiding this comment.
Do you want to add the import to your new example above too?
willingc
reviewed
Mar 15, 2017
| You may use :meth:`CoroutineInputTransformer.wrap` to simplify the creation of | ||
| such a transformer. | ||
|
|
||
| Here is a simple :class:`CoroutineInputTransformer` that can be though of be |
takluyver
reviewed
Mar 21, 2017
| .. warning:: | ||
|
|
||
| Transforming a full block at once will break the automatic detection of | ||
| wether a block of code is complete in interface relying on this |
takluyver
reviewed
Mar 21, 2017
|
|
||
| Transforming a full block at once will break the automatic detection of | ||
| wether a block of code is complete in interface relying on this | ||
| functionality, as for example terminal IPython. You will need to use a |
There was a problem hiding this comment.
'as for example' doesn't work in English. You could use 'such as', 'including', or 'for example'.
('such as, for example, foo' is valid, but it's too verbose to read nicely here, IMO)
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.
Mostly answering questions I had myself while trying to write some stuff
and while trying to get a simple example working.