From 553fbffa74b05cecc5667be4ac4e20720b5439ea Mon Sep 17 00:00:00 2001 From: ppotatoo <76911441+ppotatoo@users.noreply.github.com> Date: Thu, 2 Sep 2021 15:16:25 -0400 Subject: [PATCH] Ran isort over directory and added __all__ --- docs/conf.py | 1 + examples/basic.py | 5 ++++- revolt/__init__.py | 5 +++-- revolt/asset.py | 10 +++++++--- revolt/channel.py | 11 +++++++++-- revolt/client.py | 12 ++++++++---- revolt/embed.py | 3 +++ revolt/enums.py | 8 ++++++++ revolt/errors.py | 8 ++++++++ revolt/file.py | 5 +++-- revolt/http.py | 20 ++++++++++++++++---- revolt/member.py | 5 ++++- revolt/message.py | 5 ++++- revolt/messageable.py | 10 ++++++---- revolt/permissions.py | 3 +++ revolt/role.py | 4 +++- revolt/server.py | 9 ++++++--- revolt/state.py | 18 +++++++++++++----- revolt/types/category.py | 3 +++ revolt/types/channel.py | 13 +++++++++++-- revolt/types/embed.py | 2 ++ revolt/types/file.py | 4 +++- revolt/types/gateway.py | 11 +++++++++-- revolt/types/http.py | 10 +++++++++- revolt/types/invite.py | 6 ++++++ revolt/types/member.py | 3 +++ revolt/types/message.py | 11 +++++++---- revolt/types/role.py | 2 ++ revolt/types/server.py | 11 +++++++++-- revolt/types/user.py | 10 +++++++++- revolt/user.py | 8 ++++++-- revolt/utils.py | 2 ++ revolt/websocket.py | 12 +++++++++--- setup.py | 3 ++- 34 files changed, 201 insertions(+), 52 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 65377fc..bb4e81b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,7 @@ import os import sys + import sphinx_nameko_theme sys.path.insert(0, os.path.abspath('..')) diff --git a/examples/basic.py b/examples/basic.py index 2728436..abb00ac 100644 --- a/examples/basic.py +++ b/examples/basic.py @@ -1,7 +1,10 @@ -import revolt import asyncio + import aiohttp +import revolt + + class Client(revolt.Client): async def on_message(self, message: revolt.Message): if message.content == "hello": diff --git a/revolt/__init__.py b/revolt/__init__.py index d6be959..dff308b 100644 --- a/revolt/__init__.py +++ b/revolt/__init__.py @@ -1,5 +1,6 @@ from .asset import Asset -from .channel import DMChannel, Channel, GroupDMChannel, SavedMessageChannel, VoiceChannel, TextChannel +from .channel import (Channel, DMChannel, GroupDMChannel, SavedMessageChannel, + TextChannel, VoiceChannel) from .client import Client from .embed import Embed from .errors import HTTPError, RevoltError, ServerError @@ -10,6 +11,6 @@ from .messageable import Messageable from .permissions import Permissions from .role import Role from .server import Server -from .user import User, Status, Relation +from .user import Relation, Status, User __version__ = (0, 0, 1) diff --git a/revolt/asset.py b/revolt/asset.py index 53cd431..9339c53 100644 --- a/revolt/asset.py +++ b/revolt/asset.py @@ -2,14 +2,18 @@ from __future__ import annotations from typing import TYPE_CHECKING -from .errors import AutumnDisabled from .enums import AssetType +from .errors import AutumnDisabled if TYPE_CHECKING: - from .types import File as FilePayload - from .state import State from io import IOBase + from .state import State + from .types import File as FilePayload + + +__all__ = ("Asset",) + class Asset: """Represents a file on revolt diff --git a/revolt/channel.py b/revolt/channel.py index a28b3ea..f59a5af 100644 --- a/revolt/channel.py +++ b/revolt/channel.py @@ -2,14 +2,21 @@ from __future__ import annotations from typing import TYPE_CHECKING, cast -from .messageable import Messageable from .enums import ChannelType +from .messageable import Messageable if TYPE_CHECKING: - from .types import Channel as ChannelPayload, SavedMessages as SavedMessagesPayload, DMChannel as DMChannelPayload, Group as GroupDMChannelPayload, TextChannel as TextChannelPayload from .state import State + from .types import Channel as ChannelPayload + from .types import DMChannel as DMChannelPayload + from .types import Group as GroupDMChannelPayload + from .types import SavedMessages as SavedMessagesPayload + from .types import TextChannel as TextChannelPayload from .user import User + +__all__ = ("Channel",) + class Channel: """Base class for all channels diff --git a/revolt/client.py b/revolt/client.py index 51a12cd..d5ccf6d 100644 --- a/revolt/client.py +++ b/revolt/client.py @@ -1,9 +1,10 @@ from __future__ import annotations import asyncio -import aiohttp -from typing import Any, Callable, TypeVar, Coroutine, TYPE_CHECKING, Optional import logging +from typing import TYPE_CHECKING, Any, Callable, Coroutine, Optional, TypeVar + +import aiohttp from .http import HttpClient from .state import State @@ -15,10 +16,13 @@ except ImportError: import json if TYPE_CHECKING: + from .channel import Channel + from .server import Server from .types import ApiInfo from .user import User - from .server import Server - from .channel import Channel + + +__all__ = ("Client",) logger = logging.getLogger("revolt") diff --git a/revolt/embed.py b/revolt/embed.py index f86d14f..793a31f 100644 --- a/revolt/embed.py +++ b/revolt/embed.py @@ -5,6 +5,9 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: from .types import Embed as EmbedPayload + +__all__ = ("Embed",) + class Embed: @classmethod def from_dict(cls, data: EmbedPayload): diff --git a/revolt/enums.py b/revolt/enums.py index 9207166..a809e26 100644 --- a/revolt/enums.py +++ b/revolt/enums.py @@ -7,6 +7,14 @@ if TYPE_CHECKING: else: import aenum as enum + +__all__ = ( + "ChannelType", + "PresenceType", + "RelationshipType", + "AssetType" +) + class ChannelType(enum.Enum): saved_message = "SavedMessage" direct_message = "DirectMessage" diff --git a/revolt/errors.py b/revolt/errors.py index 613f6dc..e342807 100644 --- a/revolt/errors.py +++ b/revolt/errors.py @@ -1,3 +1,11 @@ +__all__ = ( + "RevoltError", + "HTTPError", + "ServerError", + "FeatureDisabled", + "AutumnDisabled" +) + class RevoltError(Exception): "Base exception for revolt" diff --git a/revolt/file.py b/revolt/file.py index 1fb106d..c37cabe 100644 --- a/revolt/file.py +++ b/revolt/file.py @@ -1,7 +1,8 @@ -from typing import Optional, Union - import io import os +from typing import Optional, Union + +__all__ = ("File",) class File: """Respresents a file about to be uploaded to revolt diff --git a/revolt/http.py b/revolt/http.py index a8188f8..7be4a4a 100644 --- a/revolt/http.py +++ b/revolt/http.py @@ -1,6 +1,8 @@ from __future__ import annotations -from typing import Any, Coroutine, Optional, TYPE_CHECKING, Literal, TypeVar, Union +from typing import (TYPE_CHECKING, Any, Coroutine, Literal, Optional, TypeVar, + Union) + import aiohttp import ulid @@ -14,10 +16,20 @@ except ImportError: if TYPE_CHECKING: import aiohttp - from .types import ( - ApiInfo, Autumn as AutumnPayload, Message as MessagePayload, Embed as EmbedPayload, GetServerMembers, User as UserPayload, - Server, Member, UserProfile, ServerInvite, ServerBans, Channel, DMChannel, TextChannel, VoiceChannel, Role) + from .file import File + from .types import ApiInfo + from .types import Autumn as AutumnPayload + from .types import Channel, DMChannel + from .types import Embed as EmbedPayload + from .types import GetServerMembers, Member + from .types import Message as MessagePayload + from .types import Role, Server, ServerBans, ServerInvite, TextChannel + from .types import User as UserPayload + from .types import UserProfile, VoiceChannel + + +__all__ = ("HttpClient",) T = TypeVar("T") Request = Coroutine[Any, Any, T] diff --git a/revolt/member.py b/revolt/member.py index 0abd026..97b985b 100644 --- a/revolt/member.py +++ b/revolt/member.py @@ -5,9 +5,12 @@ from typing import TYPE_CHECKING from .user import User if TYPE_CHECKING: + from .server import Server from .state import State from .types import Member as MemberPayload - from .server import Server + + +__all__ = ("Member",) def flattern_user(member: Member, user: User): for attr in user.__flattern_attributes__: diff --git a/revolt/message.py b/revolt/message.py index 52408a0..a8ad6f7 100644 --- a/revolt/message.py +++ b/revolt/message.py @@ -3,13 +3,16 @@ from __future__ import annotations from typing import TYPE_CHECKING from .asset import Asset -from .embed import Embed from .channel import Messageable +from .embed import Embed if TYPE_CHECKING: from .state import State from .types import Message as MessagePayload + +__all__ = ("Message",) + class Message: """Represents a message diff --git a/revolt/messageable.py b/revolt/messageable.py index 31b4947..769aeb7 100644 --- a/revolt/messageable.py +++ b/revolt/messageable.py @@ -1,13 +1,15 @@ from __future__ import annotations -from typing import Optional, TYPE_CHECKING - +from typing import TYPE_CHECKING, Optional if TYPE_CHECKING: - from .state import State - from .message import Message from .embed import Embed from .file import File + from .message import Message + from .state import State + + +__all__ = ("Messageable",) class Messageable: """Base class for all channels that you can send messages in diff --git a/revolt/permissions.py b/revolt/permissions.py index bc8e918..a4ade1e 100644 --- a/revolt/permissions.py +++ b/revolt/permissions.py @@ -5,6 +5,9 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: from .types import Permission as PermissionTuple + +__all__ = ("Permissions",) + class Permissions: def __init__(self, permission_tuple: PermissionTuple): ... diff --git a/revolt/role.py b/revolt/role.py index b0c4c2f..23cd5ac 100644 --- a/revolt/role.py +++ b/revolt/role.py @@ -2,11 +2,13 @@ from __future__ import annotations from typing import TYPE_CHECKING - if TYPE_CHECKING: from .state import State from .types import Role as RolePayload + +__all__ = ("Role",) + class Role: """Represents a role diff --git a/revolt/server.py b/revolt/server.py index 3d9611e..3750961 100644 --- a/revolt/server.py +++ b/revolt/server.py @@ -2,14 +2,17 @@ from __future__ import annotations from typing import TYPE_CHECKING, Optional, cast +from .channel import Channel from .permissions import Permissions from .role import Role -from .channel import Channel if TYPE_CHECKING: - from .types import Server as ServerPayload - from .state import State from .member import Member + from .state import State + from .types import Server as ServerPayload + + +__all__ = ("Server",) class Server: """Represents a server diff --git a/revolt/state.py b/revolt/state.py index 9756748..9b11334 100644 --- a/revolt/state.py +++ b/revolt/state.py @@ -1,17 +1,25 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Optional from collections import deque +from typing import TYPE_CHECKING, Optional -from .user import User from .channel import Channel, channel_factory -from .server import Server -from .message import Message from .member import Member +from .message import Message +from .server import Server +from .user import User if TYPE_CHECKING: from .http import HttpClient - from .types import ApiInfo, User as UserPayload, Channel as ChannelPayload, Server as ServerPayload, Message as MessagePayload, Member as MemberPayload + from .types import ApiInfo + from .types import Channel as ChannelPayload + from .types import Member as MemberPayload + from .types import Message as MessagePayload + from .types import Server as ServerPayload + from .types import User as UserPayload + + +__all__ = ("State",) class State: def __init__(self, http: HttpClient, api_info: ApiInfo, max_messages: int): diff --git a/revolt/types/category.py b/revolt/types/category.py index 5f71077..1fa69b8 100644 --- a/revolt/types/category.py +++ b/revolt/types/category.py @@ -3,6 +3,9 @@ from typing import TYPE_CHECKING, TypedDict if TYPE_CHECKING: from .channel import Channel + +__all__ = ("Category",) + class Category(TypedDict): id: str title: str diff --git a/revolt/types/channel.py b/revolt/types/channel.py index 0e68a76..14c3de9 100644 --- a/revolt/types/channel.py +++ b/revolt/types/channel.py @@ -1,10 +1,19 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, Literal, Union +from typing import TYPE_CHECKING, Literal, TypedDict, Union if TYPE_CHECKING: - from .message import Message from .file import File + from .message import Message + + +__all__ = ( + "DMChannel", + "Group", + "TextChannel", + "VoiceChannel", + "Channel" +) class _NonceChannel(TypedDict, total=False): nonce: str diff --git a/revolt/types/embed.py b/revolt/types/embed.py index 9f9b0af..d0173ea 100644 --- a/revolt/types/embed.py +++ b/revolt/types/embed.py @@ -2,5 +2,7 @@ from __future__ import annotations from typing import TYPE_CHECKING, TypedDict +__all__ = ("Embed",) + class Embed(TypedDict): pass # TODO diff --git a/revolt/types/file.py b/revolt/types/file.py index 038a183..02fe4c3 100644 --- a/revolt/types/file.py +++ b/revolt/types/file.py @@ -1,6 +1,8 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, Literal, Union +from typing import TYPE_CHECKING, Literal, TypedDict, Union + +__all__ = ("File",) class SizedMetadata(TypedDict): type: Literal["Image", "Video"] diff --git a/revolt/types/gateway.py b/revolt/types/gateway.py index 8adbaac..5a7cf5b 100644 --- a/revolt/types/gateway.py +++ b/revolt/types/gateway.py @@ -5,10 +5,17 @@ from typing import TYPE_CHECKING, TypedDict from .message import Message if TYPE_CHECKING: - from .user import User - from .server import Server from .channel import Channel from .member import Member + from .server import Server + from .user import User + + +__all__ = ( + "AuthenticatePayload", + "ReadyEventPayload", + "MessageEventPayload" +) class BasePayload(TypedDict): type: str diff --git a/revolt/types/http.py b/revolt/types/http.py index 7ad2d48..c79ee59 100644 --- a/revolt/types/http.py +++ b/revolt/types/http.py @@ -3,8 +3,16 @@ from __future__ import annotations from typing import TYPE_CHECKING, TypedDict if TYPE_CHECKING: - from .user import User from .member import Member + from .user import User + + +__all__ = ( + "VosoFeature", + "ApiInfo", + "Autumn", + "GetServerMembers" +) class ApiFeature(TypedDict): enabled: bool diff --git a/revolt/types/invite.py b/revolt/types/invite.py index f8849ed..aa1d8d3 100644 --- a/revolt/types/invite.py +++ b/revolt/types/invite.py @@ -1,5 +1,11 @@ from typing import Literal, TypedDict, Union +__all__ = ( + "GroupInvite", + "ServerInvite", + "Invite" +) + class GroupInvite(TypedDict): type: Literal["Group"] _id: str diff --git a/revolt/types/member.py b/revolt/types/member.py index 6d3fc2c..97033e8 100644 --- a/revolt/types/member.py +++ b/revolt/types/member.py @@ -5,6 +5,9 @@ from typing import TYPE_CHECKING, TypedDict if TYPE_CHECKING: from .file import File + +__all__ = ("Member",) + class _MemberOptional(TypedDict, total=False): nickname: str avatar: File diff --git a/revolt/types/message.py b/revolt/types/message.py index 3b1a7e5..e3500be 100644 --- a/revolt/types/message.py +++ b/revolt/types/message.py @@ -3,8 +3,11 @@ from __future__ import annotations from typing import TYPE_CHECKING, TypedDict, Union if TYPE_CHECKING: - from .file import File from .embed import Embed + from .file import File + + +__all__ = ("Message",) class UserAddContent(TypedDict): id: str @@ -24,7 +27,7 @@ class UserLeftContent(TypedDict): class UserKickedContent(TypedDict): id: str -class UserBanned(TypedDict): +class UserBannedContent(TypedDict): id: str class ChannelRenameContent(TypedDict): @@ -34,7 +37,7 @@ class ChannelRenameContent(TypedDict): class ChannelDescriptionChangeContent(TypedDict): by: str -class ChannelIconChanged(TypedDict): +class ChannelIconChangeContent(TypedDict): by: str class _OptionalMessage(TypedDict): @@ -45,4 +48,4 @@ class Message(_OptionalMessage): _id: str channel: str author: str - content: Union[str, UserAddContent, UserRemoveContent, UserJoinedContent, UserLeftContent, UserKickedContent, UserBanned, ChannelRenameContent, ChannelDescriptionChangeContent, ChannelIconChanged] + content: Union[str, UserAddContent, UserRemoveContent, UserJoinedContent, UserLeftContent, UserKickedContent, UserBannedContent, ChannelRenameContent, ChannelDescriptionChangeContent, ChannelIconChangeContent] diff --git a/revolt/types/role.py b/revolt/types/role.py index 4720c3a..1618237 100644 --- a/revolt/types/role.py +++ b/revolt/types/role.py @@ -2,6 +2,8 @@ from __future__ import annotations from typing import TypedDict +__all__ = ("Role",) + Permission = tuple[int, int] class _RoleOptional(TypedDict, total=False): diff --git a/revolt/types/server.py b/revolt/types/server.py index 82114ae..7292694 100644 --- a/revolt/types/server.py +++ b/revolt/types/server.py @@ -3,10 +3,17 @@ from __future__ import annotations from typing import TYPE_CHECKING, TypedDict if TYPE_CHECKING: - from .role import Role, Permission - from .file import File from .category import Category from .channel import Channel + from .file import File + from .role import Permission, Role + +__all__ = ( + "Server", + "BannedUser", + "Ban", + "ServerBans" +) class SystemMessagesConfig(TypedDict, total=False): user_joined: str diff --git a/revolt/types/user.py b/revolt/types/user.py index fabad1f..68f35e9 100644 --- a/revolt/types/user.py +++ b/revolt/types/user.py @@ -1,10 +1,18 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, Literal +from typing import TYPE_CHECKING, Literal, TypedDict if TYPE_CHECKING: from .file import File +__all__ = ( + "Relation", + "UserBot", + "Status", + "User", + "UserProfile" +) + Relation = Literal["Blocked", "BlockedOther", "Friend", "Incoming", "None", "Outgoing", "User"] class UserBot(TypedDict): diff --git a/revolt/user.py b/revolt/user.py index 1efef2f..8af2089 100644 --- a/revolt/user.py +++ b/revolt/user.py @@ -3,11 +3,15 @@ from __future__ import annotations from typing import TYPE_CHECKING, NamedTuple, Optional from .asset import Asset -from .enums import RelationshipType, PresenceType +from .enums import PresenceType, RelationshipType if TYPE_CHECKING: from .state import State - from .types import User as UserPayload, UserRelation + from .types import User as UserPayload + from .types import UserRelation + + +__all__ = ("User",) class Relation(NamedTuple): """A namedtuple representing a relation between the bot and a user""" diff --git a/revolt/utils.py b/revolt/utils.py index 3f5a036..f889f49 100644 --- a/revolt/utils.py +++ b/revolt/utils.py @@ -1,3 +1,5 @@ +__all__ = ("Missing",) + class _Missing: def __repr__(self): return "" diff --git a/revolt/websocket.py b/revolt/websocket.py index 664e68e..e481114 100644 --- a/revolt/websocket.py +++ b/revolt/websocket.py @@ -1,8 +1,8 @@ from __future__ import annotations -from typing import Callable, TYPE_CHECKING, cast -import logging import asyncio +import logging +from typing import TYPE_CHECKING, Callable, cast from .types import Message as MessagePayload @@ -19,8 +19,14 @@ except ImportError: if TYPE_CHECKING: import aiohttp - from .types import BasePayload, AuthenticatePayload, ReadyEventPayload, MessageEventPayload, Member as MemberPayload + from .state import State + from .types import AuthenticatePayload, BasePayload + from .types import Member as MemberPayload + from .types import MessageEventPayload, ReadyEventPayload + + +__all__ = ("WebsocketHandler",) logger = logging.getLogger("revolt") diff --git a/setup.py b/setup.py index 8ecdf90..302541f 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ -from setuptools import setup, find_packages import pathlib +from setuptools import find_packages, setup + here = pathlib.Path(__file__).parent.resolve() long_description = (here / "README.md").read_text(encoding="utf-8")