config module

class config.BotConfig(BOT_TOKEN, MONGODB_URL, DATABASE_NAME='code_keeper_bot', REDIS_URL=None, CACHE_ENABLED=True, GITHUB_TOKEN=None, PASTEBIN_API_KEY=None, MAX_CODE_SIZE=100000, MAX_FILES_PER_USER=1000, SUPPORTED_LANGUAGES=None, PUBLIC_BASE_URL=None, WEBAPP_URL=None, MAINTENANCE_MODE=False, MAINTENANCE_MESSAGE='🚀 אנחנו מעלים עדכון חדש!\\nהבוט יחזור לפעול ממש בקרוב (1 - 3 דקות)', MAINTENANCE_AUTO_WARMUP_SECS=180, HIGHLIGHT_THEME='github-dark', GIT_CHECKPOINT_PREFIX='checkpoint', GOOGLE_CLIENT_ID=None, GOOGLE_CLIENT_SECRET=None, GOOGLE_OAUTH_SCOPES='https://www.googleapis.com/auth/drive.file', GOOGLE_TOKEN_REFRESH_MARGIN_SECS=120, DRIVE_MENU_V2=True, DOCUMENTATION_URL='https://amirbiron.github.io/CodeBot/', BOT_LABEL='CodeBot', DRIVE_ADD_HASH=False)[מקור]

Bases: object

קונפיגורציה עיקרית של הבוט

פרמטרים:

BOT_TOKEN (str)
MONGODB_URL (str)
DATABASE_NAME (str)
REDIS_URL (str | None)
CACHE_ENABLED (bool)
GITHUB_TOKEN (str | None)
PASTEBIN_API_KEY (str | None)
MAX_CODE_SIZE (int)
MAX_FILES_PER_USER (int)
SUPPORTED_LANGUAGES (list)
PUBLIC_BASE_URL (str | None)
WEBAPP_URL (str | None)
MAINTENANCE_MODE (bool)
MAINTENANCE_MESSAGE (str)
MAINTENANCE_AUTO_WARMUP_SECS (int)
HIGHLIGHT_THEME (str)
GIT_CHECKPOINT_PREFIX (str)
GOOGLE_CLIENT_ID (str | None)
GOOGLE_CLIENT_SECRET (str | None)
GOOGLE_OAUTH_SCOPES (str)
GOOGLE_TOKEN_REFRESH_MARGIN_SECS (int)
DRIVE_MENU_V2 (bool)
DOCUMENTATION_URL (str)
BOT_LABEL (str)
DRIVE_ADD_HASH (bool)

BOT_TOKEN: str

MONGODB_URL: str

DATABASE_NAME: str = 'code_keeper_bot'

REDIS_URL: Optional[str] = None

CACHE_ENABLED: bool = True

GITHUB_TOKEN: Optional[str] = None

PASTEBIN_API_KEY: Optional[str] = None

MAX_CODE_SIZE: int = 100000

MAX_FILES_PER_USER: int = 1000

SUPPORTED_LANGUAGES: list = None

PUBLIC_BASE_URL: Optional[str] = None

WEBAPP_URL: Optional[str] = None

MAINTENANCE_MODE: bool = False

MAINTENANCE_MESSAGE: str = '🚀 אנחנו מעלים עדכון חדש!\nהבוט יחזור לפעול ממש בקרוב (1 - 3 דקות)'

MAINTENANCE_AUTO_WARMUP_SECS: int = 180

HIGHLIGHT_THEME: str = 'github-dark'

GIT_CHECKPOINT_PREFIX: str = 'checkpoint'

GOOGLE_CLIENT_ID: Optional[str] = None

GOOGLE_CLIENT_SECRET: Optional[str] = None

GOOGLE_OAUTH_SCOPES: str = 'https://www.googleapis.com/auth/drive.file'

GOOGLE_TOKEN_REFRESH_MARGIN_SECS: int = 120

DRIVE_MENU_V2: bool = True

DOCUMENTATION_URL: str = 'https://amirbiron.github.io/CodeBot/'

BOT_LABEL: str = 'CodeBot'

DRIVE_ADD_HASH: bool = False

__init__(BOT_TOKEN, MONGODB_URL, DATABASE_NAME='code_keeper_bot', REDIS_URL=None, CACHE_ENABLED=True, GITHUB_TOKEN=None, PASTEBIN_API_KEY=None, MAX_CODE_SIZE=100000, MAX_FILES_PER_USER=1000, SUPPORTED_LANGUAGES=None, PUBLIC_BASE_URL=None, WEBAPP_URL=None, MAINTENANCE_MODE=False, MAINTENANCE_MESSAGE='🚀 אנחנו מעלים עדכון חדש!\\nהבוט יחזור לפעול ממש בקרוב (1 - 3 דקות)', MAINTENANCE_AUTO_WARMUP_SECS=180, HIGHLIGHT_THEME='github-dark', GIT_CHECKPOINT_PREFIX='checkpoint', GOOGLE_CLIENT_ID=None, GOOGLE_CLIENT_SECRET=None, GOOGLE_OAUTH_SCOPES='https://www.googleapis.com/auth/drive.file', GOOGLE_TOKEN_REFRESH_MARGIN_SECS=120, DRIVE_MENU_V2=True, DOCUMENTATION_URL='https://amirbiron.github.io/CodeBot/', BOT_LABEL='CodeBot', DRIVE_ADD_HASH=False)

פרמטרים:

BOT_TOKEN (str)
MONGODB_URL (str)
DATABASE_NAME (str)
REDIS_URL (str | None)
CACHE_ENABLED (bool)
GITHUB_TOKEN (str | None)
PASTEBIN_API_KEY (str | None)
MAX_CODE_SIZE (int)
MAX_FILES_PER_USER (int)
SUPPORTED_LANGUAGES (list)
PUBLIC_BASE_URL (str | None)
WEBAPP_URL (str | None)
MAINTENANCE_MODE (bool)
MAINTENANCE_MESSAGE (str)
MAINTENANCE_AUTO_WARMUP_SECS (int)
HIGHLIGHT_THEME (str)
GIT_CHECKPOINT_PREFIX (str)
GOOGLE_CLIENT_ID (str | None)
GOOGLE_CLIENT_SECRET (str | None)
GOOGLE_OAUTH_SCOPES (str)
GOOGLE_TOKEN_REFRESH_MARGIN_SECS (int)
DRIVE_MENU_V2 (bool)
DOCUMENTATION_URL (str)
BOT_LABEL (str)
DRIVE_ADD_HASH (bool)

Return type:

None

config.load_config()[מקור]

טוען את הקונפיגורציה ממשתני הסביבה

Return type:: BotConfig