◐ Shell
reader mode source ↗
Skip to content

String annotations [PEP 563]#4390

Merged
ambv merged 7 commits into
python:masterfrom
ambv:string_annotations
Jan 26, 2018
Merged

String annotations [PEP 563]#4390
ambv merged 7 commits into
python:masterfrom
ambv:string_annotations

Conversation

@gvanrossum

@gvanrossum gvanrossum commented Nov 14, 2017

Copy link
Copy Markdown
Member

This is unfinished work by @ambv. UPDATE: this is ready for review now.

I'm adding it here because patching and reviewing are easier (for me anyway) when it's in PR form. Also, @serhiy-storchaka your eye would be appreciated, esp. for the hairy AST unparsing code in C. (Also, if you had to do this from scratch, would it be easier to unparse the CST instead?)

@gvanrossum

Copy link
Copy Markdown
Member Author

I'm guessing there are still crasher bugs in here... E.g.

>>> from __future__ import string_annotations
>>> def f(a: list[str]): pass
... 
Segmentation fault: 11

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

There are crashes because the work is unfinished. Some parts still are not implemented (in particularly subscribing). Error checking is minimal if exists.

All concatenation has quadratic time. I think it is worth to implement simple accumulator that uses overallocated array and makes concatenations for linear time. Or you can reuse existing _PyBytesWriter or _PyUnicodeWriter.

Yes, maybe unparsing the CST could be much simpler. But we don't have feature flags at this stage.

@serhiy-storchaka

Copy link
Copy Markdown
Member

If unparse the AST I would move the code into a separate file. There will be a lot of code, comparable with the size of compile.c.

@ambv

ambv commented Nov 18, 2017

Copy link
Copy Markdown
Contributor

Alright, I'm going to:

  • change the future name back to annotations (yay!)
  • stick to AST unparsing
  • move this work to a separate file
  • change concatenation to use the accumulator pattern (reusing _PyBytesWriter would be great)
  • finish the functionality

@gvanrossum

Copy link
Copy Markdown
Member Author

Sounds great! I am pretty happy to see where this is going, I'd like to see it in a solid state by the time beta 1 comes around.

@ambv ambv force-pushed the string_annotations branch from b49dfa1 to c56d5bd Compare November 18, 2017 22:48
@ambv ambv changed the title [WIP] String annotations Nov 18, 2017
@ambv ambv self-assigned this Nov 18, 2017
@ambv

ambv commented Nov 18, 2017

Copy link
Copy Markdown
Contributor

All comments from Serhiy's review acted upon, the import renamed back to "annotations" like commented above. The only missing piece in the implementation is f-string support but my battery will die soon so I wanted to push this out for you to look at.

Shouldn't segfault anymore, trying to use f-strings raises an exception instead.

@ambv ambv force-pushed the string_annotations branch from c56d5bd to 1e71626 Compare November 18, 2017 22:57
@ambv

ambv commented Nov 18, 2017

Copy link
Copy Markdown
Contributor

Hm, the clang Travis CI build is failing due to invalid whitespace. make patchcheck is complaining about Include/code.h, suggesting the following diff:
https://gist.github.com/ambv/9f0874d56c7cf0d5ce98dfef38de0ce6

This diff is suggesting a lot of changes but not on the single line that I modified ¯\_(ツ)_/¯

@ambv

ambv commented Nov 18, 2017

Copy link
Copy Markdown
Contributor

I added a commit that fixes the whitespace according to the generated patch above so that I can see Travis CI passing. We can decide what to do with it later.

