API 레퍼런스

버전 정보

koreanbots.version_info

sys.version_info와 비슷한 튜플입니다.

koreanbots.__version__

버전정보의 문자열입니다.

Client

class koreanbots.Koreanbots(client: Optional[koreanbots.typing.Client] = None, api_key: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None, run_task: bool = False, include_shard_count: bool = False)

KoreanbotsRequester를 감싸는 클라이언트 클래스 입니다.

매개변수

• client (Optional[Client]) – discord.Client의 클래스입니다. 만약 필요한 경우 이 인수를 지정하세요.

• api_key (Optional[str]) – API key를 지정합니다. 만약 필요한 경우 이 키를 지정하세요.

• session (Optional[aiohttp.ClientSession]) – aiohttp.ClientSession의 클래스입니다. 만약 필요한 경우 이 인수를 지정하세요. 지정하지 않으면 생성합니다.

• run_task (bool) – 봇 정보를 갱신하는 작업을 자동으로 실행합니다. 만약 아니라면 지정하지 않습니다.

• include_shard_count (bool) – 샤드 갯수를 포함할지 지정합니다. 만약 아니라면 지정하지 않습니다.

async botinfo(bot_id: int) → koreanbots.model.KoreanbotsBot

봇 정보를 가져옵니다.

매개변수

bot_id (int) – 요청할 봇의 ID를 지정합니다.

반환값

봇 정보를 담고 있는 KoreanbotsBot클래스입니다.

반환 형식

KoreanbotsBot

async guildcount(bot_id: int, **kwargs: Optional[int]) → None

길드 갯수를 서버에 전송합니다.

매개변수

bot_id (int) – 요청할 bot의 ID를 지정합니다.

async tasks_send_guildcount() → None

길드 갯수를 서버에 전송하는 태스크 입니다.

예외 발생

RuntimeError – 클라이언트를 찾을 수 없습니다.

async userinfo(user_id: int) → koreanbots.model.KoreanbotsUser

유저 정보를 가져옵니다.

매개변수

user_id (int) – 요청할 유저의 ID를 지정합니다.

반환값

유저 정보를 담고 있는 KoreanbotsUser클래스입니다.

반환 형식

KoreanbotsUser

async widget(widget_type: Literal[votes, servers, status], bot_id: int, style: Literal[classic, flat] = 'flat', scale: float = 1.0, icon: bool = False) → str

주어진 bot_id로 widget의 url을 반환합니다.

매개변수

• widget_type (WidgetType) – 요청할 widget의 타입을 지정합니다.

• bot_id (int) – 요청할 bot의 ID를 지정합니다.

• style (WidgetStyle, optional) – 요청할 widget의 형식을 지정합니다. 기본값은 flat로 설정되어 있습니다.

• scale (float, optional) – 요청할 widget의 크기를 지정합니다. 반드시 0.5이상이어야 합니다. 기본값은 1.0입니다.

• icon (bool, optional) – 요청할 widget의 아이콘을 표시할지를 지정합니다. 기본값은 False입니다.

반환값

위젯 url을 반환합니다.

반환 형식

str

HTTP

class koreanbots.KoreanbotsRequester(api_key: Optional[str] = None, session: Optional[aiohttp.client.ClientSession] = None)

Koreanbots의 API를 요청하는 클래스입니다.

매개변수

• api_key (Optional[str], optional) – KoreanBots의 토큰입니다. 기본값은 None 입니다.

• session (Optional[aiohttp.ClientSession], optional) – aiohttp.ClientSession의 클래스입니다. 전달되지 않으면 생성합니다. 기본값은 None 입니다.

async get_bot_info(bot_id: int) → Dict[str, Any]

주어진 bot_id로 bot의 정보를 반환합니다.

매개변수

bot_id (int) – 요청할 bot의 ID를 지정합니다.

반환값

요청 결과를 반환합니다.

반환 형식

Dict[str, Any]

async get_bot_widget_url(widget_type: Literal[votes, servers, status], bot_id: int, style: Literal[classic, flat] = 'flat', scale: float = 1.0, icon: bool = False) → str

주어진 bot_id로 widget의 url을 반환합니다.

매개변수

• widget_type (WidgetType) – 요청할 widget의 타입을 지정합니다.

• bot_id (int) – 요청할 bot의 ID를 지정합니다.

• style (WidgetStyle, optional) – 요청할 widget의 형식을 지정합니다. 기본값은 flat로 설정되어 있습니다.

• scale (float, optional) – 요청할 widget의 크기를 지정합니다. 반드시 0.5이상이어야 합니다. 기본값은 1.0입니다.

• icon (bool, optional) – 요청할 widget의 아이콘을 표시할지를 지정합니다. 기본값은 False입니다.

반환값

위젯 url을 반환합니다.

반환 형식

str

async get_user_info(user_id: int)

주어진 user_id로 user의 정보를 반환합니다.

매개변수

user_id (int) – 요청할 user의 ID를 지정합니다.

async post_update_bot_info(bot_id: int, **kwargs: int) → Dict[str, Any]

주어진 bot_id로 bot의 정보를 갱신합니다.

매개변수

• bot_id (int) – 요청할 bot의 ID를 지정합니다.

• kwargs (int) – 갱신할 정보를 지정합니다. 〈servers〉 인자와 〈shards〉 인자 이외의 값이 들어갈경우 무시합니다.

예외 발생

AuthorizeError – api_key가 없거나 유효하지 않은 경우。

반환값

요청 결과를 반환합니다.

반환 형식

Dict[str, Any]

async request(method: Literal[GET, POST], endpoint: str, **kwargs: Any) → Dict[str, Any]

Koreanbots의 url을 기반으로 요청합니다. 레이트리밋을 핸들합니다.

매개변수

