FilesExpand file tree

develop

/

type_aliases.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

22 lines (18 loc) · 844 Bytes

develop

/

type_aliases.py

Copy path

Top

File metadata and controls

• Code
• Blame

22 lines (18 loc) · 844 Bytes

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

# SPDX-License-Identifier: Apache-2.0

# SPDX-FileCopyrightText: Copyright the Vortex contributors

from typing import TypeAlias

import pyarrow as pa

from ._lib.arrays import Array

from ._lib.expr import Expr

from ._lib.iter import ArrayIterator

# TypeAliases do not support __doc__.

IntoProjection: TypeAlias = Expr | list[str] | None

IntoArrayIterator: TypeAlias = Array | ArrayIterator | pa.Table | pa.RecordBatchReader

# If you make an intersphinx reference to pyarrow.RecordBatchReader in the return type of a function

# *and also* use the IntoProjection type alias in a parameter type, Sphinx thinks the type alias

# does not exist.

#

# Indirecting the intersphinx reference by way of a type alias avoids this bug.

#

# I failed to produce a small enough test case to report this bug.

RecordBatchReader: TypeAlias = pa.RecordBatchReader