AppVeyor is failing because we need to modify PCbuild/* but I don't have access to a Windows box.

NEWS entry is not there yet since Blurb is tied to BPO issues and I'm wondering whether creating dummy issues for PEP work isn't redundant? I asked @larryhastings, we can also deal with this later.

@gvanrossum gvanrossum requested a review from a team as a code owner November 18, 2017 23:28
@ambv ambv added the skip news label Nov 18, 2017
@ambv ambv force-pushed the string_annotations branch from 4cdb25d to 98231af Compare November 20, 2017 19:39
@ambv ambv added skip news and removed skip news labels Nov 20, 2017
@ambv

ambv commented Nov 20, 2017

Copy link
Copy Markdown
Contributor

Changes:

  • Rebased on top of latest master
  • Added a NEWS entry (manually since this is a PEP; the bot doesn't recognize this, therefore the skip news label has to stay)
  • Moved the changes to PCbuild to the respective implementation commit ("Implement unparsing...")

This is ready for another review pass, @serhiy-storchaka. The only bit left is f-strings which is going to be a bit tedious so I'm waiting with it after a new round of feedback :-)

@ilevkivskyi

Copy link
Copy Markdown
Member

How, do we organize the updates to typing.get_type_hints() to work with "doubly quoted" strings? I mean this should still work with the __future__ import:

def f() -> List['int']:
    ...

assert get_type_hints(f)['return'] == List[int]

I suppose this can be part of the same PR, since this is not necessary in the backported version on PyPI. Also my updates to typing following PEP 560 should not have merge conflicts.

@ambv

ambv commented Nov 22, 2017

Copy link
Copy Markdown
Contributor

@ilevkivskyi, I want to fix get_type_hints() separately since there's really no reason why accepting "List['int']" shouldn't be supported even today. Same with fixing the self-class reference as you suggested on python-dev (I think I'd do it with a ChainMap though), fixing the forward ref cache conflicts, etc.

@ilevkivskyi

Copy link
Copy Markdown
Member

@ambv OK, I am fine with this as well.

@serhiy-storchaka

Copy link
Copy Markdown
Member

It will take a time for making a review of such large change. But one comment I can say now.

The unparser adds parenthesis for grouping subexpression. They are added even if not strictly needed, e.g. in a + (b * (c ** d)). The problem is not that redundant parenthesis makes an expression less readable. The problem is that they increase the stack consumption when parse the expression again. It is possible that the original expression can be parsed, but parsing the unparsed expression will fail or even crash.

I already encountered with similar problem when worked on the parser of plural form expressions in gettext.py. A C-like syntax is parsed and converted to Python syntax, and the result is evaluated. I minimized the use of parenthesis. If the subexpression operator has higher priority than the operator of the outer expression, parenthesis are not added.

This is not a blocker, and we can solve this problem later, but you can think about this while I'm making a review.

@gvanrossum

gvanrossum commented Nov 22, 2017 via email

Copy link
Copy Markdown
Member Author

@ambv

ambv commented Nov 23, 2017 via email

Copy link
Copy Markdown
Contributor

@serhiy-storchaka

Copy link
Copy Markdown
Member

Yes, in case of gettext the one of purposes was to guard against a malicious input. In the case of annotations it is less likely. The other purpose -- speeding up the compilation.

This problem can be solved by assigning the numerical priority level to expressions and omitting parenthesis only if the current priority level is higher then the level of a super-expression (the sub-expression rather of a super-expression is responsible for adding parenthesis).

I have yet two questions.

  1. Is the performance important here (I afraid yes)? The Python implementation would be simpler and more reliable. But much slower.

  2. Do we need to support the full Python expression syntax? In particular arithmetic operations. Or it would be enough to support only the small subset used in type annotations? Names, attributes, indexing, tuples, what more?

@gvanrossum

gvanrossum commented Nov 23, 2017 via email

Copy link
Copy Markdown
Member Author

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Added comments are mostly style comments (PEP 7) and suggestions for cleaning up the code, but there are several errors.

18 hidden conversations Load more…
42 hidden items Load more…
@gvanrossum

gvanrossum commented Nov 27, 2017 via email

Copy link
Copy Markdown
Member Author

@ambv

ambv commented Nov 27, 2017

Copy link
Copy Markdown
Contributor

As I said in my comment on Nov 23rd, to the best of my knowledge, the current state of the diff already omits all cases of spurious parens that occur in valid type annotations.

@serhiy-storchaka

Copy link
Copy Markdown
Member

Don't spend your time on fighting with the extra parens if this distracts you from more prioritized tasks. If you don't solve this problem in your PR I'm going to do this after its merging. I suppose this will not add too much complexity. Your code already avoid producing the extra parens in many cases. This is enough for the initial implementation.

Yet one consideration. Could it help if introduce macros like the VISIT macro in symtable.c and compile.c? They should call specified function with explicit and implicit arguments, check a result and return a failure if it is failed. Most functions could be just a short sequence of invocations of these macros. This technique is used in many places in CPython sources.

@ambv

ambv commented Nov 27, 2017

Copy link
Copy Markdown
Contributor

Could it help if introduce macros like the VISIT macro in symtable.c and compile.c?

I was thinking about this when I was originally writing this but wasn't sure if macros aren't reserved just for special usage so I avoided them. If you'd like, I can refactor the file to use a macro instead, you're right, that should shorten it quite a bit.

ambv and others added 4 commits December 30, 2017 21:29
The string form is recovered by unparsing the AST.
This is required for PEP 563 and as such only implements a part of the
unparsing process that covers expressions.
@ambv ambv force-pushed the string_annotations branch from 98231af to 7f88115 Compare December 31, 2017 08:41
@ambv

ambv commented Dec 31, 2017

Copy link
Copy Markdown
Contributor

Alright, this is fully rebased without conflicts and all comments from previous code review are addressed. Things left to do:

  • remove special handling of strings
  • add support for f-strings
  • (maybe?) refactor using a VISIT-style macro

@ambv

ambv commented Dec 31, 2017

Copy link
Copy Markdown
Contributor

Special handling of strings removed. I plan to add the missing f-string support in the first week of January so that the implementation is hopefully mergeable in 3.7.0a4.

@ambv

ambv commented Jan 16, 2018

Copy link
Copy Markdown
Contributor

Alright, @serhiy-storchaka, this is complete now, including f-string support! I realize it's pretty last minute, sorry for that.

A piece of useless statistics: this pull request was implemented in full during intercontinental flights. There's something very tranquil about sitting in one place for 10+ hours with no distractions.

@1st1 1st1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Overall looks good. Code in Python/ast_unparse.c looks fine, I didn't see any refleaks or non-checked return values. I think we can go ahead with this one and merge it, we'll have plenty of time to catch any bugs during the beta/rc period.

Strongbone315

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants