Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Continuing strs when broken across lines #69

Open
Ricyteach opened this issue Sep 30, 2020 · 9 comments
Open

Continuing strs when broken across lines #69

Ricyteach opened this issue Sep 30, 2020 · 9 comments
Labels
enhancement New feature or request

Comments

@Ricyteach
Copy link

Love the extension. Thanks for the work.

It would be great if str literals could be continued when broken across lines.

I had a line of code Like this:

my_str = f"{steps: >5d}    3    1    3    0{nodes: >5d}{elements: >5d}{boundaries: >5d}{materials: >5d}{optional(interfaces, ' >5d'):s}    1"

...and (with the help of Python Indent) reformatted it like this:

my_str = (f"{steps: >5d}    3    1    3    0"
          f"{nodes: >5d}{elements: >5d}"
          f"{boundaries: >5d}{materials: >5d}"
          f"{optional(interfaces, ' >5d'):s}    1")

A cool feature would be to have the quotation marks (with preceding f) automatically inserted.

@kbrose
Copy link
Owner

kbrose commented Oct 6, 2020

Interesting idea, thanks for posting. So you're thinking something like this?

# | indicates cursor location

# case 1, no f-string
s = "really long| string"

s = ("really long"
     "| string")

# case 2, f-string
s = f"another {really} long| string"

s = (f"another {really} long"
     f" string")

# note that r, u, rf, fr, b, rb, and br are all allowed prefixes
# and should be handled in the same way as f-strings

I don't remember if the python parser picks up on whether the string was prefixed with anything, but would probably not be terrible to add if not.

@kbrose
Copy link
Owner

kbrose commented Oct 6, 2020

Reading back through the parsing code I wrote, I'd have to add another tracker for any combination of f, r, u, rf, fr, b, rb, and br and keep it on hand if the next character turns out to start a string. The output of that parsing function would have to be updated with this information, as well as the string delimiter (', ", ''', """).

@Ricyteach
Copy link
Author

Ricyteach commented Oct 6, 2020

That's pretty much what I had in mind! Thanks for taking it under consideration.

If it makes it less complicated I would not necessarily consider adding the parentheses around the string as a "must have"... after all it is really easy to add parentheses around an expression by selecting it and hitting ( already.

So maybe the behavior should be like:

# | indicates cursor location

# case 1, no parentheses => no change in behavior
s = "really long| string"

s = "really long
     | string"

# case 2, after adding parentheses => change in behavior
s = ("really long| string")

s = ("really long"
     "| string")

@kbrose
Copy link
Owner

kbrose commented Oct 21, 2020

I looked into this a little more, and concluded that this would require a moderate change to the parser to keep track of what column the string started on.

@Ricyteach
Copy link
Author

Thanks for looking into it. "Moderate" sounds like a decent amount of effort would be required.

@kbrose
Copy link
Owner

kbrose commented Oct 21, 2020

I think the crux of it would be adding several new pieces of information to the current parser. This is what it currently outputs:

export interface IParseOutput {
    canHang: boolean;
    dedentNext: boolean;
    lastClosedRow: number[];
    lastColonRow: number;
    openBracketStack: number[][];
}

We'd need to add a something to track what column the string delimiter was on (null if we're not in a string), what the string delimiter was (so we know to add a single or double quote), whether the string had any prefixes (u, f, etc.), and possibly whether we're within a closing parentheses. So the interface would end up looking something like this:

export interface IParseOutput {
    canHang: boolean;
    dedentNext: boolean;
    lastClosedRow: number[];
    lastColonRow: number;
    openBracketStack: number[][];
    // Additional items
    currentStringDelimiter?: string;
    stringStartColumn?: number;
    stringPrefix?: string;
    insideParentheses: boolean; // maybe
}

@Ricyteach
Copy link
Author

Does the plugin have to handle undo on its own, or is that taken care of by VSCode?

@kbrose
Copy link
Owner

kbrose commented Oct 27, 2020

The edits are bundled into a single "transaction" so that VSCode groups them into a single undo/redo action

@kbrose kbrose added the enhancement New feature or request label Oct 27, 2020
@Marcosalen
Copy link

I would like to know if this feature has already been implemented in the extension?

pycharm does something very similar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants