fastvk

Основные экспорты пакета. Всё необходимое для базового использования импортируется прямо из fastvk.

from fastvk import (
    FastVK,
    Bot,
    Router,
    F,
    Command,
    CommandStart,
    CommandHelp,
)

FastVK

FastVK — подкласс Bot с удобным методом run_polling().

class FastVK(Bot):
    def __init__(
        self,
        token: str,
        group_id: int,
        *,
        storage: BaseStorage | None = None,
        lifespan: AsyncContextManager | None = None,
        dashboard: BaseDashboard | None = None,
    ) -> None: ...

    def run_polling(self) -> None:
        """Блокирующий. Запускает asyncio.run внутри."""

DashboardConfig

Датакласс с настройками сервера дашборда.

@dataclass
class DashboardConfig:
    dashboard: bool = True          # включить/выключить
    dashboard_host: str = "127.0.0.1"
    dashboard_port: int = 8080

BaseDashboard

Базовый класс конфигурации дашборда. Создай подкласс и переопредели config.

class BaseDashboard:
    config: DashboardConfig = DashboardConfig()

Использование:

from fastvk import FastVK
from fastvk.dashboard import BaseDashboard, DashboardConfig

class MyDashboard(BaseDashboard):
    config = DashboardConfig(
        dashboard_host="0.0.0.0",
        dashboard_port=8080,
    )

bot = FastVK(token=TOKEN, group_id=GROUP_ID, dashboard=MyDashboard())

dashboard=None (по умолчанию) — дашборд отключён.

Bot

class Bot(Router):
    token: str
    group_id: int

    async def start_polling(self, *, skip_updates: bool = False) -> None: ...
    async def stop(self) -> None: ...

    async def get_me(self) -> Group: ...
    async def get_user(self, user_id: int, fields: str = "") -> User: ...

    # пространства методов
    messages: MessagesNamespace
    users: UsersNamespace
    groups: GroupsNamespace
    wall: WallNamespace
    photos: PhotosNamespace
    docs: DocsNamespace

Router

class Router:
    def message(self, *filters) -> Callable: ...
    def callback(self, *filters) -> Callable: ...
    def error(self) -> Callable: ...
    def include_router(self, router: Router) -> None: ...

F

Magic filter объект. Смотри Фильтры.

F.text == "hello"
F.text.startswith("!")
F.text.regexp(r"\d+")
F.from_id.in_(1, 2, 3)
~F.text.startswith("/")
(F.text == "a") | (F.text == "b")

Command, CommandStart, CommandHelp

class Command:
    def __init__(self, *commands: str, prefix: str = "/") -> None: ...

class CommandStart(Command):
    """Совпадает с /start"""

class CommandHelp(Command):
    """Совпадает с /help"""