Skip to content

Commit 8ab1af3

Browse files
MarcoGorelliMarcoGorelli
authored
include missing |None in concat and read_table stubs (#1316)
* include missing `|None` in `concat` and `read_table` stubs * one more * dialect too
1 parent 2228223 commit 8ab1af3

File tree

2 files changed

+52
-46
lines changed

2 files changed

+52
-46
lines changed

‎pandas-stubs/core/reshape/concat.pyi

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ def concat( # type: ignore[overload-overlap]
3131
axis: Axis = ...,
3232
join: Literal["inner", "outer"] = ...,
3333
ignore_index: bool = ...,
34-
keys: Iterable[HashableT2] = ...,
35-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
34+
keys: Iterable[HashableT2] | None = ...,
35+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
3636
names: list[HashableT4] | None = ...,
3737
verify_integrity: bool = ...,
3838
sort: bool = ...,
@@ -45,8 +45,8 @@ def concat( # pyright: ignore[reportOverlappingOverload]
4545
axis: AxisIndex = ...,
4646
join: Literal["inner", "outer"] = ...,
4747
ignore_index: bool = ...,
48-
keys: Iterable[HashableT2] = ...,
49-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
48+
keys: Iterable[HashableT2] | None = ...,
49+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
5050
names: list[HashableT4] | None = ...,
5151
verify_integrity: bool = ...,
5252
sort: bool = ...,
@@ -59,8 +59,8 @@ def concat( # type: ignore[overload-overlap]
5959
axis: AxisIndex = ...,
6060
join: Literal["inner", "outer"] = ...,
6161
ignore_index: bool = ...,
62-
keys: Iterable[HashableT2] = ...,
63-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
62+
keys: Iterable[HashableT2] | None = ...,
63+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
6464
names: list[HashableT4] | None = ...,
6565
verify_integrity: bool = ...,
6666
sort: bool = ...,
@@ -73,8 +73,8 @@ def concat( # type: ignore[overload-overlap] # pyright: ignore[reportOverlappin
7373
axis: Axis = ...,
7474
join: Literal["inner", "outer"] = ...,
7575
ignore_index: bool = ...,
76-
keys: Iterable[HashableT2] = ...,
77-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
76+
keys: Iterable[HashableT2] | None = ...,
77+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
7878
names: list[HashableT4] | None = ...,
7979
verify_integrity: bool = ...,
8080
sort: bool = ...,
@@ -87,8 +87,8 @@ def concat(
8787
axis: Axis = ...,
8888
join: Literal["inner", "outer"] = ...,
8989
ignore_index: bool = ...,
90-
keys: Iterable[HashableT2] = ...,
91-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
90+
keys: Iterable[HashableT2] | None = ...,
91+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
9292
names: list[HashableT4] | None = ...,
9393
verify_integrity: bool = ...,
9494
sort: bool = ...,
@@ -101,8 +101,8 @@ def concat( # type: ignore[overload-overlap]
101101
axis: Axis = ...,
102102
join: Literal["inner", "outer"] = ...,
103103
ignore_index: bool = ...,
104-
keys: Iterable[HashableT2] = ...,
105-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
104+
keys: Iterable[HashableT2] | None = ...,
105+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
106106
names: list[HashableT4] | None = ...,
107107
verify_integrity: bool = ...,
108108
sort: bool = ...,
@@ -115,8 +115,8 @@ def concat( # type: ignore[overload-overlap]
115115
axis: AxisIndex = ...,
116116
join: Literal["inner", "outer"] = ...,
117117
ignore_index: bool = ...,
118-
keys: Iterable[HashableT2] = ...,
119-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
118+
keys: Iterable[HashableT2] | None = ...,
119+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
120120
names: list[HashableT4] | None = ...,
121121
verify_integrity: bool = ...,
122122
sort: bool = ...,
@@ -132,8 +132,8 @@ def concat(
132132
axis: Axis = ...,
133133
join: Literal["inner", "outer"] = ...,
134134
ignore_index: bool = ...,
135-
keys: Iterable[HashableT2] = ...,
136-
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] = ...,
135+
keys: Iterable[HashableT2] | None = ...,
136+
levels: Sequence[list[HashableT3] | tuple[HashableT3, ...]] | None = ...,
137137
names: list[HashableT4] | None = ...,
138138
verify_integrity: bool = ...,
139139
sort: bool = ...,

‎pandas-stubs/io/parsers/readers.pyi

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ def read_csv(
5454
| Mapping[str, Callable[[str], Any]]
5555
| None
5656
) = ...,
57-
true_values: list[str] = ...,
58-
false_values: list[str] = ...,
57+
true_values: list[str] | None = ...,
58+
false_values: list[str] | None = ...,
5959
skipinitialspace: bool = ...,
60-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
60+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
6161
skipfooter: int = ...,
6262
nrows: int | None = ...,
63-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
63+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
6464
keep_default_na: bool = ...,
6565
na_filter: bool = ...,
6666
verbose: bool = ...,
@@ -71,6 +71,7 @@ def read_csv(
7171
| list[str]
7272
| Sequence[Sequence[int]]
7373
| Mapping[str, Sequence[int | str]]
74+
| None
7475
) = ...,
7576
keep_date_col: bool = ...,
7677
date_format: dict[Hashable, str] | str | None = ...,
@@ -89,7 +90,7 @@ def read_csv(
8990
comment: str | None = ...,
9091
encoding: str | None = ...,
9192
encoding_errors: str | None = ...,
92-
dialect: str | csv.Dialect = ...,
93+
dialect: str | csv.Dialect | None = ...,
9394
on_bad_lines: (
9495
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
9596
) = ...,
@@ -118,13 +119,13 @@ def read_csv(
118119
| Mapping[str, Callable[[str], Any]]
119120
| None
120121
) = ...,
121-
true_values: list[str] = ...,
122-
false_values: list[str] = ...,
122+
true_values: list[str] | None = ...,
123+
false_values: list[str] | None = ...,
123124
skipinitialspace: bool = ...,
124-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
125+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
125126
skipfooter: int = ...,
126127
nrows: int | None = ...,
127-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
128+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
128129
keep_default_na: bool = ...,
129130
na_filter: bool = ...,
130131
verbose: bool = ...,
@@ -135,6 +136,7 @@ def read_csv(
135136
| list[str]
136137
| Sequence[Sequence[int]]
137138
| Mapping[str, Sequence[int | str]]
139+
| None
138140
) = ...,
139141
keep_date_col: bool = ...,
140142
date_format: dict[Hashable, str] | str | None = ...,
@@ -153,7 +155,7 @@ def read_csv(
153155
comment: str | None = ...,
154156
encoding: str | None = ...,
155157
encoding_errors: str | None = ...,
156-
dialect: str | csv.Dialect = ...,
158+
dialect: str | csv.Dialect | None = ...,
157159
on_bad_lines: (
158160
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
159161
) = ...,
@@ -182,13 +184,13 @@ def read_csv(
182184
| Mapping[str, Callable[[str], Any]]
183185
| None
184186
) = ...,
185-
true_values: list[str] = ...,
186-
false_values: list[str] = ...,
187+
true_values: list[str] | None = ...,
188+
false_values: list[str] | None = ...,
187189
skipinitialspace: bool = ...,
188-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
190+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
189191
skipfooter: int = ...,
190192
nrows: int | None = ...,
191-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
193+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
192194
keep_default_na: bool = ...,
193195
na_filter: bool = ...,
194196
verbose: bool = ...,
@@ -199,6 +201,7 @@ def read_csv(
199201
| list[str]
200202
| Sequence[Sequence[int]]
201203
| Mapping[str, Sequence[int | str]]
204+
| None
202205
) = ...,
203206
keep_date_col: bool = ...,
204207
date_format: dict[Hashable, str] | str | None = ...,
@@ -217,7 +220,7 @@ def read_csv(
217220
comment: str | None = ...,
218221
encoding: str | None = ...,
219222
encoding_errors: str | None = ...,
220-
dialect: str | csv.Dialect = ...,
223+
dialect: str | csv.Dialect | None = ...,
221224
on_bad_lines: (
222225
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
223226
) = ...,
@@ -246,13 +249,13 @@ def read_table(
246249
| Mapping[str, Callable[[str], Any]]
247250
| None
248251
) = ...,
249-
true_values: list[str] = ...,
250-
false_values: list[str] = ...,
252+
true_values: list[str] | None = ...,
253+
false_values: list[str] | None = ...,
251254
skipinitialspace: bool = ...,
252-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
255+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
253256
skipfooter: int = ...,
254257
nrows: int | None = ...,
255-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
258+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
256259
keep_default_na: bool = ...,
257260
na_filter: bool = ...,
258261
verbose: bool = ...,
@@ -263,6 +266,7 @@ def read_table(
263266
| list[str]
264267
| Sequence[Sequence[int]]
265268
| Mapping[str, Sequence[int | str]]
269+
| None
266270
) = ...,
267271
infer_datetime_format: bool = ...,
268272
keep_date_col: bool = ...,
@@ -282,7 +286,7 @@ def read_table(
282286
comment: str | None = ...,
283287
encoding: str | None = ...,
284288
encoding_errors: str | None = ...,
285-
dialect: str | csv.Dialect = ...,
289+
dialect: str | csv.Dialect | None = ...,
286290
on_bad_lines: (
287291
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
288292
) = ...,
@@ -310,13 +314,13 @@ def read_table(
310314
| Mapping[str, Callable[[str], Any]]
311315
| None
312316
) = ...,
313-
true_values: list[str] = ...,
314-
false_values: list[str] = ...,
317+
true_values: list[str] | None = ...,
318+
false_values: list[str] | None = ...,
315319
skipinitialspace: bool = ...,
316-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
320+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
317321
skipfooter: int = ...,
318322
nrows: int | None = ...,
319-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
323+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
320324
keep_default_na: bool = ...,
321325
na_filter: bool = ...,
322326
verbose: bool = ...,
@@ -327,6 +331,7 @@ def read_table(
327331
| list[str]
328332
| Sequence[Sequence[int]]
329333
| Mapping[str, Sequence[int | str]]
334+
| None
330335
) = ...,
331336
infer_datetime_format: bool = ...,
332337
keep_date_col: bool = ...,
@@ -346,7 +351,7 @@ def read_table(
346351
comment: str | None = ...,
347352
encoding: str | None = ...,
348353
encoding_errors: str | None = ...,
349-
dialect: str | csv.Dialect = ...,
354+
dialect: str | csv.Dialect | None = ...,
350355
on_bad_lines: (
351356
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
352357
) = ...,
@@ -374,13 +379,13 @@ def read_table(
374379
| Mapping[str, Callable[[str], Any]]
375380
| None
376381
) = ...,
377-
true_values: list[str] = ...,
378-
false_values: list[str] = ...,
382+
true_values: list[str] | None = ...,
383+
false_values: list[str] | None = ...,
379384
skipinitialspace: bool = ...,
380-
skiprows: int | Sequence[int] | Callable[[int], bool] = ...,
385+
skiprows: int | Sequence[int] | Callable[[int], bool] | None = ...,
381386
skipfooter: int = ...,
382387
nrows: int | None = ...,
383-
na_values: Sequence[str] | Mapping[str, Sequence[str]] = ...,
388+
na_values: Sequence[str] | Mapping[str, Sequence[str]] | None = ...,
384389
keep_default_na: bool = ...,
385390
na_filter: bool = ...,
386391
verbose: bool = ...,
@@ -391,6 +396,7 @@ def read_table(
391396
| list[str]
392397
| Sequence[Sequence[int]]
393398
| Mapping[str, Sequence[int | str]]
399+
| None
394400
) = ...,
395401
infer_datetime_format: bool = ...,
396402
keep_date_col: bool = ...,
@@ -410,7 +416,7 @@ def read_table(
410416
comment: str | None = ...,
411417
encoding: str | None = ...,
412418
encoding_errors: str | None = ...,
413-
dialect: str | csv.Dialect = ...,
419+
dialect: str | csv.Dialect | None = ...,
414420
on_bad_lines: (
415421
Literal["error", "warn", "skip"] | Callable[[list[str]], list[str] | None]
416422
) = ...,

0 commit comments

Comments
 (0)