mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 15:17:00 +01:00
63 lines
2.3 KiB
Python
63 lines
2.3 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2022
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains custom typing aliases for internal use within the library.
|
|
|
|
Warning:
|
|
Contents of this module are intended to be used internally by the library and *not* by the
|
|
user. Changes to this module are not considered breaking changes and may not be documented in
|
|
the changelog.
|
|
"""
|
|
from pathlib import Path
|
|
from typing import (
|
|
IO,
|
|
TYPE_CHECKING,
|
|
Any,
|
|
Dict,
|
|
List,
|
|
Optional,
|
|
Tuple,
|
|
TypeVar,
|
|
Union,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import InputFile # noqa: F401
|
|
from telegram.utils.defaultvalue import DefaultValue # noqa: F401
|
|
|
|
FileLike = Union[IO, 'InputFile']
|
|
"""Either an open file handler or a :class:`telegram.InputFile`."""
|
|
|
|
FileInput = Union[str, bytes, FileLike, Path]
|
|
"""Valid input for passing files to Telegram. Either a file id as string, a file like object,
|
|
a local file path as string, :class:`pathlib.Path` or the file contents as :obj:`bytes`."""
|
|
|
|
JSONDict = Dict[str, Any]
|
|
"""Dictionary containing response from Telegram or data to send to the API."""
|
|
|
|
DVType = TypeVar('DVType')
|
|
ODVInput = Optional[Union['DefaultValue[DVType]', DVType]]
|
|
"""Generic type for bot method parameters which can have defaults. ``ODVInput[type]`` is the same
|
|
as ``Optional[Union[DefaultValue, type]]``."""
|
|
DVInput = Union['DefaultValue[DVType]', DVType]
|
|
"""Generic type for bot method parameters which can have defaults. ``DVInput[type]`` is the same
|
|
as ``Union[DefaultValue, type]``."""
|
|
|
|
RT = TypeVar("RT")
|
|
SLT = Union[RT, List[RT], Tuple[RT, ...]]
|
|
"""Single instance or list/tuple of instances."""
|