FilesExpand file tree

 develop

/

typechecking.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

40 lines (31 loc) · 1.28 KB

 develop

/

typechecking.py

Copy path

Top

File metadata and controls

• Code
• Blame

40 lines (31 loc) · 1.28 KB

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

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

"""Types for mypy type-checking

"""

import gzip

import typing

if typing.TYPE_CHECKING:

import os

import typing_extensions

CanFilter = typing_extensions.TypedDict("CanFilter", {"can_id": int, "can_mask": int})

CanFilterExtended = typing_extensions.TypedDict(

"CanFilterExtended", {"can_id": int, "can_mask": int, "extended": bool}

)

CanFilters = typing.Sequence[typing.Union[CanFilter, CanFilterExtended]]

# TODO: Once buffer protocol support lands in typing, we should switch to that,

# since can.message.Message attempts to call bytearray() on the given data, so

# this should have the same typing info.

#

# See: https://github.com/python/typing/issues/593

CanData = typing.Union[bytes, bytearray, int, typing.Iterable[int]]

# Used for the Abstract Base Class

ChannelStr = str

ChannelInt = int

Channel = typing.Union[ChannelInt, ChannelStr]

# Used by the IO module

FileLike = typing.Union[typing.TextIO, typing.BinaryIO, gzip.GzipFile]

StringPathLike = typing.Union[str, "os.PathLike[str]"]

AcceptedIOType = typing.Union[FileLike, StringPathLike]

BusConfig = typing.NewType("BusConfig", typing.Dict[str, typing.Any])

AutoDetectedConfig = typing_extensions.TypedDict(

"AutoDetectedConfig", {"interface": str, "channel": Channel}

)

ReadableBytesLike = typing.Union[bytes, bytearray, memoryview]