Title: Syntax for typing multi-dimensional arrays · Issue #516 · python/typing · GitHub
Open Graph Title: Syntax for typing multi-dimensional arrays · Issue #516 · python/typing
X Title: Syntax for typing multi-dimensional arrays · Issue #516 · python/typing
Description: As part of the larger project for multi-dimensional arrays (#513), one of the first questions I would like to settle is what syntax for typing data-types and shapes should look like. Both dtype and shape should be optional, and it should...
Open Graph Description: As part of the larger project for multi-dimensional arrays (#513), one of the first questions I would like to settle is what syntax for typing data-types and shapes should look like. Both dtype and...
X Description: As part of the larger project for multi-dimensional arrays (#513), one of the first questions I would like to settle is what syntax for typing data-types and shapes should look like. Both dtype and...
Opengraph URL: https://github.com/python/typing/issues/516
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Syntax for typing multi-dimensional arrays","articleBody":"As part of the larger project for multi-dimensional arrays (https://github.com/python/typing/issues/513), one of the first questions I would like to settle is what syntax for typing data-types and shapes should look like.\r\n\r\nBoth `dtype` and `shape` should be optional, and it should be possible to define multi-dimensional arrays for which either or both of these are generic:\r\n- `dtype`: indicates the data type for array elements, e.g., `np.float64`\r\n- `shape`: indicates the shape of the multi-dimensional array, a tuple of zero or more integers. We would like to support integer and variable sized dimensions, and variable numbers of dimensions. These are most naturally represented with indexing by a variadic number of integer, variable, colon `:` and/or ellipsis `...` arguments, e.g., `NDArray[1, N, :, ...]` for an array with dimensions of size 1, size `N`, and arbitrary size, followed by 0 or more arbitrary sized dimensions.\r\n\r\nFor NumPy, ideally we would like to add basic typing support for `dtype` (using `Generic`) even before typing for `shape` is possible. But we'd like to know what the ultimate syntax should look like, so we don't paint ourselves into a corner.\r\n\r\nOne key question: can we safely rely on using a single generic argument for dtypes (e.g., `np.ndarray[np.float64]`) as indicating an array without any shape constraints?\r\n\r\n[My doc](https://docs.google.com/document/d/1vpMse4c6DrWH5rq2tQSx3qwP_m_0lyn-Ij4WHqQqRHY/edit#heading=h.en01cshwy1w8) (same as in the master issue) considers a number of options under the \"Possible syntax\" section.\r\n\r\nSo far, I think the best option is some variation of \"two generic arguments\", for dtype and shape. But this could quickly get annoyingly verbose when sprinkled all over a code-base, e.g., `np.ndarray[np.float32, Shaped[..., N, M]]`:\r\n- It would be nice to support syntax like `np.ndarray[np.float32]` (the multi-dimensional equivalent of `List[float]`) as an alias for `np.ndarray[np.float32, Any]`, but we don't yet have optional arguments for generics (variadic arguments are a somewhat awkward fit for a single argument).\r\n- It would also be nice to allow omitting `Shaped[]`, e.g., by writing dimensions as variadic generics to the array type like `np.ndarray[np.float32, ..., N, M]`. One possible ambiguity is how to specify scalar arrays: `np.ndarray[np.float32,]` looks very similar to `np.ndarray[np.float32]`. But scalar arrays are rare enough that these could potentially be resolved by disallowing `np.ndarray[np.float32,]` in favor of requiring `np.ndarray[np.float32, Shape[()]]`.","author":{"url":"https://github.com/shoyer","@type":"Person","name":"shoyer"},"datePublished":"2017-12-10T01:07:36Z","url":"https://github.com/python/typing/issues/516"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:eae1a783-1160-370a-7440-f03b70aa8213 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B6D2:30DBED:2FE5AFB:3F030D5:6B00219D |
| html-safe-nonce | 08d7eb7ddd524d5bcac0aece1178e0733efa5377239f2c176180d2f49f01257d |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNkQyOjMwREJFRDoyRkU1QUZCOjNGMDMwRDU6NkIwMDIxOUQiLCJ2aXNpdG9yX2lkIjoiNjY4MDQ0ODM5ODA2NTE0ODMxNyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | f178c225c1f6f7271a05dda3ae7e7ef3f17982e3ace53db4bd723a2b8942d868 |
| hovercard-subject-tag | issue:280771521 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/typing/516/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2e42594ac6058c4f5690a7381d27becf0913799fe6ac131c458e123f0fccb88a/python/typing/issues/516 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2e42594ac6058c4f5690a7381d27becf0913799fe6ac131c458e123f0fccb88a/python/typing/issues/516 |
| og:image:alt | As part of the larger project for multi-dimensional arrays (#513), one of the first questions I would like to settle is what syntax for typing data-types and shapes should look like. Both dtype and... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | shoyer |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4eb4cba0d69f045374ac15de9666d22b0961e1d555cc3824f36b7734c00c78e0 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/typing git https://github.com/python/typing.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 24604008 |
| octolytics-dimension-repository_nwo | python/typing |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24604008 |
| octolytics-dimension-repository_network_root_nwo | python/typing |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 44c658b24abf00491fb7ae5f56d42c9f38cbeab2 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width