Commit Graph

32 Commits

Author SHA1 Message Date
Matthew Rahtz 2ae3b71e21
PEP 646: Add section on type substitution in generic aliases (#2883)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-11-26 19:56:00 -08:00
Pavel Karateev 759a6bd547
PEP 646: Add forgotten parameter name in examples (#2837) 2022-10-20 11:51:08 -07:00
Jelle Zijlstra 83b976da18
Add Typing Topic (#2670)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-06 17:36:39 -07:00
Petr Viktorin 3eeb003bff
PEP 646: Add acceptance note, bump Python version (#2261) 2022-01-24 09:33:29 -08:00
Adam Turner 113e490701
Several PEPs: Use explicit `:pep:` and `:rfc:` roles (#2209) 2022-01-21 11:03:51 +00:00
Matthew Rahtz ccb8fc9dd5
PEP 646: Mark as Accepted (#2250)
Huge thank you to everyone who helped get this across the finish line, especially @gvanrossum! Well done to all of us, @mrkmndz @pradeep90 @vsiles @fylux!
2022-01-19 07:02:04 -08:00
Matthew Rahtz 5cf65cf312
PEP 646: Clarify indexing assignment (#2241) 2022-01-14 09:26:06 -08:00
Petr Viktorin 989a70412d
PEP 646: Fix code markup (#2210)
A code block was formatted as a quotation by mistake.
2022-01-03 08:22:47 -08:00
Matthew Rahtz 27b476d1c6
PEP 646: Explain the results of the new grammar/compiler change (#2189) 2021-12-13 13:22:29 -08:00
Pradeep Kumar f1c02245cc
[PEP 646] Allow cleanly substituting any tuple type for a TypeVarTuple (#2162)
A number of cleanups also happened, improving readability of various sections and examples, but the only *semantic* change here is that TypeVarTuples can now be substituted with unbounded tuples (previously that was explicitly forbidden, but we convinced ourselves that there is no reason for that).
2021-12-08 14:07:27 -08:00
Jelle Zijlstra 2263e93426
PEP 646: fix typo (#2160) 2021-11-24 08:48:34 -08:00
Dimitri Papadopoulos Orfanos 57d9baf04d
Typos found by codespell (#2073)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2021-09-17 11:18:24 -07:00
Matthew Rahtz 9c79ee81c6
PEP 646: Add explicit section on endorsements (GH-2055) 2021-09-17 03:03:04 +02:00
Matthew Rahtz cebfa33baa
PEP 646: Add additional motivation for why *Ts over Unpack[Ts] (#2054) 2021-08-23 13:26:52 -07:00
Matthew Rahtz d70e05a293
PEP 646: Add section on grammar changes (#2039) 2021-08-18 08:20:33 -07:00
Matthew Rahtz 5578160afa
PEP 646: Add some broader context (#1904)
These sections were requested in some feedback we got when talking to NumPy and JAX folks. OK, this does make an already-long PEP even longer, but I do think this context is important - especially for folks who don't have strong intuitions for how parametric typing works in Python.
2021-04-18 11:59:20 -07:00
Matthew Rahtz e3b65e6b5b
PEP 646: Add Stephan's endorsement to Acknowledgements section (#1915) 2021-04-07 12:05:53 -07:00
Matthew Rahtz 701678f4d7
PEP 646: Add note of alternatives that exist (#1884) 2021-03-31 19:43:11 -07:00
Matthew Rahtz 47cb40ea58
PEP 646: Be more explicit about grammar changes needed (#1880) 2021-03-31 10:36:09 -07:00
Matthew Rahtz 89cb6aa8b9
PEP 646: Make explicit some more considerations of the motivation (#1881) 2021-03-20 08:07:04 -07:00
Matthew Rahtz 4506987f28
PEP 646: Make some final final readability improvements (#1862) 2021-03-08 07:16:27 -08:00
Matthew Rahtz b9b2d98165
Readability tweaks to PEP 646 (#1859) 2021-03-03 13:35:34 -08:00
Matthew Rahtz b95239fef1
PEP 646: Update draft (#1856)
This is the more-or-less final version now. I'll do one last read-through to confirm everything's consistent, then post in typing-sig to confirm it's ready for the Steering Committee.

Semantic changes:
* Remove support for type variable tuples in `Union`. Apparently the implementation would be tricky in Pyre because of special-casing around `Union`. That could be evidence that it would be tricky in Mypy and pytype. Since we don't have a specific use-case in mind, I think this is fine.
* Support concatenation in `Callable`. Pradeep pointed ou that `ParamSpec` doesn't cover all potential use-cases because it doesn't support concatenating suffixes (in turn because `ParamSpec`s can contain keyword arguments, and concatenation is positional).

Readability changes:
* Remove the section on a full `Array` example. We've moved the important thing here - an explicit confirmation that `Array` can be generic in both datatype and shape - to the beginning of the PEP to make it more obvious. We've removed the `Ndim` thing after someone pointed out that e.g. `Ndim[Literal[2]]` would be incompatible with `Shape[Any, Any]`; I just don't think it's going to work. All that's left is the aliases, which we've moved into the Aliases section itself.

Other changes:
* Fill out Backwards Compatibility section.
* Reference initial CPython implementation.
2021-03-02 16:33:15 -08:00
Matthew Rahtz a2339f34ea
PEP 646: tweaks, clarifications, and move summary example up (#1828)
Readability changes:
* Tweak framing to also acknowledge that variadic generics have been wanted for other things too (though as far as I've been able to tell there isn't a consistent enough pattern to the other use cases to justify including them in the PEP)
* Move the Array example much earlier (both because reading a detailed example is going to be a faster way of getting the gist for people in a hurry, and because we want to make it clear to numerical computing folks from the start that we can also specify a datatype here). (We still have a more detailed Array example later; I'm leaving that there for the time being pending some discussion with Pradeep, but eventually I guess it'll be removed and absorbed into this earlier example)
* Make it clear that other types can appear in `Union` alongside `TypeVarTuple` instances.

Semantic changes:
* Disallow a `Union` of more than one type variable tuple (I thought this would be easier than concatenation of more than one type variable tuple, but Pradeep points out it could still get hairy for type checkers, so disallow it for now to be on the safe safe)

Also some *more* type fixes...
2021-02-21 20:41:48 -08:00
Eric Traut 35a0204848
Fixed several omissions and errors in sample code in PEP 646. (#1826)
Co-authored-by: Eric Traut <erictr@microsoft.com>
2021-02-20 15:20:04 -08:00
Matthew Rahtz 4304da21ec
PEP 646: various improvements (#1825)
Semantic changes:
* Unparameterised variadics are compatible with parameterised variadics in both direction
* Allow suffixing

Readability changes:
* De-emphasise unparameterised `Array` behaving like `Array[Any, ...]` to avoid the suggestion that `Array[Any, ...]` might be supported
* Explicitly forbid `Array[Any, ...]` and similar
* Clarify that only `*args` can be annotated as `*Ts`; other arguments must use `Tuple[*Ts]`
* Remove 'Final Notes' section (I was hoping we'd have more edge cases to add to this, but in the end there haven't been any, and the only example we do have is obscure enough that I think we can just remove it)

Also some minor typo fixes.
2021-02-20 10:55:14 -08:00
Hugo van Kemenade 58718c543e
Lint RST on GitHub Actions and fix PEP 646 (#1802) 2021-02-08 07:20:51 -08:00
Matthew Rahtz 68794b15c3
PEP 646: Update based on typing-sig discussions (#1781)
* PEP 646: Simplify based on typing-sig discussions

Feature removals:
* Remove `Map` (to be added in a separate PEP)
* Remove support for all forms of concatenation other than simply prefixing of a single `TypeVarTuple` (fancier forms of concatenation to also be added in a separate PEP)

Semantic changes:
* Try switching `Ts` back to mean the 'unpacked' version (such that `Ts = int, str; Tuple[Ts] = Tuple[int, str]`) to see whether everything still works. (Might revert this, pending future discussion in typing-sig.)

* PEP 646: Clarify that prefixing is not allowed in Callable

* Update PEP 646 based on discussions in typing-sig

Semantic changes:
* Switch back to `Ts` meaning types packed in a `Tuple`
* Disallow unpacked usages of `Ts`
* Unparameterised `Tensor` behaves like `Tensor[Any, ...]`

Clarifications:
* `TypeVarTuple`s are invariant
* `TypeVarTuple`s can not be bound to unknown-length types (e.g. `Tuple[int, ...]`
* `TypeVarTuple`s can not be bound to unions of types
* Empty `*args` behaves like `Tuple[()]`
* `TypeVarTuple`s can not appear in slices

Readability changes:
* Reorder some sections for better flow

* Update PEP 646 with Eric's suggestions and other tweaks

Semantic changes:
* Revert to `*args: *Ts` for new behaviour, and `*args: Tuple[*Ts]` for old behaviour

Fixes:
* Unpacking in Aliases/Ideal Array Type sections
* Various typo/grammar fixes

Other:
* State explicitly that TypeVarTuples can be used in callback protocols
2021-02-07 08:29:17 -08:00
Marti Raudsepp 9b64c6ea75
Various typo/grammar/style fixes (#1789)
Changes detected by Topy (https://github.com/intgr/topy), all changes
verified by hand, false positives have been omitted.

These range from straight-out misspellings to debatable hyphen placement.
The hyphen changes are supported by grammar manuals of style.
2021-02-03 06:06:23 -08:00
Ken Jin 9d778c6b28
PEP 646: Fix minor typo (#1769) 2021-01-19 09:58:41 -08:00
Matthew Rahtz f507e8870f
PEP 646: Various updates (#1751)
Naming:
* Rename Tuple
* Rename Tensor -> Array (it's less jargony, and I think it's the more general term)
* Rename Expand -> Unpack (to be consistent with the terminology for normal tuples)
* Rename ArgTs -> Ts, ReturnT -> R
* Rename 'type tuple variable' -> 'type variable tuple'

Semantic:
* Explicitly state that a TypeVarTuple can hold *zero* or more types
* Explicitly state that TypeVarTuple doesn't support variance or bound yet
* Support Union[*Ts]
* Support concatenating multiple unpacked TypeVarTuple when there's no ambiguity
* Support aliases
* Remove support for class overloads; replace with overloads of individual methods

Pedagogical:
* Reorder introductory material to make it clearer how TypeVarTuples behave when not unpacked, and to make it clearer that using them without unpacking them is a perfectly valid thing to do
* Remove example of unpacking being used with a regular Tuple rather than a TypeVarTuple (my main reason for wanting to include it was to emphasise that a TypeVarTuple behaves like a Tuple, but I think this is emphasised better in previous sections now, and since I don't think it has any use cases, it seems better to remove it to keep things shorter and more to the point)
* Replace Tuple[*Ts] with just Ts (now that we've settled on Ts definitely meaning "A Tuple filled with types", writing Tuple[*Ts] is redundant - it's exactly the same as Ts, but with more keystrokes)
* State explicitly that TypeVarTuple can be used with Callable
* Changes args_to_tuples example to args_to_lists (so it's clearer where the Tuple comes from)
* Show more examples of where Map can be used
* Move section on nesting Map to the 'Rationale and Rejected Ideas' section (it's complicated enough to be too distracting if it were in the main section, and since there isn't an obvious use-case, we leave it as an optional feature)
* Add section on a full example of an array type
* Remove ideas for future PEPs (to reduce length)
* Add more detail on the range of type concatenations that are allowable

Other:
* Add Pradeep to the authors list, since he's contributed so much :)
* Add Eric Traut in the acknowledgements
* Update Post-History
* Fix some references
* Fix first Array example to remove the need for a cast
* Various wording tweaks
2021-01-01 17:08:20 -08:00
Matthew Rahtz c86d1cc89d
PEP 646: First draft (#1740)
(This draft will need some work before it is acceptable, see my message to typing-sig and my comments in the Google Doc. But I'd like to claim the PEP number.)
2020-12-22 18:23:44 -08:00