• method (Literal["GET", "POST"]) – HTTP 메소드입니다. GET, POST만 사용할 수 있습니다.

• endpoint (str) – 요청을 실행할 API 페이지의 주소입니다.

예외 발생

• NotFound – 요청할 수 없는 페이지입니다.

• BadRequest – 잘못된 요청입니다.

• Forbidden – 요청을 할 권한이 없습니다.

• HTTPException – 응답에 오류가 있습니다.

반환값

요청 결과를 반환합니다.

반환 형식

Dict[str, Any]

Model

class koreanbots.KoreanbotsBot(init_in_user: bool = False, **response_data: Any)

봇의 정보를 가져왔을떄 반환되는 인스턴스입니다.

매개변수

init_in_user (bool) – 유저 클래스에서 초기화 되었는지 여부입니다. 기본값은 False입니다.

property avatar: Optional[str]

아바타를 반환합니다.

반환값

아바타 url

반환 형식

Optional[str]

property banner: Optional[str]

배너 이미지 주소를 반환합니다.

반환값

배너 이미지 주소

반환 형식

Optional[str]

property bg: Optional[str]

배경 이미지 주소를 반환합니다.

반환값

배경 이미지 주소

반환 형식

Optional[str]

property category: Optional[Literal[관리, 뮤직, 전적, 게임, 도박, 로깅, 빗금 명령어, 웹 대시보드, 밈, 레벨링, 유틸리티, 대화, NSFW, 검색, 학교, 코로나19, 번역, 오버워치, 리그 오브 레전드, 배틀그라운드, 마인크래프트]]

카테고리를 반환합니다.

반환값

카테고리

반환 형식

Optional[Category]

property desc: Optional[str]

설명문구를 반환합니다.

반환값

설명문구

반환 형식

Optional[str]

property discord: Optional[str]

디스코드 주소를 반환합니다.

반환값

디스코드 주소

반환 형식

Optional[str]

property flags: int

플래그를 반환합니다.

반환값

플래그

반환 형식

int

property git: Optional[str]

깃 주소를 반환합니다.

반환값

깃 주소

반환 형식

Optional[str]

property id: Optional[str]

아이디를 반환합니다.

반환값

아이디

반환 형식

Optional[str]

property intro: Optional[str]

소개문구를 반환합니다.

반환값

소개문구

반환 형식

Optional[str]

property lib: Optional[str]

봇이 사용한 라이브러리를 반환합니다.

반환값

라이브러리

반환 형식

Optional[str]

property name: Optional[str]

이름을 반환합니다.

반환값

이름

반환 형식

Optional[str]

property owners: Union[List[koreanbots.model.KoreanbotsUser], List[str]]

소유자를 반환합니다. ※ init_in_user가 True인경우 소유자들의 ID를 반환합니다.

반환값

소유자들의 ID들을 담고 있는 리스트 또는 KoreanbotsUser 인스턴스를 담고있는 리스트

반환 형식

Union[List[str], List[KoreanbotsUser]]

property prefix: Optional[str]

프리픽스를 반환합니다.

반환값

프리픽스

반환 형식

Optional[str]

property servers: int

서버수를 반환합니다.

반환값

서버수

반환 형식

int

property shards: int

샤드수를 반환합니다.

반환값

샤드수

반환 형식

int

property state: Optional[Literal[ok, reported, blocked, private, archived]]

Koreanbots에서의 상태를 반환합니다.

반환값

Koreanbots에서의 상태

반환 형식

Optional[State]

property status: Optional[Literal[online, idle, dnd, streaming, offline]]

상태를 반환합니다.

반환값

상태

반환 형식

Optional[Status]

property tag: Optional[str]

태그를 반환합니다.

반환값

태그

반환 형식

Optional[str]

property url: Optional[str]

주소를 반환합니다

반환값

주소

반환 형식

Optional[str]

property vanity: Optional[str]

봇의 가상 주소를 반환합니다.

반환값

봇의 가상 주소

반환 형식

Optional[str]

property votes: int

투표수를 반환합니다.

반환값

투표수

반환 형식

int

property web: Optional[str]

웹사이트 주소를 반환합니다.

반환값

웹사이트 주소

반환 형식

Optional[str]

class koreanbots.KoreanbotsUser(init_in_bot: bool = False, **response_data: Any)

유저 정보를 가져왔을때 반환되는 클래스입니다.

매개변수

init_in_bot (bool) – 봇 클래스에서 초기화 되었는지 여부입니다. 기본값은 False입니다.

property bots: Union[List[koreanbots.model.KoreanbotsBot], List[str]]

봇들을 반환합니다. ※ init_in_bot가 True인경우 봇들의 ID를 반환합니다.

반환값

봇들의 ID들을 담고 있는 리스트 또는 KoreanbotsUser 인스턴스를 담고있는 리스트

반환 형식

Union[List[str], List[KoreanbotsUser]]

property flags: int

플래그를 반환합니다.

반환값

플래그

반환 형식

int

property github: Optional[str]

GitHub 주소를 반환합니다.

반환값

GitHub 주소

반환 형식

Optional[str]

property id: int

ID를 반환합니다.

반환값

ID

반환 형식

int

property tag: str

태그를 반환합니다.

반환값

태그

반환 형식

str

property username: str

유저 이름을 반환합니다.

반환값

유저 이름

반환 형식

str

예외

exception koreanbots.KoreanbotsException

exception koreanbots.AuthorizeError

exception koreanbots.HTTPException(code: Any, message: Union[Any, Dict[str, Any]])

exception koreanbots.BadRequest(code: Any, message: Union[Any, Dict[str, Any]])

exception koreanbots.Forbidden(code: Any, message: Union[Any, Dict[str, Any]])

exception koreanbots.NotFound(code: Any, message: Union[Any, Dict[str, Any]])