Video and audio downloading related classes, mainly used for Discord voice bots.
+royalnet.audio.PlayMode¶The base class for a PlayMode, such as royalnet.audio.Playlist. Inherit from this class if you want to create a custom PlayMode.
__init__()¶Create a new PlayMode and initialize the generator inside.
+_generate_generator()¶Factory function for an async generator that changes the now_playing property either to a discord.audio.RoyalPCMAudio or to None, then yields the value it changed it to.
The royalnet.audio.RoyalPCMAudio to be played next.
add(item: royalnet.audio.royalpcmaudio.RoyalPCMAudio) → None¶Add a new royalnet.audio.RoyalPCMAudio to the PlayMode.
item – The item to add to the PlayMode.
+delete() → None¶Delete all royalnet.audio.RoyalPCMAudio contained inside this PlayMode.
next() → Optional[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Get the next royalnet.audio.RoyalPCMAudio from the list and advance it.
The next royalnet.audio.RoyalPCMAudio.
queue_preview() → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Display all the videos in the PlayMode as a list, if possible.
+To be used with queue commands, for example.
+NotImplementedError – If a preview can’t be generated.
+A list of videos contained in the queue.
+royalnet.audio.Playlist(starting_list: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None)¶A video list. royalnet.audio.RoyalPCMAudio played are removed from the list.
__init__(starting_list: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None)¶Create a new Playlist.
+starting_list – A list of items with which the Playlist will be created.
+_generate_generator()¶Factory function for an async generator that changes the now_playing property either to a discord.audio.RoyalPCMAudio or to None, then yields the value it changed it to.
The royalnet.audio.RoyalPCMAudio to be played next.
add(item) → None¶Add a new royalnet.audio.RoyalPCMAudio to the PlayMode.
item – The item to add to the PlayMode.
+delete() → None¶Delete all royalnet.audio.RoyalPCMAudio contained inside this PlayMode.
queue_preview() → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Display all the videos in the PlayMode as a list, if possible.
+To be used with queue commands, for example.
+NotImplementedError – If a preview can’t be generated.
+A list of videos contained in the queue.
+royalnet.audio.Pool(starting_pool: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None)¶A royalnet.audio.RoyalPCMAudio pool. royalnet.audio.RoyalPCMAudio are selected in random order and are not repeated until every song has been played at least once.
__init__(starting_pool: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio] = None)¶Create a new Pool.
+starting_pool – A list of items the Pool will be created from.
+_generate_generator()¶Factory function for an async generator that changes the now_playing property either to a discord.audio.RoyalPCMAudio or to None, then yields the value it changed it to.
The royalnet.audio.RoyalPCMAudio to be played next.
add(item) → None¶Add a new royalnet.audio.RoyalPCMAudio to the PlayMode.
item – The item to add to the PlayMode.
+delete() → None¶Delete all royalnet.audio.RoyalPCMAudio contained inside this PlayMode.
queue_preview() → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Display all the videos in the PlayMode as a list, if possible.
+To be used with queue commands, for example.
+NotImplementedError – If a preview can’t be generated.
+A list of videos contained in the queue.
+royalnet.audio.YtdlFile(info: royalnet.audio.youtubedl.YtdlInfo, outtmpl='%(title)s-%(id)s.%(ext)s', **ytdl_args)¶A wrapper around a youtube_dl downloaded file.
+_stop_download()¶I have no clue of what this does, or why is it here. Possibly remove it?
+InterruptDownload – …uhhh, always?
+create_from_url(url, outtmpl='%(title)s-%(id)s.%(ext)s', **ytdl_args) → List[royalnet.audio.youtubedl.YtdlFile]¶Download the videos at the specified url.
+url – The url to download the videos from.
outtmpl – The filename that the downloaded videos are going to have. The name can be formatted according to the outtmpl documentation.
ytdl_args – Other arguments to be passed to the YoutubeDL object.
A list of YtdlFiles.
delete_video_file()¶Delete the file located at self.video_filename.
Note
+No checks are done when deleting, so it may try to delete a non-existing file and raise an exception or do some other weird stuff with weird filenames.
+ytdl_args = {'logger': <Logger royalnet.audio.youtubedl (WARNING)>, 'no_warnings': True, 'noplaylist': True, 'quiet': True}¶royalnet.audio.YtdlInfo(info: Dict[str, Any])¶A wrapper around youtube_dl extracted info.
+__init__(info: Dict[str, Any])¶Create a YtdlInfo from the dict returned by the youtube_dl.YoutubeDL.extract_info() function.
Warning
+Does not download the info, for that use royalnet.audio.YtdlInfo.create_from_url().
create_from_url(url, **ytdl_args) → List[royalnet.audio.youtubedl.YtdlInfo]¶download(outtmpl='%(title)s-%(id)s.%(ext)s', **ytdl_args) → royalnet.audio.youtubedl.YtdlFile¶to_discord_embed() → discord.embeds.Embed¶royalnet.audio.RoyalPCMFile(info: royalnet.audio.youtubedl.YtdlInfo, **ytdl_args)¶audio_filename¶Returns: +The name of the downloaded and PCM-converted audio file.
+create_from_url(url: str, **ytdl_args) → List[royalnet.audio.royalpcmfile.RoyalPCMFile]¶Download a file with youtube_dl and create a list of discord.audio.RoyalPCMFile.
url – The url of the file to download.
ytdl_args – Extra arguments to be passed to YoutubeDL while downloading.
A list of RoyalPCMAudios, each corresponding to a downloaded video.
create_from_ytsearch(search: str, amount: int = 1, **ytdl_args) → List[royalnet.audio.royalpcmfile.RoyalPCMFile]¶Search a string on YouTube and download the first amount number of videos, then download those with youtube_dl and create a list of discord.audio.RoyalPCMFile.
search – The string to search on YouTube.
amount – The number of videos to download.
ytdl_args – Extra arguments to be passed to YoutubeDL while downloading.
A list of RoyalPCMFiles, each corresponding to a downloaded video.
delete_audio_file()¶Delete the PCM-converted audio file.
+ytdl_args = {'format': 'bestaudio'}¶royalnet.audio.RoyalPCMAudio(rpf: royalnet.audio.royalpcmfile.RoyalPCMFile)¶A discord.AudioSource that keeps data in a file instead of in memory.
__init__(rpf: royalnet.audio.royalpcmfile.RoyalPCMFile)¶Create a discord.audio.RoyalPCMAudio from a royalnet.audio.RoyalPCMFile.
Warning
+Not recommended, use royalnet.audio.RoyalPCMAudio.create_from_url() or royalnet.audio.RoyalPCMAudio.create_from_ytsearch() instead.
create_from_url(url: str) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Download a file with youtube_dl and create a list of RoyalPCMAudios.
+url – The url of the file to download.
+A list of RoyalPCMAudios, each corresponding to a downloaded video.
create_from_ytsearch(search: str, amount: int = 1) → List[royalnet.audio.royalpcmaudio.RoyalPCMAudio]¶Search a string on YouTube and download the first amount number of videos, then download those with youtube_dl and create a list of RoyalPCMAudios.
search – The string to search on YouTube.
amount – The number of videos to download.
A list of RoyalPCMAudios, each corresponding to a downloaded video.
delete()¶Permanently delete the downloaded file.
+is_opus()¶This audio file isn’t Opus-encoded, but PCM-encoded.
+False.
Various bot interfaces, and a generic class to create new ones.
+royalnet.bots.TelegramBot(*, telegram_config: royalnet.bots.telegram.TelegramConfig, royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None, database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None, command_prefix: str = '/', commands: List[Type[royalnet.utils.command.Command]] = None, missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>, error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>)¶A bot that connects to Telegram.
+_call_factory() → Type[royalnet.utils.call.Call]¶Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call.
The created TelegramCall class.
+_handle_update(update: telegram.update.Update)¶_init_client()¶Create the telegram.Bot, and set the starting offset.
botfather_command_string¶Generate a string to be pasted in the “Edit Commands” BotFather prompt.
+interface_name = 'telegram'¶run()¶A blocking coroutine that should make the bot start listening to commands and requests.
+royalnet.bots.TelegramConfig(token: str)¶The specific configuration to be used for royalnet.database.TelegramBot.
royalnet.bots.DiscordBot(*, discord_config: royalnet.bots.discord.DiscordConfig, royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None, database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None, command_prefix: str = '!', commands: List[Type[royalnet.utils.command.Command]] = None, missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>, error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>)¶A bot that connects to Discord.
+_bot_factory() → Type[discord.client.Client]¶Create a custom DiscordClient class inheriting from discord.Client.
_call_factory() → Type[royalnet.utils.call.Call]¶Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call.
The created TelegramCall class.
+_init_client()¶Create an instance of the DiscordClient class created in royalnet.bots.DiscordBot._bot_factory().
_init_voice()¶Initialize the variables needed for the connection to voice chat.
+add_to_music_data(audio_sources: List[royalnet.audio.royalpcmaudio.RoyalPCMAudio], guild: discord.guild.Guild)¶Add a file to the corresponding music_data object.
+advance_music_data(guild: discord.guild.Guild)¶Try to play the next song, while it exists. Otherwise, just return.
+interface_name = 'discord'¶run()¶Login to Discord, then run the bot.
+update_activity_with_source_title()¶Change the bot’s presence (using discord.Client.change_presence()) to match the current listening status.
If multiple guilds are using the bot, the bot will always have an empty presence.
+royalnet.bots.DiscordConfig(token: str)¶The specific configuration to be used for royalnet.bots.DiscordBot.
royalnet.bots.GenericBot(*, royalnet_config: Optional[royalnet.network.royalnetconfig.RoyalnetConfig] = None, database_config: Optional[royalnet.database.databaseconfig.DatabaseConfig] = None, command_prefix: str, commands: List[Type[royalnet.utils.command.Command]] = None, missing_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>, error_command: Type[royalnet.utils.command.Command] = <class 'royalnet.commands.null.NullCommand'>, loop: asyncio.events.AbstractEventLoop = None)¶A generic bot class, to be used as base for the other more specific classes, such as royalnet.bots.TelegramBot and royalnet.bots.DiscordBot.
+_call_factory() → Type[royalnet.utils.call.Call]¶Create the TelegramCall class, representing a command call. It should inherit from royalnet.utils.Call.
The created TelegramCall class.
+_init_commands(command_prefix: str, commands: List[Type[royalnet.utils.command.Command]], missing_command: Type[royalnet.utils.command.Command], error_command: Type[royalnet.utils.command.Command]) → None¶Generate the commands dictionary required to handle incoming messages, and the network_handlers dictionary required to handle incoming requests.
_init_database(commands: List[Type[royalnet.utils.command.Command]], database_config: royalnet.database.databaseconfig.DatabaseConfig)¶Create an royalnet.database.Alchemy with the tables required by the commands. Then, find the chain that links the master_table to the identity_table.
_init_royalnet(royalnet_config: royalnet.network.royalnetconfig.RoyalnetConfig)¶Create a royalnet.network.RoyalnetLink, and run it as a asyncio.Task.
_network_handler(request_dict: dict) → dict¶Handle a single dict received from the royalnet.network.RoyalnetLink.
Another dict, formatted as a royalnet.network.Response.
call(command_name: str, channel, parameters: List[str] = None, **kwargs)¶Call the command with the specified name.
+If it doesn’t exist, call self.missing_command.
If an exception is raised during the execution of the command, call self.error_command.
interface_name = NotImplemented¶run()¶A blocking coroutine that should make the bot start listening to commands and requests.
+Commands that can be used in bots.
+These probably won’t suit your needs, as they are tailored for the bots of the Royal Games gaming community, but they may be useful to develop new ones.
+royalnet.commands.NullCommand¶royalnet.commands.PingCommand¶royalnet.commands.ShipCommand¶royalnet.commands.SmecdsCommand¶royalnet.commands.CiaoruoziCommand¶royalnet.commands.ColorCommand¶royalnet.commands.SyncCommand¶royalnet.commands.DiarioCommand¶royalnet.commands.RageCommand¶royalnet.commands.DateparserCommand¶royalnet.commands.AuthorCommand¶royalnet.commands.ReminderCommand¶royalnet.commands.KvactiveCommand¶royalnet.commands.KvCommand¶royalnet.commands.KvrollCommand¶royalnet.commands.VideoinfoCommand¶royalnet.commands.SummonCommand¶royalnet.commands.PlayCommand¶royalnet.commands.SkipCommand¶royalnet.commands.PlaymodeCommand¶royalnet.commands.VideochannelCommand¶royalnet.commands.MissingCommand¶royalnet.commands.CvCommand¶royalnet.commands.PauseCommand¶royalnet.commands.QueueCommand¶royalnet.commands.RoyalnetprofileCommand¶Relational database classes and methods.
+royalnet.database.Alchemy(database_uri: str, tables: Set)¶A wrapper around SQLAlchemy declarative that allows to use multiple databases at once while maintaining a single table-class for both of them.
+__init__(database_uri: str, tables: Set)¶Create a new Alchemy object.
+database_uri – The uri of the database, as described at https://docs.sqlalchemy.org/en/13/core/engines.html .
tables – The set of tables to be created and used in the selected database. Check the tables submodule for more details.
_create_tables(tables: Set)¶session_acm()¶Use Alchemy as a asyncronous context manager (to be used in async with statements).
+session_cm()¶Use Alchemy as a context manager (to be used in with statements).
+royalnet.database.relationshiplinkchain(starting_class, ending_class) → Optional[tuple]¶Find the path to follow to get from the starting table to the ending table.
+royalnet.database.DatabaseConfig(database_uri: str, master_table: Type, identity_table: Type, identity_column_name: str)¶The configuration to be used for the royalnet.database.Alchemy component of royalnet.bots.GenericBot.
+royalnet.database.tables.Royal¶avatar = Column(None, LargeBinary(), table=None)¶password = Column(None, LargeBinary(), table=None)¶role = Column(None, String(), table=None, nullable=False)¶uid = Column(None, Integer(), table=None, primary_key=True, nullable=False)¶username = Column(None, String(), table=None, nullable=False)¶royalnet.database.tables.Telegram¶first_name = Column(None, String(), table=None)¶last_name = Column(None, String(), table=None)¶mention() → str¶royal = <RelationshipProperty at 0x7fafa024a8c8; no key>¶royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)¶tg_id = Column(None, BigInteger(), table=None, primary_key=True, nullable=False)¶username = Column(None, String(), table=None)¶royalnet.database.tables.Diario¶context = Column(None, Text(), table=None)¶creator = <RelationshipProperty at 0x7fafa01e6448; no key>¶creator_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)¶diario_id = Column(None, Integer(), table=None, primary_key=True, nullable=False)¶media_url = Column(None, String(), table=None)¶quoted = Column(None, String(), table=None)¶quoted_account = <RelationshipProperty at 0x7fafa01e6648; no key>¶quoted_account_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)¶spoiler = Column(None, Boolean(), table=None, default=ColumnDefault(False))¶text = Column(None, Text(), table=None)¶timestamp = Column(None, DateTime(), table=None, nullable=False)¶royalnet.database.tables.Alias¶alias = Column(None, String(), table=None, primary_key=True, nullable=False)¶royal = <RelationshipProperty at 0x7fafa01e6bc8; no key>¶royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)¶royalnet.database.tables.ActiveKvGroup¶group = <RelationshipProperty at 0x7fafa024ad48; no key>¶group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, nullable=False)¶royal = <RelationshipProperty at 0x7fafa01e64c8; no key>¶royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None, primary_key=True, nullable=False)¶royalnet.database.tables.Keyvalue¶group = <RelationshipProperty at 0x7fafa024acc8; no key>¶group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, primary_key=True, nullable=False)¶key = Column(None, String(), table=None, primary_key=True, nullable=False)¶value = Column(None, String(), table=None, nullable=False)¶royalnet.database.tables.Keygroup¶group_name = Column(None, String(), ForeignKey('keygroups.group_name'), table=None, primary_key=True, nullable=False)¶royalnet.database.tables.Discord¶avatar_hash = Column(None, String(), table=None)¶discord_id = Column(None, BigInteger(), table=None, primary_key=True, nullable=False)¶discriminator = Column(None, String(), table=None)¶full_username()¶royal = <RelationshipProperty at 0x7fafa024abc8; no key>¶royal_id = Column(None, Integer(), ForeignKey('royals.uid'), table=None)¶username = Column(None, String(), table=None)¶royalnet.database.tables.WikiPage¶Wiki page properties.
+Warning
+Requires PostgreSQL!
+content = Column(None, Text(), table=None)¶css = Column(None, String(), table=None)¶format = Column(None, String(), table=None, nullable=False, default=ColumnDefault('markdown'))¶page_id = Column(None, UUID(as_uuid=True), table=None, primary_key=True, nullable=False)¶title = Column(None, String(), table=None, nullable=False)¶royalnet.database.tables.WikiRevision¶A wiki page revision.
+Warning
+Requires PostgreSQL!
+diff = Column(None, Text(), table=None)¶page = <RelationshipProperty at 0x7fafa01e6448; no key>¶page_id = Column(None, UUID(as_uuid=True), ForeignKey('wikipages.page_id'), table=None, nullable=False)¶reason = Column(None, Text(), table=None)¶revision_id = Column(None, UUID(as_uuid=True), table=None, primary_key=True, nullable=False)¶timestamp = Column(None, DateTime(), table=None, nullable=False)¶royalnet.error.CurrentlyDisabledError¶This feature is temporarely disabled and is not available right now.
+royalnet.error.ExternalError¶Something went wrong in a non-Royalnet component and the command execution cannot be completed.
+royalnet.error.FileTooBigError¶The file to be downloaded would be too big to store; therefore, it has been skipped.
+royalnet.error.InvalidConfigError¶The bot has not been configured correctly, therefore the command can not function.
+royalnet.error.InvalidInputError¶The command has received invalid input and cannot complete.
+royalnet.error.NoneFoundError¶The element that was being looked for was not found.
+royalnet.error.RoyalnetRequestError(error: ResponseError)¶An error was raised while handling the Royalnet request.
+This exception contains the royalnet.network.ResponseError that was returned by the other Link.
royalnet.error.RoyalnetResponseError¶The royalnet.network.Response that was received is invalid.
royalnet.error.TooManyFoundError¶Multiple elements matching the request were found, and only one was expected.
+royalnet.error.UnregisteredError¶The command required a registered user, and the user was not registered.
+royalnet.error.UnsupportedError¶The command is not supported for the specified interface.
+| + |
|
+
| + | + |
| + | + |
| + |
| + | + |
| + | + |
| + | + |
| + | + |
| + |
| + | + |
| + | + |
| + | + |
| + | + |
| + | + |
Royalnet (websocket) related classes.
+royalnet.network.RoyalnetLink(master_uri: str, secret: str, link_type: str, request_handler, *, loop: asyncio.events.AbstractEventLoop = None)¶connect()¶Connect to the royalnet.network.RoyalnetServer at self.master_uri.
identify() → None¶receive() → royalnet.network.package.Package¶Recieve a Package from the royalnet.network.RoyalnetServer.
royalnet.network.royalnetlink.ConnectionClosedError –
+request(message, destination)¶run(loops: numbers.Real = inf)¶Blockingly run the Link.
+send(package: royalnet.network.package.Package)¶royalnet.network.NetworkError(error_data: dict, *args)¶royalnet.network.NotConnectedError¶The royalnet.network.RoyalnetLink is not connected to a royalnet.network.RoyalnetServer.
royalnet.network.NotIdentifiedError¶The royalnet.network.RoyalnetLink has not identified yet to a royalnet.network.RoyalnetServer.
royalnet.network.Package(data: dict, *, source: str, destination: str, source_conv_id: Optional[str] = None, destination_conv_id: Optional[str] = None)¶A Royalnet package, the data type with which a royalnet.network.RoyalnetLink communicates with a royalnet.network.RoyalnetServer or another link.
+Contains info about the source and the destination.
__init__(data: dict, *, source: str, destination: str, source_conv_id: Optional[str] = None, destination_conv_id: Optional[str] = None)¶Create a Package.
+data – The data that should be sent. Usually a royalnet.network.Message.
source – The nid of the node that created this Package.
destination – The link_type of the destination node, or alternatively, the nid of the node. Can also be the NULL value to send the message to nobody.
source_conv_id – The conversation id of the node that created this package. Akin to the sequence number on IP packets.
destination_conv_id – The conversation id of the node that this Package is a reply to.
from_dict(d) → royalnet.network.package.Package¶Create a Package from a dictionary.
+from_json_bytes(b: bytes) → royalnet.network.package.Package¶Create a Package from UTF8-encoded JSON bytes.
+from_json_string(string: str) → royalnet.network.package.Package¶Create a Package from a JSON string.
+reply(data) → royalnet.network.package.Package¶Reply to this Package with another Package.
+data – The data that should be sent. Usually a royalnet.network.Message.
The reply Package.
+to_dict() → dict¶Convert the Package into a dictionary.
+to_json_bytes() → bytes¶Convert the Package into UTF8-encoded JSON bytes.
+to_json_string() → str¶Convert the Package into a JSON string.
+royalnet.network.RoyalnetServer(address: str, port: int, required_secret: str, *, loop: asyncio.events.AbstractEventLoop = None)¶find_client(*, nid: str = None, link_type: str = None) → List[royalnet.network.royalnetserver.ConnectedClient]¶find_destination(package: royalnet.network.package.Package) → List[royalnet.network.royalnetserver.ConnectedClient]¶Find a list of destinations for the package.
+package – The package to find the destination of.
+A list of ConnectedClients to send the package to.
listener(websocket: websockets.server.WebSocketServerProtocol, path)¶route_package(package: royalnet.network.package.Package) → None¶Executed every time a package is received and must be routed somewhere.
+serve()¶start()¶royalnet.network.RoyalnetConfig(master_uri: str, master_secret: str)¶royalnet.network.ConnectionClosedError¶The royalnet.network.RoyalnetLink’s connection was closed unexpectedly. The link can’t be used anymore.
royalnet.network.Request(handler: str, data: dict)¶A request sent from a royalnet.network.RoyalnetLink to another.
It contains the name of the requested handler, in addition to the data.
+from_dict(d: dict)¶to_dict()¶royalnet.network.Response¶A base class to be inherited by all other response types.
+ + + + + + +royalnet.network.ResponseSuccess(data: Optional[dict] = None)¶A response to a successful royalnet.network.Request.
royalnet.network.ResponseError(name: str, description: str, extra_info: Optional[dict] = None)¶A response to a invalid royalnet.network.Request.
| + r | ||
| + |
+ royalnet | + |
| + |
+ royalnet.audio | + |
| + |
+ royalnet.bots | + |
| + |
+ royalnet.commands | + |
| + |
+ royalnet.database | + |
| + |
+ royalnet.database.tables | + |
| + |
+ royalnet.error | + |
| + |
+ royalnet.network | + |
| + |
+ royalnet.utils | + |
| + |
+ royalnet.web | + |
| + |
+ royalnet.web.royalprints | + |
Miscellaneous useful functions and classes.
+
royalnet.utils.asyncify(function: Callable, *args, **kwargs)¶Convert a function into a coroutine.
+Warning
+The coroutine cannot be cancelled, and any attempts to do so will result in unexpected outputs.
+royalnet.utils.Call(channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs)¶A command call. An abstract class, sub-bots should create a new call class from this.
+interface_name¶The name of the interface that is calling the command. For example, telegram, or discord.
interface_obj¶The main object of the interface that is calling the command. For example, the royalnet.bots.TelegramBot object.
interface_prefix¶The command prefix used by the interface. For example, /, or !.
alchemy¶The royalnet.database.Alchemy object associated to this interface. May be None if the interface is not connected to any database.
__init__(channel, command: Type[royalnet.utils.command.Command], command_args: List[str] = None, loop: asyncio.events.AbstractEventLoop = None, **kwargs)¶Create the call.
+channel – The channel object this call was sent in.
command – The command to be called.
command_args – The arguments to be passed to the command
kwargs – Additional optional keyword arguments that may be passed to the command, possibly specific to the bot.
_session_init()¶If the command requires database access, create a royalnet.database.Alchemy session for this call, otherwise, do nothing.
alchemy = NotImplementedTry to find the universal identifier of the user that sent the message. +That probably means, the database row identifying the user.
+error_if_none – Raise a royalnet.error.UnregisteredError if this is True and the call has no author.
interface_name = NotImplementedinterface_obj = NotImplementedinterface_prefix = NotImplementednet_request(message, destination: str) → dict¶Send data through a royalnet.network.RoyalnetLink and wait for a royalnet.network.Reply.
message – The data to be sent. Must be pickle-able.
destination – The destination of the request, either in UUID format or node name.
reply(text: str) → None¶Send a text message to the channel where the call was made.
+text – The text to be sent, possibly formatted in the weird undescribed markup that I’m using.
+run()¶Execute the called command, and return the command result.
+session_end()¶Close the previously created royalnet.database.Alchemy session for this call (if it was created).
royalnet.utils.Command¶The base class from which all commands should inherit.
+command_name¶The name of the command. To have /example on Telegram, the name should be example.
command_description¶A small description of the command, to be displayed when the command is being autocompleted.
+command_syntax¶The syntax of the command, to be displayed when a royalnet.error.InvalidInputError is raised, in the format (required_arg) [optional_arg].
require_alchemy_tables¶A set of royalnet.database tables, that must exist for this command to work.
network_handlers¶A list of :py:class:`royalnet.utils.NetworkHandler`s that must exist for this command to work.
+command_description = NotImplementedcommand_name = NotImplementedcommand_syntax = NotImplementedcommon(call: Call)¶network_handler_dict()¶network_handlers = {}require_alchemy_tables = {}royalnet.utils.safeformat(string: str, **words) → str¶str.format() something, but ignore missing keys instead of raising an error.
string – The base string to be formatted.
words – The words to format the string with.
The formatted string.
+royalnet.utils.cdj(class_: Any) → dict¶Return a dict of the class attributes without the __module__, __dict__, __weakref__ and __doc__ keys, to be used while generating dynamically SQLAlchemy declarative table classes.
class_ – The object that you want to dict-ify.
+The class dict.
+Warning
+You can’t dict-ify classes with __slots__!
royalnet.utils.sleep_until(dt: datetime.datetime) → None¶Block the call until the specified datetime.
+Warning
+Accurate only to seconds.
+royalnet.utils.plusformat(i: int) → str¶Convert an int to a str, prepending a + if it’s greater than 0.
royalnet.utils.CommandArgs¶An interface to access the arguments of a command with ease.
+__getitem__(item)¶Arguments can be accessed with an array notation, such as args[0].
royalnet.error.InvalidInputError – if the requested argument does not exist.
+joined(*, require_at_least=0) → str¶Get the arguments as a space-joined string.
+require_at_least – the minimum amount of arguments required, will raise royalnet.error.InvalidInputError if the requirement is not fullfilled.
royalnet.error.InvalidInputError – if there are less than require_at_least arguments.
The space-joined string.
+match(pattern: Pattern) → Sequence[AnyStr]¶Match the royalnet.utils.commandargs.joined() to a regex pattern.
pattern – The regex pattern to be passed to re.match().
royalnet.error.InvalidInputError – if the pattern doesn’t match.
+The matched groups, as returned by re.Match.groups().
optional(index: int, default=None)¶Get the argument at a specific index, but don’t raise an error if nothing is found, instead returning the default value.
index – The index of the argument you want to retrieve.
default – The value returned if the argument is missing.
Either the argument or the default value, defaulting to None.
royalnet.utils.NetworkHandler¶The NetworkHandler functions are called when a specific Message type is received.
+message_type = NotImplemented¶royalnet.utils.andformat(l: List[str], middle=', ', final=' and ') → str¶Convert a list to a str by adding final between the last two elements and middle between the others.
royalnet.utils.plusformat(i: int) → strConvert an int to a str, prepending a + if it’s greater than 0.
royalnet.utils.fileformat(string: str) → str¶Ensure a string can be used as a filename by replacing all non-word characters with underscores.
+string – the input string.
+A valid filename string.
+royalnet.utils.ytdldateformat(string: Optional[str], separator: str = '-') → str¶Convert the weird date string returned by youtube-dl into the YYYY-MM-DD format.
string – the input string, in the YYYYMMDD format.
separator – the string to add between the years, the months and the days. Defaults to -.
The resulting string, in the format YYYY-MM-DD format.
royalnet.utils.numberemojiformat(l: List[str]) → str¶royalnet.utils.telegram_escape(string: str) → str¶Escape a string to be sent through Telegram, and format it using RoyalCode.
+Warning
+Currently escapes everything, even items in code blocks.
+royalnet.utils.discord_escape(string: str) → str¶Escape a string to be sent through Discord, and format it using RoyalCode.
+Warning
+Currently escapes everything, even items in code blocks.
+royalnet.web.create_app(config_obj: Type, blueprints: List[royalnet.web.royalprint.Royalprint])¶Create a flask.Flask application object.
Gets the app.secret_key from the SECRET_KEY envvar.
Also requires a DB_PATH key in config_obj to initialize the database connection.
Warning
+The code for this class was written at 1 AM, and I have no clue of how and why it works or even of if it really does work. +Use with caution?
+config_obj – The object to be passed to flask.Flask.config.from_object().
blueprints – A list of blueprints to be registered to the application.
The created flask.Flask.
royalnet.web.Royalprint(name, import_name, static_folder=None, static_url_path=None, template_folder=None, url_prefix=None, subdomain=None, url_defaults=None, root_path=None, required_tables: Optional[set] = None)¶An edited flask.Blueprint containing an additional required_tables parameter.
Some Royalprints that can be used with the Royalnet Flask server.