Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1from typing import Literal
3_BoolCodes = Literal["bool", "bool_", "?", "|?", "=?", "<?", ">?"]
5_UInt8Codes = Literal["uint8", "u1", "|u1", "=u1", "<u1", ">u1"]
6_UInt16Codes = Literal["uint16", "u2", "|u2", "=u2", "<u2", ">u2"]
7_UInt32Codes = Literal["uint32", "u4", "|u4", "=u4", "<u4", ">u4"]
8_UInt64Codes = Literal["uint64", "u8", "|u8", "=u8", "<u8", ">u8"]
10_Int8Codes = Literal["int8", "i1", "|i1", "=i1", "<i1", ">i1"]
11_Int16Codes = Literal["int16", "i2", "|i2", "=i2", "<i2", ">i2"]
12_Int32Codes = Literal["int32", "i4", "|i4", "=i4", "<i4", ">i4"]
13_Int64Codes = Literal["int64", "i8", "|i8", "=i8", "<i8", ">i8"]
15_Float16Codes = Literal["float16", "f2", "|f2", "=f2", "<f2", ">f2"]
16_Float32Codes = Literal["float32", "f4", "|f4", "=f4", "<f4", ">f4"]
17_Float64Codes = Literal["float64", "f8", "|f8", "=f8", "<f8", ">f8"]
19_Complex64Codes = Literal["complex64", "c8", "|c8", "=c8", "<c8", ">c8"]
20_Complex128Codes = Literal["complex128", "c16", "|c16", "=c16", "<c16", ">c16"]
22_ByteCodes = Literal["byte", "b", "|b", "=b", "<b", ">b"]
23_ShortCodes = Literal["short", "h", "|h", "=h", "<h", ">h"]
24_IntCCodes = Literal["intc", "i", "|i", "=i", "<i", ">i"]
25_IntPCodes = Literal["intp", "int", "int_", "n", "|n", "=n", "<n", ">n"]
26_LongCodes = Literal["long", "l", "|l", "=l", "<l", ">l"]
27_IntCodes = _IntPCodes
28_LongLongCodes = Literal["longlong", "q", "|q", "=q", "<q", ">q"]
30_UByteCodes = Literal["ubyte", "B", "|B", "=B", "<B", ">B"]
31_UShortCodes = Literal["ushort", "H", "|H", "=H", "<H", ">H"]
32_UIntCCodes = Literal["uintc", "I", "|I", "=I", "<I", ">I"]
33_UIntPCodes = Literal["uintp", "uint", "N", "|N", "=N", "<N", ">N"]
34_ULongCodes = Literal["ulong", "L", "|L", "=L", "<L", ">L"]
35_UIntCodes = _UIntPCodes
36_ULongLongCodes = Literal["ulonglong", "Q", "|Q", "=Q", "<Q", ">Q"]
38_HalfCodes = Literal["half", "e", "|e", "=e", "<e", ">e"]
39_SingleCodes = Literal["single", "f", "|f", "=f", "<f", ">f"]
40_DoubleCodes = Literal["double", "float", "d", "|d", "=d", "<d", ">d"]
41_LongDoubleCodes = Literal["longdouble", "g", "|g", "=g", "<g", ">g"]
43_CSingleCodes = Literal["csingle", "F", "|F", "=F", "<F", ">F"]
44_CDoubleCodes = Literal["cdouble", "complex", "D", "|D", "=D", "<D", ">D"]
45_CLongDoubleCodes = Literal["clongdouble", "G", "|G", "=G", "<G", ">G"]
47_StrCodes = Literal["str", "str_", "unicode", "U", "|U", "=U", "<U", ">U"]
48_BytesCodes = Literal["bytes", "bytes_", "S", "|S", "=S", "<S", ">S"]
49_VoidCodes = Literal["void", "V", "|V", "=V", "<V", ">V"]
50_ObjectCodes = Literal["object", "object_", "O", "|O", "=O", "<O", ">O"]
52_DT64Codes = Literal[
53 "datetime64", "|datetime64", "=datetime64",
54 "<datetime64", ">datetime64",
55 "datetime64[Y]", "|datetime64[Y]", "=datetime64[Y]",
56 "<datetime64[Y]", ">datetime64[Y]",
57 "datetime64[M]", "|datetime64[M]", "=datetime64[M]",
58 "<datetime64[M]", ">datetime64[M]",
59 "datetime64[W]", "|datetime64[W]", "=datetime64[W]",
60 "<datetime64[W]", ">datetime64[W]",
61 "datetime64[D]", "|datetime64[D]", "=datetime64[D]",
62 "<datetime64[D]", ">datetime64[D]",
63 "datetime64[h]", "|datetime64[h]", "=datetime64[h]",
64 "<datetime64[h]", ">datetime64[h]",
65 "datetime64[m]", "|datetime64[m]", "=datetime64[m]",
66 "<datetime64[m]", ">datetime64[m]",
67 "datetime64[s]", "|datetime64[s]", "=datetime64[s]",
68 "<datetime64[s]", ">datetime64[s]",
69 "datetime64[ms]", "|datetime64[ms]", "=datetime64[ms]",
70 "<datetime64[ms]", ">datetime64[ms]",
71 "datetime64[us]", "|datetime64[us]", "=datetime64[us]",
72 "<datetime64[us]", ">datetime64[us]",
73 "datetime64[ns]", "|datetime64[ns]", "=datetime64[ns]",
74 "<datetime64[ns]", ">datetime64[ns]",
75 "datetime64[ps]", "|datetime64[ps]", "=datetime64[ps]",
76 "<datetime64[ps]", ">datetime64[ps]",
77 "datetime64[fs]", "|datetime64[fs]", "=datetime64[fs]",
78 "<datetime64[fs]", ">datetime64[fs]",
79 "datetime64[as]", "|datetime64[as]", "=datetime64[as]",
80 "<datetime64[as]", ">datetime64[as]",
81 "M", "|M", "=M", "<M", ">M",
82 "M8", "|M8", "=M8", "<M8", ">M8",
83 "M8[Y]", "|M8[Y]", "=M8[Y]", "<M8[Y]", ">M8[Y]",
84 "M8[M]", "|M8[M]", "=M8[M]", "<M8[M]", ">M8[M]",
85 "M8[W]", "|M8[W]", "=M8[W]", "<M8[W]", ">M8[W]",
86 "M8[D]", "|M8[D]", "=M8[D]", "<M8[D]", ">M8[D]",
87 "M8[h]", "|M8[h]", "=M8[h]", "<M8[h]", ">M8[h]",
88 "M8[m]", "|M8[m]", "=M8[m]", "<M8[m]", ">M8[m]",
89 "M8[s]", "|M8[s]", "=M8[s]", "<M8[s]", ">M8[s]",
90 "M8[ms]", "|M8[ms]", "=M8[ms]", "<M8[ms]", ">M8[ms]",
91 "M8[us]", "|M8[us]", "=M8[us]", "<M8[us]", ">M8[us]",
92 "M8[ns]", "|M8[ns]", "=M8[ns]", "<M8[ns]", ">M8[ns]",
93 "M8[ps]", "|M8[ps]", "=M8[ps]", "<M8[ps]", ">M8[ps]",
94 "M8[fs]", "|M8[fs]", "=M8[fs]", "<M8[fs]", ">M8[fs]",
95 "M8[as]", "|M8[as]", "=M8[as]", "<M8[as]", ">M8[as]",
96]
97_TD64Codes = Literal[
98 "timedelta64", "|timedelta64", "=timedelta64",
99 "<timedelta64", ">timedelta64",
100 "timedelta64[Y]", "|timedelta64[Y]", "=timedelta64[Y]",
101 "<timedelta64[Y]", ">timedelta64[Y]",
102 "timedelta64[M]", "|timedelta64[M]", "=timedelta64[M]",
103 "<timedelta64[M]", ">timedelta64[M]",
104 "timedelta64[W]", "|timedelta64[W]", "=timedelta64[W]",
105 "<timedelta64[W]", ">timedelta64[W]",
106 "timedelta64[D]", "|timedelta64[D]", "=timedelta64[D]",
107 "<timedelta64[D]", ">timedelta64[D]",
108 "timedelta64[h]", "|timedelta64[h]", "=timedelta64[h]",
109 "<timedelta64[h]", ">timedelta64[h]",
110 "timedelta64[m]", "|timedelta64[m]", "=timedelta64[m]",
111 "<timedelta64[m]", ">timedelta64[m]",
112 "timedelta64[s]", "|timedelta64[s]", "=timedelta64[s]",
113 "<timedelta64[s]", ">timedelta64[s]",
114 "timedelta64[ms]", "|timedelta64[ms]", "=timedelta64[ms]",
115 "<timedelta64[ms]", ">timedelta64[ms]",
116 "timedelta64[us]", "|timedelta64[us]", "=timedelta64[us]",
117 "<timedelta64[us]", ">timedelta64[us]",
118 "timedelta64[ns]", "|timedelta64[ns]", "=timedelta64[ns]",
119 "<timedelta64[ns]", ">timedelta64[ns]",
120 "timedelta64[ps]", "|timedelta64[ps]", "=timedelta64[ps]",
121 "<timedelta64[ps]", ">timedelta64[ps]",
122 "timedelta64[fs]", "|timedelta64[fs]", "=timedelta64[fs]",
123 "<timedelta64[fs]", ">timedelta64[fs]",
124 "timedelta64[as]", "|timedelta64[as]", "=timedelta64[as]",
125 "<timedelta64[as]", ">timedelta64[as]",
126 "m", "|m", "=m", "<m", ">m",
127 "m8", "|m8", "=m8", "<m8", ">m8",
128 "m8[Y]", "|m8[Y]", "=m8[Y]", "<m8[Y]", ">m8[Y]",
129 "m8[M]", "|m8[M]", "=m8[M]", "<m8[M]", ">m8[M]",
130 "m8[W]", "|m8[W]", "=m8[W]", "<m8[W]", ">m8[W]",
131 "m8[D]", "|m8[D]", "=m8[D]", "<m8[D]", ">m8[D]",
132 "m8[h]", "|m8[h]", "=m8[h]", "<m8[h]", ">m8[h]",
133 "m8[m]", "|m8[m]", "=m8[m]", "<m8[m]", ">m8[m]",
134 "m8[s]", "|m8[s]", "=m8[s]", "<m8[s]", ">m8[s]",
135 "m8[ms]", "|m8[ms]", "=m8[ms]", "<m8[ms]", ">m8[ms]",
136 "m8[us]", "|m8[us]", "=m8[us]", "<m8[us]", ">m8[us]",
137 "m8[ns]", "|m8[ns]", "=m8[ns]", "<m8[ns]", ">m8[ns]",
138 "m8[ps]", "|m8[ps]", "=m8[ps]", "<m8[ps]", ">m8[ps]",
139 "m8[fs]", "|m8[fs]", "=m8[fs]", "<m8[fs]", ">m8[fs]",
140 "m8[as]", "|m8[as]", "=m8[as]", "<m8[as]", ">m8[as]",
141]
143# NOTE: `StringDType' has no scalar type, and therefore has no name that can
144# be passed to the `dtype` constructor
145_StringCodes = Literal["T", "|T", "=T", "<T", ">T"]
147# NOTE: Nested literals get flattened and de-duplicated at runtime, which isn't
148# the case for a `Union` of `Literal`s.
149# So even though they're equivalent when type-checking, they differ at runtime.
150# Another advantage of nesting, is that they always have a "flat"
151# `Literal.__args__`, which is a tuple of *literally* all its literal values.
153_UnsignedIntegerCodes = Literal[
154 _UInt8Codes,
155 _UInt16Codes,
156 _UInt32Codes,
157 _UInt64Codes,
158 _UIntCodes,
159 _UByteCodes,
160 _UShortCodes,
161 _UIntCCodes,
162 _ULongCodes,
163 _ULongLongCodes,
164]
165_SignedIntegerCodes = Literal[
166 _Int8Codes,
167 _Int16Codes,
168 _Int32Codes,
169 _Int64Codes,
170 _IntCodes,
171 _ByteCodes,
172 _ShortCodes,
173 _IntCCodes,
174 _LongCodes,
175 _LongLongCodes,
176]
177_FloatingCodes = Literal[
178 _Float16Codes,
179 _Float32Codes,
180 _Float64Codes,
181 _LongDoubleCodes,
182 _HalfCodes,
183 _SingleCodes,
184 _DoubleCodes,
185 _LongDoubleCodes
186]
187_ComplexFloatingCodes = Literal[
188 _Complex64Codes,
189 _Complex128Codes,
190 _CSingleCodes,
191 _CDoubleCodes,
192 _CLongDoubleCodes,
193]
194_IntegerCodes = Literal[_UnsignedIntegerCodes, _SignedIntegerCodes]
195_InexactCodes = Literal[_FloatingCodes, _ComplexFloatingCodes]
196_NumberCodes = Literal[_IntegerCodes, _InexactCodes]
198_CharacterCodes = Literal[_StrCodes, _BytesCodes]
199_FlexibleCodes = Literal[_VoidCodes, _CharacterCodes]
201_GenericCodes = Literal[
202 _BoolCodes,
203 _NumberCodes,
204 _FlexibleCodes,
205 _DT64Codes,
206 _TD64Codes,
207 _ObjectCodes,
208 # TODO: add `_StringCodes` once it has a scalar type
209 # _StringCodes,
210]