Merge branch '2022.12' into #141
This commit is contained in:
commit
df81bb599f
@ -25,7 +25,11 @@
|
|||||||
"spu": "cpl set-pip-urls",
|
"spu": "cpl set-pip-urls",
|
||||||
"set-pip-urls": "cpl run set-pip-urls $ARGS; echo '';",
|
"set-pip-urls": "cpl run set-pip-urls $ARGS; echo '';",
|
||||||
|
|
||||||
"docs-build": "echo 'Build Documentation'; cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; sphinx-apidoc -o source/ ../src/cpl_query; make clean; make html; rm source/cpl_query.tests.rst;",
|
"docs-build": "echo 'Build Documentation'; cpl db-core; cpl db-discord; cpl db-query; cpl db-translation; cd docs/; make clean; make html; # rm source/cpl_query.tests.rst;",
|
||||||
|
"db-core": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_core; cd ../",
|
||||||
|
"db-discord": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_discord; cd ../",
|
||||||
|
"db-query": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_query; cd ../",
|
||||||
|
"db-translation": "cd docs/; sphinx-apidoc -o source/ ../src/cpl_translation; cd ../",
|
||||||
"db": "cpl docs-build",
|
"db": "cpl docs-build",
|
||||||
|
|
||||||
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
"docs-open": "xdg-open $PWD/docs/build/html/index.html &",
|
||||||
|
BIN
docs/build/doctrees/cli.generate.doctree
vendored
BIN
docs/build/doctrees/cli.generate.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.new.doctree
vendored
BIN
docs/build/doctrees/cli.new.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cli.run.doctree
vendored
Normal file
BIN
docs/build/doctrees/cli.run.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cli.start.doctree
vendored
BIN
docs/build/doctrees/cli.start.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/contributing.doctree
vendored
BIN
docs/build/doctrees/contributing.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
BIN
docs/build/doctrees/cpl_cli.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
BIN
docs/build/doctrees/cpl_core.application.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
BIN
docs/build/doctrees/cpl_core.database.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.doctree
vendored
BIN
docs/build/doctrees/cpl_core.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
BIN
docs/build/doctrees/cpl_core.pipes.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.application.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.command.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.configuration.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.configuration.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.container.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.events.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.helper.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_discord.service.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.base.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.doctree
vendored
BIN
docs/build/doctrees/cpl_query.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.enumerable.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
BIN
docs/build/doctrees/cpl_query.exceptions.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
BIN
docs/build/doctrees/cpl_query.extension.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_query.iterable.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Normal file
BIN
docs/build/doctrees/cpl_translation.doctree
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/environment.pickle
vendored
BIN
docs/build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
BIN
docs/build/doctrees/index.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/modules.doctree
vendored
BIN
docs/build/doctrees/modules.doctree
vendored
Binary file not shown.
BIN
docs/build/doctrees/setup.doctree
vendored
BIN
docs/build/doctrees/setup.doctree
vendored
Binary file not shown.
2
docs/build/html/.buildinfo
vendored
2
docs/build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
|||||||
# Sphinx build info version 1
|
# Sphinx build info version 1
|
||||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
config: 9ea51a00cf3559575c97b7efd7a002e5
|
config: 7051b788adc6d655ae340e56640c6925
|
||||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
|
3
docs/build/html/_sources/cli.generate.md.txt
vendored
3
docs/build/html/_sources/cli.generate.md.txt
vendored
@ -19,9 +19,10 @@ Generates files based on a schematic.
|
|||||||
## Arguments
|
## Arguments
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
| ----------------- |:---------------------------------:|:-------------:|
|
|-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------:|
|
||||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||||
| ```<name>``` | The name of the generated file. | ```str``` |
|
| ```<name>``` | The name of the generated file. | ```str``` |
|
||||||
|
| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` |
|
||||||
|
|
||||||
## Schematics
|
## Schematics
|
||||||
|
|
||||||
|
3
docs/build/html/_sources/cli.new.md.txt
vendored
3
docs/build/html/_sources/cli.new.md.txt
vendored
@ -19,9 +19,10 @@ Generates a workspace and initial project or add a project to workspace.
|
|||||||
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
If the command is running in a CPL workspace, it will add the new project to the workspace.
|
||||||
|
|
||||||
| Argument | Description | Value type |
|
| Argument | Description | Value type |
|
||||||
|--------------|:----------------------------------------------------:|:----------:|
|
|--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------:|
|
||||||
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
| ```<type>``` | The type of the project, see [types](#project-types) | ```str``` |
|
||||||
| ```<name>``` | The name of the project | ```str``` |
|
| ```<name>``` | The name of the project | ```str``` |
|
||||||
|
| ```--base``` | First element of path will be used as base-path not 'src'. For example: 'cpl g c test/Test' will be created at ```src/test/``` with --base it would be ```test/``` | ```str``` |
|
||||||
|
|
||||||
## Project types
|
## Project types
|
||||||
|
|
||||||
|
12
docs/build/html/_sources/cli.run.md.txt
vendored
Normal file
12
docs/build/html/_sources/cli.run.md.txt
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# cpl run
|
||||||
|
|
||||||
|
Starts your application once.
|
||||||
|
|
||||||
|
cpl **run** <br>
|
||||||
|
cpl **r** <br>
|
||||||
|
cpl **R**
|
||||||
|
|
||||||
|
| Argument | Description | Value type |
|
||||||
|
|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
|
||||||
|
| ```<project>``` | Optional parameter to specify which project to start, if not set default project will be started. | ```str``` |
|
||||||
|
| ```--dev``` | To run the project from source and not from dist after build. | ```str``` |
|
4
docs/build/html/_sources/cli.start.md.txt
vendored
4
docs/build/html/_sources/cli.start.md.txt
vendored
@ -5,3 +5,7 @@ Starts your application, restarting on file changes.
|
|||||||
cpl **start** <br>
|
cpl **start** <br>
|
||||||
cpl **s** <br>
|
cpl **s** <br>
|
||||||
cpl **S**
|
cpl **S**
|
||||||
|
|
||||||
|
| Argument | Description | Value type |
|
||||||
|
|-----------------|:----------------------------------------------------------------------------------------------------:|:----------:|
|
||||||
|
| ```--dev``` | To run the project from source and not from dist after build. | ```str``` |
|
6
docs/build/html/_sources/contributing.md.txt
vendored
6
docs/build/html/_sources/contributing.md.txt
vendored
@ -44,7 +44,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
|
|||||||
|
|
||||||
2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
|
2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
|
||||||
|
|
||||||
3. Fork the sh-edraft.de/sh_cpl repo.
|
3. Fork the sh-edraft.de/cpl repo.
|
||||||
|
|
||||||
4. In your forked repository, make your changes in a new git branch:
|
4. In your forked repository, make your changes in a new git branch:
|
||||||
|
|
||||||
@ -70,7 +70,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
|
|||||||
git push origin my-fix-branch
|
git push origin my-fix-branch
|
||||||
```
|
```
|
||||||
|
|
||||||
8. In Gitea, send a pull request to sh_cpl:master
|
8. In Gitea, send a pull request to cpl:master
|
||||||
|
|
||||||
### Reviewing a Pull Request
|
### Reviewing a Pull Request
|
||||||
|
|
||||||
@ -104,7 +104,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
By contributing, you agree that your contributions will be licensed under its MIT License.
|
By contributing, you agree that your contributions will be licensed under its MIT License.
|
||||||
See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE)
|
See [LICENSE](https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE)
|
||||||
|
|
||||||
<!-- LINKS -->
|
<!-- LINKS -->
|
||||||
[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
|
[gitea-repo]: https://git.sh-edraft.de/sh-edraft.de/sh_cpl/
|
||||||
|
2
docs/build/html/_sources/cpl_cli.rst.txt
vendored
2
docs/build/html/_sources/cpl_cli.rst.txt
vendored
@ -1,4 +1,4 @@
|
|||||||
CLI Reference
|
CLI reference
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -7,8 +7,7 @@ cpl_core.database
|
|||||||
cpl_core.database.connection
|
cpl_core.database.connection
|
||||||
cpl_core.database.context
|
cpl_core.database.context
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
cpl_core.database.database\_model
|
cpl_core.database.database\_model
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
27
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
27
docs/build/html/_sources/cpl_core.pipes.rst.txt
vendored
@ -1,10 +1,9 @@
|
|||||||
cpl\_core.pipes
|
cpl\_core.pipes
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Submodules
|
|
||||||
----------
|
|
||||||
|
|
||||||
cpl\_core.pipes.bool\_pipe module
|
|
||||||
|
cpl\_core.pipes.bool\_pipe
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.bool_pipe
|
.. automodule:: cpl_core.pipes.bool_pipe
|
||||||
@ -12,7 +11,7 @@ cpl\_core.pipes.bool\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
cpl\_core.pipes.first\_char\_to\_lower\_pipe
|
||||||
---------------------------------------------------
|
---------------------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
.. automodule:: cpl_core.pipes.first_char_to_lower_pipe
|
||||||
@ -20,7 +19,7 @@ cpl\_core.pipes.first\_char\_to\_lower\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.first\_to\_upper\_pipe module
|
cpl\_core.pipes.first\_to\_upper\_pipe
|
||||||
---------------------------------------------
|
---------------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
.. automodule:: cpl_core.pipes.first_to_upper_pipe
|
||||||
@ -28,7 +27,7 @@ cpl\_core.pipes.first\_to\_upper\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.ip\_address\_pipe module
|
cpl\_core.pipes.ip\_address\_pipe
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.ip_address_pipe
|
.. automodule:: cpl_core.pipes.ip_address_pipe
|
||||||
@ -36,7 +35,7 @@ cpl\_core.pipes.ip\_address\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.pipe\_abc module
|
cpl\_core.pipes.pipe\_abc
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.pipe_abc
|
.. automodule:: cpl_core.pipes.pipe_abc
|
||||||
@ -44,7 +43,7 @@ cpl\_core.pipes.pipe\_abc module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.to\_camel\_case\_pipe module
|
cpl\_core.pipes.to\_camel\_case\_pipe
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
.. automodule:: cpl_core.pipes.to_camel_case_pipe
|
||||||
@ -52,7 +51,7 @@ cpl\_core.pipes.to\_camel\_case\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.to\_snake\_case\_pipe module
|
cpl\_core.pipes.to\_snake\_case\_pipe
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
.. automodule:: cpl_core.pipes.to_snake_case_pipe
|
||||||
@ -60,18 +59,10 @@ cpl\_core.pipes.to\_snake\_case\_pipe module
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl\_core.pipes.version\_pipe module
|
cpl\_core.pipes.version\_pipe
|
||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes.version_pipe
|
.. automodule:: cpl_core.pipes.version_pipe
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Module contents
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_core.pipes
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
2
docs/build/html/_sources/cpl_core.rst.txt
vendored
2
docs/build/html/_sources/cpl_core.rst.txt
vendored
@ -1,4 +1,4 @@
|
|||||||
API Reference
|
API reference
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
12
docs/build/html/_sources/cpl_discord.application.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.application.rst.txt
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
cpl\_discord.application
|
||||||
|
================================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.application.discord\_bot\_application\_abc
|
||||||
|
--------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.application.discord_bot_application_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
20
docs/build/html/_sources/cpl_discord.command.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_discord.command.rst.txt
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
cpl\_discord.command
|
||||||
|
============================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.command.discord\_command\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.command.discord_command_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.command.discord\_commands\_meta
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.command.discord_commands_meta
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
12
docs/build/html/_sources/cpl_discord.configuration.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.configuration.rst.txt
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
cpl\_discord.configuration
|
||||||
|
==================================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.configuration.discord\_bot\_settings
|
||||||
|
--------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.configuration.discord_bot_settings
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
68
docs/build/html/_sources/cpl_discord.container.rst.txt
vendored
Normal file
68
docs/build/html/_sources/cpl_discord.container.rst.txt
vendored
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
cpl\_discord.container
|
||||||
|
==============================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.container.category\_channel
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.category_channel
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.container
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.container
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.guild
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.guild
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.member
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.member
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.role
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.role
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.text\_channel
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.text_channel
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.thread
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.thread
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.container.voice\_channel
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.container.voice_channel
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
412
docs/build/html/_sources/cpl_discord.events.rst.txt
vendored
Normal file
412
docs/build/html/_sources/cpl_discord.events.rst.txt
vendored
Normal file
@ -0,0 +1,412 @@
|
|||||||
|
cpl\_discord.events
|
||||||
|
===========================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_bulk\_message\_delete\_abc
|
||||||
|
---------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_bulk_message_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_command\_abc
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_command_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_command\_completion\_abc
|
||||||
|
-------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_command_completion_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_command\_error\_abc
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_command_error_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_connect\_abc
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_connect_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_disconnect\_abc
|
||||||
|
----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_disconnect_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_error\_abc
|
||||||
|
-----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_error_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_group\_join\_abc
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_group_join_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_group\_remove\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_group_remove_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_available\_abc
|
||||||
|
----------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_available_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_channel\_create\_abc
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_channel_create_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_channel\_delete\_abc
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_channel_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_channel\_pins\_update\_abc
|
||||||
|
----------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_channel_pins_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_channel\_update\_abc
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_channel_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_emojis\_update\_abc
|
||||||
|
---------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_emojis_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_integrations\_update\_abc
|
||||||
|
---------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_integrations_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_join\_abc
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_join_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_remove\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_remove_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_role\_create\_abc
|
||||||
|
-------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_role_create_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_role\_delete\_abc
|
||||||
|
-------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_role_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_role\_update\_abc
|
||||||
|
-------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_role_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_unavailable\_abc
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_unavailable_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_guild\_update\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_guild_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_invite\_create\_abc
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_invite_create_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_invite\_delete\_abc
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_invite_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_member\_ban\_abc
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_member_ban_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_member\_join\_abc
|
||||||
|
------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_member_join_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_member\_remove\_abc
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_member_remove_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_member\_unban\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_member_unban_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_member\_update\_abc
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_member_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_message\_abc
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_message_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_message\_delete\_abc
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_message_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_message\_edit\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_message_edit_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_private\_channel\_create\_abc
|
||||||
|
------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_private_channel_create_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_private\_channel\_delete\_abc
|
||||||
|
------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_private_channel_delete_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_private\_channel\_pins\_update\_abc
|
||||||
|
------------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_private_channel_pins_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_private\_channel\_update\_abc
|
||||||
|
------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_private_channel_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_raw\_reaction\_add\_abc
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_raw_reaction_add_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_raw\_reaction\_clear\_abc
|
||||||
|
--------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_raw_reaction_clear_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_raw\_reaction\_clear\_emoji\_abc
|
||||||
|
---------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_raw_reaction_clear_emoji_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_raw\_reaction\_remove\_abc
|
||||||
|
---------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_raw_reaction_remove_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_reaction\_add\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_reaction_add_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_reaction\_clear\_abc
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_reaction_clear_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_reaction\_clear\_emoji\_abc
|
||||||
|
----------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_reaction_clear_emoji_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_reaction\_remove\_abc
|
||||||
|
----------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_reaction_remove_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_ready\_abc
|
||||||
|
-----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_ready_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_resume\_abc
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_resume_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_typing\_abc
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_typing_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_user\_update\_abc
|
||||||
|
------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_user_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_voice\_state\_update\_abc
|
||||||
|
--------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_voice_state_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.events.on\_webhooks\_update\_abc
|
||||||
|
----------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.events.on_webhooks_update_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
12
docs/build/html/_sources/cpl_discord.helper.rst.txt
vendored
Normal file
12
docs/build/html/_sources/cpl_discord.helper.rst.txt
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
cpl\_discord.helper
|
||||||
|
===========================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.helper.to\_containers\_converter
|
||||||
|
----------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.helper.to_containers_converter
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
13
docs/build/html/_sources/cpl_discord.rst.txt
vendored
Normal file
13
docs/build/html/_sources/cpl_discord.rst.txt
vendored
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
Discord reference
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
cpl_discord.application
|
||||||
|
cpl_discord.command
|
||||||
|
cpl_discord.configuration
|
||||||
|
cpl_discord.container
|
||||||
|
cpl_discord.events
|
||||||
|
cpl_discord.helper
|
||||||
|
cpl_discord.service
|
60
docs/build/html/_sources/cpl_discord.service.rst.txt
vendored
Normal file
60
docs/build/html/_sources/cpl_discord.service.rst.txt
vendored
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
cpl\_discord.service
|
||||||
|
============================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_discord.service.command\_error\_handler\_service
|
||||||
|
------------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.command_error_handler_service
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_bot\_service
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_bot_service
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_bot\_service\_abc
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_bot_service_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_collection
|
||||||
|
-----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_collection
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_collection\_abc
|
||||||
|
----------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_collection_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_service
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_service
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_discord.service.discord\_service\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_discord.service.discord_service_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
52
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
Normal file
52
docs/build/html/_sources/cpl_query.base.rst.txt
vendored
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
cpl\_query.base
|
||||||
|
=======================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_query.base.default\_lambda
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.default_lambda
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.base.ordered\_queryable
|
||||||
|
-----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.ordered_queryable
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.base.ordered\_queryable\_abc
|
||||||
|
----------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.ordered_queryable_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.base.queryable\_abc
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.queryable_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.base.sequence\_abc
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.sequence_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.base.sequence\_values
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.base.sequence_values
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
20
docs/build/html/_sources/cpl_query.enumerable.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_query.enumerable.rst.txt
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
cpl\_query.enumerable
|
||||||
|
=============================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_query.enumerable.enumerable
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.enumerable.enumerable
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.enumerable.enumerable\_abc
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.enumerable.enumerable_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
@ -1,10 +0,0 @@
|
|||||||
cpl_query.exceptions
|
|
||||||
=================================
|
|
||||||
|
|
||||||
cpl_query.exceptions
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.exceptions
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
@ -1,42 +1,12 @@
|
|||||||
cpl_query.extension
|
cpl\_query.extension
|
||||||
=================================
|
============================
|
||||||
|
|
||||||
cpl_query.extension.iterable_abc
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.iterable_abc
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl_query.extension.iterable
|
cpl\_query.extension.list
|
||||||
----------------------------------------------------
|
--------------------------------
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.iterable
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl_query.extension.list
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.list
|
.. automodule:: cpl_query.extension.list
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
cpl_query.extension.ordered_iterable_abc
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.ordered_iterable_abc
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
cpl_query.extension.ordered_iterable
|
|
||||||
----------------------------------------------------
|
|
||||||
|
|
||||||
.. automodule:: cpl_query.extension.ordered_iterable
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
20
docs/build/html/_sources/cpl_query.iterable.rst.txt
vendored
Normal file
20
docs/build/html/_sources/cpl_query.iterable.rst.txt
vendored
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
cpl\_query.iterable
|
||||||
|
===========================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
cpl\_query.iterable.iterable
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.iterable.iterable
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_query.iterable.iterable\_abc
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_query.iterable.iterable_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
6
docs/build/html/_sources/cpl_query.rst.txt
vendored
6
docs/build/html/_sources/cpl_query.rst.txt
vendored
@ -1,8 +1,10 @@
|
|||||||
Query Reference
|
Query reference
|
||||||
===========
|
===========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 4
|
:maxdepth: 4
|
||||||
|
|
||||||
|
cpl_query.base
|
||||||
|
cpl_query.enumerable
|
||||||
cpl_query.extension
|
cpl_query.extension
|
||||||
cpl_query.exceptions
|
cpl_query.iterable
|
||||||
|
34
docs/build/html/_sources/cpl_translation.rst.txt
vendored
Normal file
34
docs/build/html/_sources/cpl_translation.rst.txt
vendored
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
Translation reference
|
||||||
|
========================
|
||||||
|
|
||||||
|
cpl\_translation.translate\_pipe
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_translation.translate_pipe
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_translation.translation\_service
|
||||||
|
--------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_translation.translation_service
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_translation.translation\_service\_abc
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_translation.translation_service_abc
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
cpl\_translation.translation\_settings
|
||||||
|
---------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: cpl_translation.translation_settings
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
2
docs/build/html/_sources/index.rst.txt
vendored
2
docs/build/html/_sources/index.rst.txt
vendored
@ -89,4 +89,6 @@ These pages go into great detail about everything the Library can do.
|
|||||||
contributing
|
contributing
|
||||||
cpl_cli
|
cpl_cli
|
||||||
cpl_core
|
cpl_core
|
||||||
|
cpl_discord
|
||||||
cpl_query
|
cpl_query
|
||||||
|
cpl_translation
|
||||||
|
2
docs/build/html/_sources/modules.rst.txt
vendored
2
docs/build/html/_sources/modules.rst.txt
vendored
@ -9,4 +9,4 @@ cpl
|
|||||||
cpl_core
|
cpl_core
|
||||||
cpl_discord
|
cpl_discord
|
||||||
cpl_query
|
cpl_query
|
||||||
cpl_translate
|
cpl_translation
|
||||||
|
6
docs/build/html/_sources/setup.md.txt
vendored
6
docs/build/html/_sources/setup.md.txt
vendored
@ -27,7 +27,7 @@ Also you need to have the following installed.
|
|||||||
To install the package, open a terminal window and run the following command:
|
To install the package, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pip install sh_cpl-core --extra-index-url https://pip.sh-edraft.de
|
pip install cpl-core --extra-index-url https://pip.sh-edraft.de
|
||||||
```
|
```
|
||||||
|
|
||||||
## Install the CLI
|
## Install the CLI
|
||||||
@ -37,7 +37,7 @@ You use the CPL CLI to create projects, generate application and library code. Y
|
|||||||
To install the CLI, open a terminal window and run the following command:
|
To install the CLI, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
|
pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
|
||||||
```
|
```
|
||||||
|
|
||||||
## Install the query
|
## Install the query
|
||||||
@ -45,7 +45,7 @@ pip install sh_cpl-cli --extra-index-url https://pip.sh-edraft.de
|
|||||||
To install the package, open a terminal window and run the following command:
|
To install the package, open a terminal window and run the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
pip install sh_cpl-query --extra-index-url https://pip.sh-edraft.de
|
pip install cpl-query --extra-index-url https://pip.sh-edraft.de
|
||||||
```
|
```
|
||||||
|
|
||||||
## Create initial console app
|
## Create initial console app
|
||||||
|
12
docs/build/html/cli.add.html
vendored
12
docs/build/html/cli.add.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl add</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl add</li>
|
<li>cpl add</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.add.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -161,7 +163,7 @@ cpl <strong>A</strong> <em><source-project></em> <em><target-project>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.build.html
vendored
12
docs/build/html/cli.build.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl build</a><ul>
|
||||||
@ -62,8 +62,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl build</li>
|
<li>cpl build</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.build.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -128,7 +130,7 @@ cpl <strong>B</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.generate.html
vendored
16
docs/build/html/cli.generate.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl generate</li>
|
<li>cpl generate</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.generate.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -129,6 +131,10 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<td class="text-center"><p>The name of the generated file.</p></td>
|
<td class="text-center"><p>The name of the generated file.</p></td>
|
||||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--base</span></code></p></td>
|
||||||
|
<td class="text-center"><p>First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at <code class="docutils literal notranslate"><span class="pre">src/test/</span></code> with –base it would be <code class="docutils literal notranslate"><span class="pre">test/</span></code></p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</section>
|
</section>
|
||||||
@ -194,7 +200,7 @@ cpl <strong>G</strong> <em><schematic></em> <em><name></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.help.html
vendored
12
docs/build/html/cli.help.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -63,8 +63,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl help</li>
|
<li>cpl help</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -139,7 +141,7 @@ cpl <strong>H</strong> <em><command></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.install.html
vendored
12
docs/build/html/cli.install.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl install</li>
|
<li>cpl install</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.install.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -162,7 +164,7 @@ Without given package it will install the depedencies of the CPL project your in
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.new.html
vendored
16
docs/build/html/cli.new.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl new</li>
|
<li>cpl new</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.new.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -127,6 +129,10 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
|||||||
<td class="text-center"><p>The name of the project</p></td>
|
<td class="text-center"><p>The name of the project</p></td>
|
||||||
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--base</span></code></p></td>
|
||||||
|
<td class="text-center"><p>First element of path will be used as base-path not ‘src’. For example: ‘cpl g c test/Test’ will be created at <code class="docutils literal notranslate"><span class="pre">src/test/</span></code> with –base it would be <code class="docutils literal notranslate"><span class="pre">test/</span></code></p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</section>
|
</section>
|
||||||
@ -191,7 +197,7 @@ cpl <strong>N</strong> <em><type></em> <em><name></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.overview.html
vendored
16
docs/build/html/cli.overview.html
vendored
@ -20,7 +20,7 @@
|
|||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="cpl add" href="cli.add.html" />
|
<link rel="next" title="cpl add" href="cli.add.html" />
|
||||||
<link rel="prev" title="CLI Reference" href="cpl_cli.html" />
|
<link rel="prev" title="CLI reference" href="cpl_cli.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
|
||||||
@ -68,8 +68,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,7 +88,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>CLI Overview and Command Reference</li>
|
<li>CLI Overview and Command Reference</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.overview.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -202,14 +204,14 @@ cpl start
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.publish.html
vendored
12
docs/build/html/cli.publish.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -62,8 +62,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl publish</li>
|
<li>cpl publish</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.publish.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -128,7 +130,7 @@ The command executes the <code class="docutils literal notranslate"><span class=
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.remove.html
vendored
12
docs/build/html/cli.remove.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl remove</li>
|
<li>cpl remove</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.remove.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -156,7 +158,7 @@ cpl <strong>R</strong> <em><project></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
128
docs/build/html/cli.run.html
vendored
Normal file
128
docs/build/html/cli.run.html
vendored
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl run — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li>cpl run</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cli.run.md.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-run">
|
||||||
|
<h1>cpl run<a class="headerlink" href="#cpl-run" title="Permalink to this heading"></a></h1>
|
||||||
|
<p>Starts your application once.</p>
|
||||||
|
<p>cpl <strong>run</strong> <br>
|
||||||
|
cpl <strong>r</strong> <br>
|
||||||
|
cpl <strong>R</strong></p>
|
||||||
|
<table class="colwidths-auto docutils align-default">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||||
|
<th class="text-center head"><p>Description</p></th>
|
||||||
|
<th class="text-center head"><p>Value type</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><project></span></code></p></td>
|
||||||
|
<td class="text-center"><p>Optional parameter to specify which project to start, if not set default project will be started.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--dev</span></code></p></td>
|
||||||
|
<td class="text-center"><p>To run the project from source and not from dist after build.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
26
docs/build/html/cli.start.html
vendored
26
docs/build/html/cli.start.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl start</li>
|
<li>cpl start</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.start.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -93,6 +95,20 @@
|
|||||||
<p>cpl <strong>start</strong> <br>
|
<p>cpl <strong>start</strong> <br>
|
||||||
cpl <strong>s</strong> <br>
|
cpl <strong>s</strong> <br>
|
||||||
cpl <strong>S</strong></p>
|
cpl <strong>S</strong></p>
|
||||||
|
<table class="colwidths-auto docutils align-default">
|
||||||
|
<thead>
|
||||||
|
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
||||||
|
<th class="text-center head"><p>Description</p></th>
|
||||||
|
<th class="text-center head"><p>Value type</p></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--dev</span></code></p></td>
|
||||||
|
<td class="text-center"><p>To run the project from source and not from dist after build.</p></td>
|
||||||
|
<td class="text-center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
||||||
@ -106,7 +122,7 @@ cpl <strong>S</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.uninstall.html
vendored
12
docs/build/html/cli.uninstall.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -64,8 +64,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl uninstall</li>
|
<li>cpl uninstall</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.uninstall.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -161,7 +163,7 @@ cpl <strong>UI</strong> <em><package></em></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cli.update.html
vendored
12
docs/build/html/cli.update.html
vendored
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -61,8 +61,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -79,7 +81,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl update</li>
|
<li>cpl update</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.update.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -124,7 +126,7 @@ cpl <strong>U</strong></p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cli.version.html
vendored
16
docs/build/html/cli.version.html
vendored
@ -19,7 +19,7 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="API Reference" href="cpl_core.html" />
|
<link rel="next" title="API reference" href="cpl_core.html" />
|
||||||
<link rel="prev" title="cpl update" href="cli.update.html" />
|
<link rel="prev" title="cpl update" href="cli.update.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
<li><a href="cpl_cli.html">CLI reference</a> »</li>
|
||||||
<li>cpl version</li>
|
<li>cpl version</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cli.version.md.txt" rel="nofollow"> View page source</a>
|
||||||
@ -100,13 +102,13 @@ cpl <strong>V</strong></p>
|
|||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cli.update.html" class="btn btn-neutral float-left" title="cpl update" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_core.html" class="btn btn-neutral float-right" title="API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
20
docs/build/html/contributing.html
vendored
20
docs/build/html/contributing.html
vendored
@ -19,7 +19,7 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="CLI Reference" href="cpl_cli.html" />
|
<link rel="next" title="CLI reference" href="cpl_cli.html" />
|
||||||
<link rel="prev" title="Send mails" href="tutorials.mail.html" />
|
<link rel="prev" title="Send mails" href="tutorials.mail.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
@ -57,9 +57,11 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -123,7 +125,7 @@
|
|||||||
<ol class="arabic">
|
<ol class="arabic">
|
||||||
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
<li><p>Search the <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/">repository</a> for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.</p></li>
|
||||||
<li><p>Be sure that an issue describes the problem you’re fixing, or documents the design for the feature you’d like to add. Discussing the design upfront helps to ensure that we’re ready to accept your work.</p></li>
|
<li><p>Be sure that an issue describes the problem you’re fixing, or documents the design for the feature you’d like to add. Discussing the design upfront helps to ensure that we’re ready to accept your work.</p></li>
|
||||||
<li><p>Fork the sh-edraft.de/sh_cpl repo.</p></li>
|
<li><p>Fork the sh-edraft.de/cpl repo.</p></li>
|
||||||
<li><p>In your forked repository, make your changes in a new git branch:</p>
|
<li><p>In your forked repository, make your changes in a new git branch:</p>
|
||||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git checkout -b my-fix-branch master
|
||||||
</pre></div>
|
</pre></div>
|
||||||
@ -144,7 +146,7 @@
|
|||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><p>In Gitea, send a pull request to sh_cpl:master</p></li>
|
<li><p>In Gitea, send a pull request to cpl:master</p></li>
|
||||||
</ol>
|
</ol>
|
||||||
</section>
|
</section>
|
||||||
<section id="reviewing-a-pull-request">
|
<section id="reviewing-a-pull-request">
|
||||||
@ -178,7 +180,7 @@ git push
|
|||||||
<section id="license">
|
<section id="license">
|
||||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
||||||
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
<p>By contributing, you agree that your contributions will be licensed under its MIT License.
|
||||||
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh_cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/cpl/src/branch/master/LICENSE">LICENSE</a></p>
|
||||||
<!-- LINKS -->
|
<!-- LINKS -->
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
@ -188,13 +190,13 @@ See <a class="reference external" href="https://git.sh-edraft.de/sh-edraft.de/sh
|
|||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="tutorials.mail.html" class="btn btn-neutral float-left" title="Send mails" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="tutorials.mail.html" class="btn btn-neutral float-left" title="Send mails" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_cli.html" class="btn btn-neutral float-right" title="CLI reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cpl_cli.html
vendored
16
docs/build/html/cpl_cli.html
vendored
@ -4,7 +4,7 @@
|
|||||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>CLI Reference — Common Python Library documentation</title>
|
<title>CLI reference — Common Python Library documentation</title>
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<!--[if lt IE 9]>
|
<!--[if lt IE 9]>
|
||||||
@ -42,7 +42,7 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI Reference</a><ul>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">CLI reference</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
||||||
@ -58,8 +58,10 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -76,7 +78,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li>CLI Reference</li>
|
<li>CLI reference</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_cli.rst.txt" rel="nofollow"> View page source</a>
|
||||||
</li>
|
</li>
|
||||||
@ -87,7 +89,7 @@
|
|||||||
<div itemprop="articleBody">
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
<section id="cli-reference">
|
<section id="cli-reference">
|
||||||
<h1>CLI Reference<a class="headerlink" href="#cli-reference" title="Permalink to this heading"></a></h1>
|
<h1>CLI reference<a class="headerlink" href="#cli-reference" title="Permalink to this heading"></a></h1>
|
||||||
<div class="toctree-wrapper compound">
|
<div class="toctree-wrapper compound">
|
||||||
<ul>
|
<ul>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a><ul>
|
||||||
@ -180,7 +182,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
20
docs/build/html/cpl_core.application.html
vendored
20
docs/build/html/cpl_core.application.html
vendored
@ -20,7 +20,7 @@
|
|||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
|
<link rel="next" title="cpl_core.configuration" href="cpl_core.configuration.html" />
|
||||||
<link rel="prev" title="API Reference" href="cpl_core.html" />
|
<link rel="prev" title="API reference" href="cpl_core.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.application</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_abc">cpl_core.application.application_abc</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.application.application_builder">cpl_core.application.application_builder</a></li>
|
||||||
@ -63,7 +63,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -80,7 +82,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.application</li>
|
<li>cpl_core.application</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.application.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -172,12 +174,12 @@
|
|||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_extension">
|
||||||
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">ApplicationExtensionABC</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">StartupExtensionABC</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">use_extension</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">ApplicationExtensionABC</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">StartupExtensionABC</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_extension" title="Permalink to this definition"></a></dt>
|
||||||
<dd></dd></dl>
|
<dd></dd></dl>
|
||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
<dt class="sig sig-object py" id="cpl_core.application.application_builder.ApplicationBuilder.use_startup">
|
||||||
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">use_startup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">startup</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_core.application.startup_abc.StartupABC" title="cpl_core.application.startup_abc.StartupABC"><span class="pre">StartupABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_core.application.application_builder.ApplicationBuilder" title="cpl_core.application.application_builder.ApplicationBuilder"><span class="pre">ApplicationBuilder</span></a></span></span><a class="headerlink" href="#cpl_core.application.application_builder.ApplicationBuilder.use_startup" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Sets the custom startup class to use async</p>
|
<dd><p>Sets the custom startup class to use async</p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><dl class="simple">
|
<div><dl class="simple">
|
||||||
@ -272,14 +274,14 @@ env: <a class="reference internal" href="cpl_core.environment.html#module-cpl_co
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_core.html" class="btn btn-neutral float-left" title="API reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_core.configuration.html" class="btn btn-neutral float-right" title="cpl_core.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.configuration.html
vendored
12
docs/build/html/cpl_core.configuration.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.configuration</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.configuration.configuration">cpl_core.configuration.configuration</a></li>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.configuration</li>
|
<li>cpl_core.configuration</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -462,7 +464,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.console.html
vendored
12
docs/build/html/cpl_core.console.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.console</a><ul>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.console</li>
|
<li>cpl_core.console</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.console.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -588,7 +590,7 @@ errors defaults to ‘strict’.</p>
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -54,7 +54,6 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
||||||
@ -69,7 +68,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,7 +87,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
||||||
<li>cpl_core.database.connection</li>
|
<li>cpl_core.database.connection</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
@ -177,7 +178,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
13
docs/build/html/cpl_core.database.context.html
vendored
13
docs/build/html/cpl_core.database.context.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -54,7 +54,6 @@
|
|||||||
<li class="toctree-l4"><a class="reference internal" href="#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc</a></li>
|
<li class="toctree-l4"><a class="reference internal" href="#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
||||||
@ -69,7 +68,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -86,7 +87,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
<li><a href="cpl_core.database.html">cpl_core.database</a> »</li>
|
||||||
<li>cpl_core.database.context</li>
|
<li>cpl_core.database.context</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
@ -200,7 +201,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cpl_core.database.html
vendored
16
docs/build/html/cpl_core.database.html
vendored
@ -42,15 +42,14 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.database</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.database</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.connection.html">cpl_core.database.connection</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html">cpl_core.database.context</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
||||||
@ -65,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.database</li>
|
<li>cpl_core.database</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.database.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -109,9 +110,6 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<section id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
|
||||||
</section>
|
|
||||||
<section id="cpl-core-database-database-model">
|
<section id="cpl-core-database-database-model">
|
||||||
<h2>cpl_core.database.database_model<a class="headerlink" href="#cpl-core-database-database-model" title="Permalink to this heading"></a></h2>
|
<h2>cpl_core.database.database_model<a class="headerlink" href="#cpl-core-database-database-model" title="Permalink to this heading"></a></h2>
|
||||||
</section>
|
</section>
|
||||||
@ -245,7 +243,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -65,7 +65,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -82,7 +84,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.dependency_injection</li>
|
<li>cpl_core.dependency_injection</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.dependency_injection.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -503,7 +505,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.environment.html
vendored
12
docs/build/html/cpl_core.environment.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -62,7 +62,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -79,7 +81,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.environment</li>
|
<li>cpl_core.environment</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.environment.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.environment.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -296,7 +298,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
38
docs/build/html/cpl_core.html
vendored
38
docs/build/html/cpl_core.html
vendored
@ -4,7 +4,7 @@
|
|||||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>API Reference — Common Python Library documentation</title>
|
<title>API reference — Common Python Library documentation</title>
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
<!--[if lt IE 9]>
|
<!--[if lt IE 9]>
|
||||||
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">API reference</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -57,7 +57,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -74,7 +76,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li>API Reference</li>
|
<li>API reference</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.rst.txt" rel="nofollow"> View page source</a>
|
||||||
</li>
|
</li>
|
||||||
@ -85,7 +87,7 @@
|
|||||||
<div itemprop="articleBody">
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
<section id="api-reference">
|
<section id="api-reference">
|
||||||
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h1>
|
<h1>API reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h1>
|
||||||
<div class="toctree-wrapper compound">
|
<div class="toctree-wrapper compound">
|
||||||
<ul>
|
<ul>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a><ul>
|
||||||
@ -122,7 +124,6 @@
|
|||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="cpl_core.database.context.html#module-cpl_core.database.context.database_context_abc">cpl_core.database.context.database_context_abc</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#submodules">Submodules</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#cpl-core-database-database-model">cpl_core.database.database_model</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings">cpl_core.database.database_settings</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html#module-cpl_core.database.database_settings_name_enum">cpl_core.database.database_settings_name_enum</a></li>
|
||||||
@ -160,19 +161,14 @@
|
|||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes</a><ul>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#submodules">Submodules</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a></li>
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes">Module contents</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#cpl-core-sh-edraft-common-python-library">cpl-core sh-edraft Common Python library</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a><ul>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a><ul>
|
||||||
@ -201,7 +197,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.logging.html
vendored
12
docs/build/html/cpl_core.logging.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.logging</li>
|
<li>cpl_core.logging</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.logging.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.logging.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -457,7 +459,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.mailing.html
vendored
12
docs/build/html/cpl_core.mailing.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -64,7 +64,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -81,7 +83,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.mailing</li>
|
<li>cpl_core.mailing</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -367,7 +369,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
93
docs/build/html/cpl_core.pipes.html
vendored
93
docs/build/html/cpl_core.pipes.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -53,26 +53,23 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.mailing.html">cpl_core.mailing</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.pipes</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.pipes</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.pipes">Module contents</a><ul>
|
|
||||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-sh-edraft-common-python-library">cpl-core sh-edraft Common Python library</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -89,7 +86,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.pipes</li>
|
<li>cpl_core.pipes</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.pipes.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.pipes.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -102,11 +99,8 @@
|
|||||||
|
|
||||||
<section id="cpl-core-pipes">
|
<section id="cpl-core-pipes">
|
||||||
<h1>cpl_core.pipes<a class="headerlink" href="#cpl-core-pipes" title="Permalink to this heading"></a></h1>
|
<h1>cpl_core.pipes<a class="headerlink" href="#cpl-core-pipes" title="Permalink to this heading"></a></h1>
|
||||||
<section id="submodules">
|
|
||||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_core.pipes.bool_pipe">
|
<section id="module-cpl_core.pipes.bool_pipe">
|
||||||
<span id="cpl-core-pipes-bool-pipe-module"></span><h2>cpl_core.pipes.bool_pipe module<a class="headerlink" href="#module-cpl_core.pipes.bool_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-bool-pipe"></span><h2>cpl_core.pipes.bool_pipe<a class="headerlink" href="#module-cpl_core.pipes.bool_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.bool_pipe.BoolPipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.bool_pipe.BoolPipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.bool_pipe.</span></span><span class="sig-name descname"><span class="pre">BoolPipe</span></span><a class="headerlink" href="#cpl_core.pipes.bool_pipe.BoolPipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.bool_pipe.</span></span><span class="sig-name descname"><span class="pre">BoolPipe</span></span><a class="headerlink" href="#cpl_core.pipes.bool_pipe.BoolPipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -120,7 +114,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.first_char_to_lower_pipe">
|
<section id="module-cpl_core.pipes.first_char_to_lower_pipe">
|
||||||
<span id="cpl-core-pipes-first-char-to-lower-pipe-module"></span><h2>cpl_core.pipes.first_char_to_lower_pipe module<a class="headerlink" href="#module-cpl_core.pipes.first_char_to_lower_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-first-char-to-lower-pipe"></span><h2>cpl_core.pipes.first_char_to_lower_pipe<a class="headerlink" href="#module-cpl_core.pipes.first_char_to_lower_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_char_to_lower_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstCharToLowerPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_char_to_lower_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstCharToLowerPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_char_to_lower_pipe.FirstCharToLowerPipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -144,7 +138,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.first_to_upper_pipe">
|
<section id="module-cpl_core.pipes.first_to_upper_pipe">
|
||||||
<span id="cpl-core-pipes-first-to-upper-pipe-module"></span><h2>cpl_core.pipes.first_to_upper_pipe module<a class="headerlink" href="#module-cpl_core.pipes.first_to_upper_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-first-to-upper-pipe"></span><h2>cpl_core.pipes.first_to_upper_pipe<a class="headerlink" href="#module-cpl_core.pipes.first_to_upper_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_to_upper_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstToUpperPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.first_to_upper_pipe.</span></span><span class="sig-name descname"><span class="pre">FirstToUpperPipe</span></span><a class="headerlink" href="#cpl_core.pipes.first_to_upper_pipe.FirstToUpperPipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -168,7 +162,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.ip_address_pipe">
|
<section id="module-cpl_core.pipes.ip_address_pipe">
|
||||||
<span id="cpl-core-pipes-ip-address-pipe-module"></span><h2>cpl_core.pipes.ip_address_pipe module<a class="headerlink" href="#module-cpl_core.pipes.ip_address_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-ip-address-pipe"></span><h2>cpl_core.pipes.ip_address_pipe<a class="headerlink" href="#module-cpl_core.pipes.ip_address_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.ip_address_pipe.IPAddressPipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.ip_address_pipe.IPAddressPipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.ip_address_pipe.</span></span><span class="sig-name descname"><span class="pre">IPAddressPipe</span></span><a class="headerlink" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.ip_address_pipe.</span></span><span class="sig-name descname"><span class="pre">IPAddressPipe</span></span><a class="headerlink" href="#cpl_core.pipes.ip_address_pipe.IPAddressPipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -182,7 +176,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.pipe_abc">
|
<section id="module-cpl_core.pipes.pipe_abc">
|
||||||
<span id="cpl-core-pipes-pipe-abc-module"></span><h2>cpl_core.pipes.pipe_abc module<a class="headerlink" href="#module-cpl_core.pipes.pipe_abc" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-pipe-abc"></span><h2>cpl_core.pipes.pipe_abc<a class="headerlink" href="#module-cpl_core.pipes.pipe_abc" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.pipe_abc.PipeABC">
|
<dt class="sig sig-object py" id="cpl_core.pipes.pipe_abc.PipeABC">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.pipe_abc.</span></span><span class="sig-name descname"><span class="pre">PipeABC</span></span><a class="headerlink" href="#cpl_core.pipes.pipe_abc.PipeABC" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.pipe_abc.</span></span><span class="sig-name descname"><span class="pre">PipeABC</span></span><a class="headerlink" href="#cpl_core.pipes.pipe_abc.PipeABC" title="Permalink to this definition"></a></dt>
|
||||||
@ -196,7 +190,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.to_camel_case_pipe">
|
<section id="module-cpl_core.pipes.to_camel_case_pipe">
|
||||||
<span id="cpl-core-pipes-to-camel-case-pipe-module"></span><h2>cpl_core.pipes.to_camel_case_pipe module<a class="headerlink" href="#module-cpl_core.pipes.to_camel_case_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-to-camel-case-pipe"></span><h2>cpl_core.pipes.to_camel_case_pipe<a class="headerlink" href="#module-cpl_core.pipes.to_camel_case_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_camel_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToCamelCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_camel_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToCamelCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_camel_case_pipe.ToCamelCasePipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -220,7 +214,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.to_snake_case_pipe">
|
<section id="module-cpl_core.pipes.to_snake_case_pipe">
|
||||||
<span id="cpl-core-pipes-to-snake-case-pipe-module"></span><h2>cpl_core.pipes.to_snake_case_pipe module<a class="headerlink" href="#module-cpl_core.pipes.to_snake_case_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-to-snake-case-pipe"></span><h2>cpl_core.pipes.to_snake_case_pipe<a class="headerlink" href="#module-cpl_core.pipes.to_snake_case_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_snake_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToSnakeCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.to_snake_case_pipe.</span></span><span class="sig-name descname"><span class="pre">ToSnakeCasePipe</span></span><a class="headerlink" href="#cpl_core.pipes.to_snake_case_pipe.ToSnakeCasePipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -244,7 +238,7 @@
|
|||||||
|
|
||||||
</section>
|
</section>
|
||||||
<section id="module-cpl_core.pipes.version_pipe">
|
<section id="module-cpl_core.pipes.version_pipe">
|
||||||
<span id="cpl-core-pipes-version-pipe-module"></span><h2>cpl_core.pipes.version_pipe module<a class="headerlink" href="#module-cpl_core.pipes.version_pipe" title="Permalink to this heading"></a></h2>
|
<span id="cpl-core-pipes-version-pipe"></span><h2>cpl_core.pipes.version_pipe<a class="headerlink" href="#module-cpl_core.pipes.version_pipe" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.version_pipe.VersionPipe">
|
<dt class="sig sig-object py" id="cpl_core.pipes.version_pipe.VersionPipe">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.version_pipe.</span></span><span class="sig-name descname"><span class="pre">VersionPipe</span></span><a class="headerlink" href="#cpl_core.pipes.version_pipe.VersionPipe" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.version_pipe.</span></span><span class="sig-name descname"><span class="pre">VersionPipe</span></span><a class="headerlink" href="#cpl_core.pipes.version_pipe.VersionPipe" title="Permalink to this definition"></a></dt>
|
||||||
@ -256,47 +250,6 @@
|
|||||||
|
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_core.pipes">
|
|
||||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.pipes" title="Permalink to this heading"></a></h2>
|
|
||||||
<section id="cpl-core-sh-edraft-common-python-library">
|
|
||||||
<h3>cpl-core sh-edraft Common Python library<a class="headerlink" href="#cpl-core-sh-edraft-common-python-library" title="Permalink to this heading"></a></h3>
|
|
||||||
<p>sh-edraft Common Python library</p>
|
|
||||||
<dl class="field-list simple">
|
|
||||||
<dt class="field-odd">copyright</dt>
|
|
||||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
|
||||||
<li><p>2020 - 2022 sh-edraft.de</p></li>
|
|
||||||
</ol>
|
|
||||||
</dd>
|
|
||||||
<dt class="field-even">license</dt>
|
|
||||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.pipes.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.pipes.VersionInfo" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.major">
|
|
||||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Alias for field number 0</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.micro">
|
|
||||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Alias for field number 2</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_core.pipes.VersionInfo.minor">
|
|
||||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.pipes.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Alias for field number 1</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
@ -311,7 +264,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
12
docs/build/html/cpl_core.time.html
vendored
12
docs/build/html/cpl_core.time.html
vendored
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -61,7 +61,9 @@
|
|||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -78,7 +80,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.time</li>
|
<li>cpl_core.time</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.time.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.time.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -173,7 +175,7 @@
|
|||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
16
docs/build/html/cpl_core.utils.html
vendored
16
docs/build/html/cpl_core.utils.html
vendored
@ -19,7 +19,7 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="Query Reference" href="cpl_query.html" />
|
<link rel="next" title="Discord reference" href="cpl_discord.html" />
|
||||||
<link rel="prev" title="cpl_core.time" href="cpl_core.time.html" />
|
<link rel="prev" title="cpl_core.time" href="cpl_core.time.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
@ -42,8 +42,8 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API Reference</a><ul class="current">
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
|
||||||
@ -62,7 +62,9 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -79,7 +81,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_core.html">API Reference</a> »</li>
|
<li><a href="cpl_core.html">API reference</a> »</li>
|
||||||
<li>cpl_core.utils</li>
|
<li>cpl_core.utils</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_core.utils.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_core.utils.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -325,13 +327,13 @@
|
|||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_core.time.html" class="btn btn-neutral float-left" title="cpl_core.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_core.time.html" class="btn btn-neutral float-left" title="cpl_core.time" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_query.html" class="btn btn-neutral float-right" title="Query Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_discord.html" class="btn btn-neutral float-right" title="Discord reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
138
docs/build/html/cpl_discord.application.html
vendored
Normal file
138
docs/build/html/cpl_discord.application.html
vendored
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.application — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.command" href="cpl_discord.command.html" />
|
||||||
|
<link rel="prev" title="Discord reference" href="cpl_discord.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.application</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.application.discord_bot_application_abc">cpl_discord.application.discord_bot_application_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.application</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.application.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-application">
|
||||||
|
<h1>cpl_discord.application<a class="headerlink" href="#cpl-discord-application" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.application.discord_bot_application_abc">
|
||||||
|
<span id="cpl-discord-application-discord-bot-application-abc"></span><h2>cpl_discord.application.discord_bot_application_abc<a class="headerlink" href="#module-cpl_discord.application.discord_bot_application_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.application.discord_bot_application_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotApplicationABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC" title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><span class="pre">ServiceProviderABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="cpl_core.application.html#cpl_core.application.application_abc.ApplicationABC" title="cpl_core.application.application_abc.ApplicationABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC.stop_async">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stop_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.application.discord_bot_application_abc.DiscordBotApplicationABC.stop_async" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.html" class="btn btn-neutral float-left" title="Discord reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.command.html" class="btn btn-neutral float-right" title="cpl_discord.command" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
143
docs/build/html/cpl_discord.command.html
vendored
Normal file
143
docs/build/html/cpl_discord.command.html
vendored
Normal file
@ -0,0 +1,143 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.command — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.configuration" href="cpl_discord.configuration.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.application" href="cpl_discord.application.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.command</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_command_abc">cpl_discord.command.discord_command_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.command.discord_commands_meta">cpl_discord.command.discord_commands_meta</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.command</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.command.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-command">
|
||||||
|
<h1>cpl_discord.command<a class="headerlink" href="#cpl-discord-command" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.command.discord_command_abc">
|
||||||
|
<span id="cpl-discord-command-discord-command-abc"></span><h2>cpl_discord.command.discord_command_abc<a class="headerlink" href="#module-cpl_discord.command.discord_command_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.command.discord_command_abc.DiscordCommandABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.command.discord_command_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordCommandABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.command.discord_command_abc.DiscordCommandABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Cog</span></code></p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.command.discord_commands_meta">
|
||||||
|
<span id="cpl-discord-command-discord-commands-meta"></span><h2>cpl_discord.command.discord_commands_meta<a class="headerlink" href="#module-cpl_discord.command.discord_commands_meta" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.command.discord_commands_meta.DiscordCogMeta">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.command.discord_commands_meta.</span></span><span class="sig-name descname"><span class="pre">DiscordCogMeta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bases</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.command.discord_commands_meta.DiscordCogMeta" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABCMeta</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">CogMeta</span></code></p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.application.html" class="btn btn-neutral float-left" title="cpl_discord.application" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.configuration.html" class="btn btn-neutral float-right" title="cpl_discord.configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
152
docs/build/html/cpl_discord.configuration.html
vendored
Normal file
152
docs/build/html/cpl_discord.configuration.html
vendored
Normal file
@ -0,0 +1,152 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.configuration — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.container" href="cpl_discord.container.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.command" href="cpl_discord.command.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.configuration</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.configuration.discord_bot_settings">cpl_discord.configuration.discord_bot_settings</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.configuration</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.configuration.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-configuration">
|
||||||
|
<h1>cpl_discord.configuration<a class="headerlink" href="#cpl-discord-configuration" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.configuration.discord_bot_settings">
|
||||||
|
<span id="cpl-discord-configuration-discord-bot-settings"></span><h2>cpl_discord.configuration.discord_bot_settings<a class="headerlink" href="#module-cpl_discord.configuration.discord_bot_settings" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.configuration.discord_bot_settings.</span></span><span class="sig-name descname"><span class="pre">DiscordBotSettings</span></span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.from_dict">
|
||||||
|
<span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.from_dict" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Converts attributes to dict</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">prefix</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.prefix" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.token">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings.token" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.command.html" class="btn btn-neutral float-left" title="cpl_discord.command" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.container.html" class="btn btn-neutral float-right" title="cpl_discord.container" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
674
docs/build/html/cpl_discord.container.html
vendored
Normal file
674
docs/build/html/cpl_discord.container.html
vendored
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.container — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.events" href="cpl_discord.events.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.configuration" href="cpl_discord.configuration.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.container</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.category_channel">cpl_discord.container.category_channel</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.container">cpl_discord.container.container</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.guild">cpl_discord.container.guild</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.member">cpl_discord.container.member</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.role">cpl_discord.container.role</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.text_channel">cpl_discord.container.text_channel</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.thread">cpl_discord.container.thread</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.container.voice_channel">cpl_discord.container.voice_channel</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.container</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.container.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-container">
|
||||||
|
<h1>cpl_discord.container<a class="headerlink" href="#cpl-discord-container" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.container.category_channel">
|
||||||
|
<span id="cpl-discord-container-category-channel"></span><h2>cpl_discord.container.category_channel<a class="headerlink" href="#module-cpl_discord.container.category_channel" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.category_channel.</span></span><span class="sig-name descname"><span class="pre">CategoryChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">CategoryChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryChannel</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.category_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.category_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.guild">
|
||||||
|
<span class="sig-name descname"><span class="pre">guild</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.id">
|
||||||
|
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.name">
|
||||||
|
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.name" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.nsfw">
|
||||||
|
<span class="sig-name descname"><span class="pre">nsfw</span></span><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.nsfw" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.position">
|
||||||
|
<span class="sig-name descname"><span class="pre">position</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.position" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.text_channels">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text_channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.text_channel.TextChannel" title="cpl_discord.container.text_channel.TextChannel"><span class="pre">TextChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.text_channels" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code>]: Returns the text channels that are under this category.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.category_channel.CategoryChannel.voice_channels">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">voice_channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.voice_channel.VoiceChannel" title="cpl_discord.container.voice_channel.VoiceChannel"><span class="pre">VoiceChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.category_channel.CategoryChannel.voice_channels" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">VoiceChannel</span></code>]: Returns the voice channels that are under this category.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.container">
|
||||||
|
<span id="cpl-discord-container-container"></span><h2>cpl_discord.container.container<a class="headerlink" href="#module-cpl_discord.container.container" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.container.Container">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.container.</span></span><span class="sig-name descname"><span class="pre">Container</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_o</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.container.Container" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.guild">
|
||||||
|
<span id="cpl-discord-container-guild"></span><h2>cpl_discord.container.guild<a class="headerlink" href="#module-cpl_discord.container.guild" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.guild.</span></span><span class="sig-name descname"><span class="pre">Guild</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.guild.Guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Guild</span></code></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.afk_channel">
|
||||||
|
<span class="sig-name descname"><span class="pre">afk_channel</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.afk_channel" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.afk_timeout">
|
||||||
|
<span class="sig-name descname"><span class="pre">afk_timeout</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.afk_timeout" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.approximate_member_count">
|
||||||
|
<span class="sig-name descname"><span class="pre">approximate_member_count</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.approximate_member_count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.approximate_presence_count">
|
||||||
|
<span class="sig-name descname"><span class="pre">approximate_presence_count</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.approximate_presence_count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.categories">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">categories</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.category_channel.CategoryChannel" title="cpl_discord.container.category_channel.CategoryChannel"><span class="pre">CategoryChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.categories" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">CategoryChannel</span></code>]: A list of categories that belongs to this guild.</p>
|
||||||
|
<p>This is sorted by the position and are in UI order from top to bottom.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.default_notifications">
|
||||||
|
<span class="sig-name descname"><span class="pre">default_notifications</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.default_notifications" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.description">
|
||||||
|
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.description" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.emojis">
|
||||||
|
<span class="sig-name descname"><span class="pre">emojis</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.emojis" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.explicit_content_filter">
|
||||||
|
<span class="sig-name descname"><span class="pre">explicit_content_filter</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.explicit_content_filter" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.features">
|
||||||
|
<span class="sig-name descname"><span class="pre">features</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.features" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.id">
|
||||||
|
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.max_members">
|
||||||
|
<span class="sig-name descname"><span class="pre">max_members</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.max_members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.max_presences">
|
||||||
|
<span class="sig-name descname"><span class="pre">max_presences</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.max_presences" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.max_video_channel_users">
|
||||||
|
<span class="sig-name descname"><span class="pre">max_video_channel_users</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.max_video_channel_users" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.members">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.member.Member" title="cpl_discord.container.member.Member"><span class="pre">Member</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sequence[<code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code>]: A list of members that belong to this guild.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.mfa_level">
|
||||||
|
<span class="sig-name descname"><span class="pre">mfa_level</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.mfa_level" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.name">
|
||||||
|
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.name" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.nsfw_level">
|
||||||
|
<span class="sig-name descname"><span class="pre">nsfw_level</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.nsfw_level" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.owner_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">owner_id</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.owner_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.preferred_locale">
|
||||||
|
<span class="sig-name descname"><span class="pre">preferred_locale</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.preferred_locale" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.premium_progress_bar_enabled">
|
||||||
|
<span class="sig-name descname"><span class="pre">premium_progress_bar_enabled</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.premium_progress_bar_enabled" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.premium_subscription_count">
|
||||||
|
<span class="sig-name descname"><span class="pre">premium_subscription_count</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.premium_subscription_count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.premium_tier">
|
||||||
|
<span class="sig-name descname"><span class="pre">premium_tier</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.premium_tier" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.roles">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.role.Role" title="cpl_discord.container.role.Role"><span class="pre">Role</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.roles" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sequence[<code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code>]: Returns a sequence of the guild’s roles in hierarchy order.</p>
|
||||||
|
<p>The first element of this sequence will be the lowest role in the
|
||||||
|
hierarchy.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.stickers">
|
||||||
|
<span class="sig-name descname"><span class="pre">stickers</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.stickers" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.text_channels">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text_channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.text_channel.TextChannel" title="cpl_discord.container.text_channel.TextChannel"><span class="pre">TextChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.text_channels" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code>]: A list of text channels that belongs to this guild.</p>
|
||||||
|
<p>This is sorted by the position and are in UI order from top to bottom.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.threads">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">threads</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.text_channel.TextChannel" title="cpl_discord.container.text_channel.TextChannel"><span class="pre">TextChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.threads" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sequence[<code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code>]: A list of threads that you have permission to view.</p>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 2.0.</span></p>
|
||||||
|
</div>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.unavailable">
|
||||||
|
<span class="sig-name descname"><span class="pre">unavailable</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.unavailable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.vanity_url_code">
|
||||||
|
<span class="sig-name descname"><span class="pre">vanity_url_code</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.vanity_url_code" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.verification_level">
|
||||||
|
<span class="sig-name descname"><span class="pre">verification_level</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.verification_level" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.voice_channels">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">voice_channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.voice_channel.VoiceChannel" title="cpl_discord.container.voice_channel.VoiceChannel"><span class="pre">VoiceChannel</span></a></em><a class="headerlink" href="#cpl_discord.container.guild.Guild.voice_channels" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">VoiceChannel</span></code>]: A list of voice channels that belongs to this guild.</p>
|
||||||
|
<p>This is sorted by the position and are in UI order from top to bottom.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.guild.Guild.widget_enabled">
|
||||||
|
<span class="sig-name descname"><span class="pre">widget_enabled</span></span><a class="headerlink" href="#cpl_discord.container.guild.Guild.widget_enabled" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.member">
|
||||||
|
<span id="cpl-discord-container-member"></span><h2>cpl_discord.container.member<a class="headerlink" href="#module-cpl_discord.container.member" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.member.</span></span><span class="sig-name descname"><span class="pre">Member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.member.Member" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.activities">
|
||||||
|
<span class="sig-name descname"><span class="pre">activities</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ActivityTypes</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.activities" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.guild">
|
||||||
|
<span class="sig-name descname"><span class="pre">guild</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.container.member.Member.guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.joined_at">
|
||||||
|
<span class="sig-name descname"><span class="pre">joined_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.joined_at" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.nick">
|
||||||
|
<span class="sig-name descname"><span class="pre">nick</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.nick" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.pending">
|
||||||
|
<span class="sig-name descname"><span class="pre">pending</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#cpl_discord.container.member.Member.pending" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.premium_since">
|
||||||
|
<span class="sig-name descname"><span class="pre">premium_since</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.premium_since" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.roles">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.role.Role" title="cpl_discord.container.role.Role"><span class="pre">Role</span></a></em><a class="headerlink" href="#cpl_discord.container.member.Member.roles" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code>]: A <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code> that the member belongs to. Note
|
||||||
|
that the first element of this list is always the default <a class="reference external" href="mailto:'%40everyone">‘<span>@</span>everyone</a>’
|
||||||
|
role.</p>
|
||||||
|
<p>These roles are sorted by their position in the role hierarchy.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.member.Member.timed_out_until">
|
||||||
|
<span class="sig-name descname"><span class="pre">timed_out_until</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.member.Member.timed_out_until" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.role">
|
||||||
|
<span id="cpl-discord-container-role"></span><h2>cpl_discord.container.role<a class="headerlink" href="#module-cpl_discord.container.role" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.role.</span></span><span class="sig-name descname"><span class="pre">Role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.role.Role" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.guild">
|
||||||
|
<span class="sig-name descname"><span class="pre">guild</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.container.role.Role.guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.hoist">
|
||||||
|
<span class="sig-name descname"><span class="pre">hoist</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.hoist" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.id">
|
||||||
|
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.role.Role.id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.managed">
|
||||||
|
<span class="sig-name descname"><span class="pre">managed</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.managed" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.members">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.member.Member" title="cpl_discord.container.member.Member"><span class="pre">Member</span></a></em><a class="headerlink" href="#cpl_discord.container.role.Role.members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code>]: Returns all the members with this role.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.mentionable">
|
||||||
|
<span class="sig-name descname"><span class="pre">mentionable</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.mentionable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.name">
|
||||||
|
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.name" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.position">
|
||||||
|
<span class="sig-name descname"><span class="pre">position</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.position" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.tags">
|
||||||
|
<span class="sig-name descname"><span class="pre">tags</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.tags" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.role.Role.unicode_emoji">
|
||||||
|
<span class="sig-name descname"><span class="pre">unicode_emoji</span></span><a class="headerlink" href="#cpl_discord.container.role.Role.unicode_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.text_channel">
|
||||||
|
<span id="cpl-discord-container-text-channel"></span><h2>cpl_discord.container.text_channel<a class="headerlink" href="#module-cpl_discord.container.text_channel" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.text_channel.</span></span><span class="sig-name descname"><span class="pre">TextChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TextChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.category_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">category_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.category_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.default_auto_archive_duration">
|
||||||
|
<span class="sig-name descname"><span class="pre">default_auto_archive_duration</span></span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.default_auto_archive_duration" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.guild">
|
||||||
|
<span class="sig-name descname"><span class="pre">guild</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.id">
|
||||||
|
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.last_message_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">last_message_id</span></span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.last_message_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.members">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Member</span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code>]: Returns all members that can see this channel.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.name">
|
||||||
|
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.name" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.nsfw">
|
||||||
|
<span class="sig-name descname"><span class="pre">nsfw</span></span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.nsfw" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.position">
|
||||||
|
<span class="sig-name descname"><span class="pre">position</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.position" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.slowmode_delay">
|
||||||
|
<span class="sig-name descname"><span class="pre">slowmode_delay</span></span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.slowmode_delay" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.threads">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">threads</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.thread.Thread" title="cpl_discord.container.thread.Thread"><span class="pre">Thread</span></a></em><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.threads" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code>]: Returns all the threads that you can see.</p>
|
||||||
|
<div class="versionadded">
|
||||||
|
<p><span class="versionmodified added">New in version 2.0.</span></p>
|
||||||
|
</div>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.text_channel.TextChannel.topic">
|
||||||
|
<span class="sig-name descname"><span class="pre">topic</span></span><a class="headerlink" href="#cpl_discord.container.text_channel.TextChannel.topic" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.thread">
|
||||||
|
<span id="cpl-discord-container-thread"></span><h2>cpl_discord.container.thread<a class="headerlink" href="#module-cpl_discord.container.thread" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.thread.</span></span><span class="sig-name descname"><span class="pre">Thread</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Thread</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.thread.Thread" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Thread</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.archive_timestamp">
|
||||||
|
<span class="sig-name descname"><span class="pre">archive_timestamp</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.archive_timestamp" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.archived">
|
||||||
|
<span class="sig-name descname"><span class="pre">archived</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.archived" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.archiver_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">archiver_id</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.archiver_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.auto_archive_duration">
|
||||||
|
<span class="sig-name descname"><span class="pre">auto_archive_duration</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.auto_archive_duration" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.guild">
|
||||||
|
<span class="sig-name descname"><span class="pre">guild</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.container.thread.Thread.guild" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.id">
|
||||||
|
<span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_discord.container.thread.Thread.id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.invitable">
|
||||||
|
<span class="sig-name descname"><span class="pre">invitable</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.invitable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.last_message_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">last_message_id</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.last_message_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.locked">
|
||||||
|
<span class="sig-name descname"><span class="pre">locked</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.locked" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.me">
|
||||||
|
<span class="sig-name descname"><span class="pre">me</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.me" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.member_count">
|
||||||
|
<span class="sig-name descname"><span class="pre">member_count</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.member_count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.members">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.member.Member" title="cpl_discord.container.member.Member"><span class="pre">Member</span></a></em><a class="headerlink" href="#cpl_discord.container.thread.Thread.members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadMember</span></code>]: A list of thread members in this thread.</p>
|
||||||
|
<p>This requires <code class="xref py py-attr docutils literal notranslate"><span class="pre">Intents.members</span></code> to be properly filled. Most of the time however,
|
||||||
|
this data is not provided by the gateway and a call to <code class="xref py py-meth docutils literal notranslate"><span class="pre">fetch_members()</span></code> is
|
||||||
|
needed.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.message_count">
|
||||||
|
<span class="sig-name descname"><span class="pre">message_count</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.message_count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.name">
|
||||||
|
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.name" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.owner_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">owner_id</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.owner_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.parent_id">
|
||||||
|
<span class="sig-name descname"><span class="pre">parent_id</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.parent_id" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py attribute">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.thread.Thread.slowmode_delay">
|
||||||
|
<span class="sig-name descname"><span class="pre">slowmode_delay</span></span><a class="headerlink" href="#cpl_discord.container.thread.Thread.slowmode_delay" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.container.voice_channel">
|
||||||
|
<span id="cpl-discord-container-voice-channel"></span><h2>cpl_discord.container.voice_channel<a class="headerlink" href="#module-cpl_discord.container.voice_channel" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.voice_channel.VoiceChannel">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.container.voice_channel.</span></span><span class="sig-name descname"><span class="pre">VoiceChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.container.voice_channel.VoiceChannel" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VoiceChannel</span></code>, <a class="reference internal" href="#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">Container</span></code></a></p>
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.container.voice_channel.VoiceChannel.members">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">members</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#cpl_discord.container.member.Member" title="cpl_discord.container.member.Member"><span class="pre">Member</span></a></em><a class="headerlink" href="#cpl_discord.container.voice_channel.VoiceChannel.members" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>List[<code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code>]: Returns all members that are currently inside this voice channel.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.configuration.html" class="btn btn-neutral float-left" title="cpl_discord.configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.events.html" class="btn btn-neutral float-right" title="cpl_discord.events" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
888
docs/build/html/cpl_discord.events.html
vendored
Normal file
888
docs/build/html/cpl_discord.events.html
vendored
Normal file
@ -0,0 +1,888 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.events — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.helper" href="cpl_discord.helper.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.container" href="cpl_discord.container.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.events</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_bulk_message_delete_abc">cpl_discord.events.on_bulk_message_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_abc">cpl_discord.events.on_command_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_completion_abc">cpl_discord.events.on_command_completion_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_command_error_abc">cpl_discord.events.on_command_error_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_connect_abc">cpl_discord.events.on_connect_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_disconnect_abc">cpl_discord.events.on_disconnect_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_error_abc">cpl_discord.events.on_error_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_join_abc">cpl_discord.events.on_group_join_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_group_remove_abc">cpl_discord.events.on_group_remove_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_available_abc">cpl_discord.events.on_guild_available_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_create_abc">cpl_discord.events.on_guild_channel_create_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_delete_abc">cpl_discord.events.on_guild_channel_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_pins_update_abc">cpl_discord.events.on_guild_channel_pins_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_channel_update_abc">cpl_discord.events.on_guild_channel_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_emojis_update_abc">cpl_discord.events.on_guild_emojis_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_integrations_update_abc">cpl_discord.events.on_guild_integrations_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_join_abc">cpl_discord.events.on_guild_join_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_remove_abc">cpl_discord.events.on_guild_remove_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_create_abc">cpl_discord.events.on_guild_role_create_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_delete_abc">cpl_discord.events.on_guild_role_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_role_update_abc">cpl_discord.events.on_guild_role_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_unavailable_abc">cpl_discord.events.on_guild_unavailable_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_guild_update_abc">cpl_discord.events.on_guild_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_create_abc">cpl_discord.events.on_invite_create_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_invite_delete_abc">cpl_discord.events.on_invite_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_ban_abc">cpl_discord.events.on_member_ban_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_join_abc">cpl_discord.events.on_member_join_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_remove_abc">cpl_discord.events.on_member_remove_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_unban_abc">cpl_discord.events.on_member_unban_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_member_update_abc">cpl_discord.events.on_member_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_abc">cpl_discord.events.on_message_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_delete_abc">cpl_discord.events.on_message_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_message_edit_abc">cpl_discord.events.on_message_edit_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_create_abc">cpl_discord.events.on_private_channel_create_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_delete_abc">cpl_discord.events.on_private_channel_delete_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_pins_update_abc">cpl_discord.events.on_private_channel_pins_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_private_channel_update_abc">cpl_discord.events.on_private_channel_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_add_abc">cpl_discord.events.on_raw_reaction_add_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_abc">cpl_discord.events.on_raw_reaction_clear_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">cpl_discord.events.on_raw_reaction_clear_emoji_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_raw_reaction_remove_abc">cpl_discord.events.on_raw_reaction_remove_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_add_abc">cpl_discord.events.on_reaction_add_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_abc">cpl_discord.events.on_reaction_clear_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_clear_emoji_abc">cpl_discord.events.on_reaction_clear_emoji_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_reaction_remove_abc">cpl_discord.events.on_reaction_remove_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_ready_abc">cpl_discord.events.on_ready_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_resume_abc">cpl_discord.events.on_resume_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_typing_abc">cpl_discord.events.on_typing_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_user_update_abc">cpl_discord.events.on_user_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_voice_state_update_abc">cpl_discord.events.on_voice_state_update_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.events.on_webhooks_update_abc">cpl_discord.events.on_webhooks_update_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.events</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.events.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-events">
|
||||||
|
<h1>cpl_discord.events<a class="headerlink" href="#cpl-discord-events" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.events.on_bulk_message_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-bulk-message-delete-abc"></span><h2>cpl_discord.events.on_bulk_message_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_bulk_message_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_bulk_message_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnBulkMessageDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC.on_bulk_message_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_bulk_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.message.Message</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_bulk_message_delete_abc.OnBulkMessageDeleteABC.on_bulk_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_command_abc">
|
||||||
|
<span id="cpl-discord-events-on-command-abc"></span><h2>cpl_discord.events.on_command_abc<a class="headerlink" href="#module-cpl_discord.events.on_command_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_abc.OnCommandABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_command_abc.</span></span><span class="sig-name descname"><span class="pre">OnCommandABC</span></span><a class="headerlink" href="#cpl_discord.events.on_command_abc.OnCommandABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_abc.OnCommandABC.on_command">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_command_abc.OnCommandABC.on_command" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_command_completion_abc">
|
||||||
|
<span id="cpl-discord-events-on-command-completion-abc"></span><h2>cpl_discord.events.on_command_completion_abc<a class="headerlink" href="#module-cpl_discord.events.on_command_completion_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_command_completion_abc.</span></span><span class="sig-name descname"><span class="pre">OnCommandCompletionABC</span></span><a class="headerlink" href="#cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC.on_command_completion">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_completion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_command_completion_abc.OnCommandCompletionABC.on_command_completion" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_command_error_abc">
|
||||||
|
<span id="cpl-discord-events-on-command-error-abc"></span><h2>cpl_discord.events.on_command_error_abc<a class="headerlink" href="#module-cpl_discord.events.on_command_error_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_error_abc.OnCommandErrorABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_command_error_abc.</span></span><span class="sig-name descname"><span class="pre">OnCommandErrorABC</span></span><a class="headerlink" href="#cpl_discord.events.on_command_error_abc.OnCommandErrorABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_command_error_abc.OnCommandErrorABC.on_command_error">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">CommandError</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_command_error_abc.OnCommandErrorABC.on_command_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_connect_abc">
|
||||||
|
<span id="cpl-discord-events-on-connect-abc"></span><h2>cpl_discord.events.on_connect_abc<a class="headerlink" href="#module-cpl_discord.events.on_connect_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_connect_abc.OnConnectABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_connect_abc.</span></span><span class="sig-name descname"><span class="pre">OnConnectABC</span></span><a class="headerlink" href="#cpl_discord.events.on_connect_abc.OnConnectABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_connect_abc.OnConnectABC.on_connect">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_connect_abc.OnConnectABC.on_connect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_disconnect_abc">
|
||||||
|
<span id="cpl-discord-events-on-disconnect-abc"></span><h2>cpl_discord.events.on_disconnect_abc<a class="headerlink" href="#module-cpl_discord.events.on_disconnect_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_disconnect_abc.OnDisconnectABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_disconnect_abc.</span></span><span class="sig-name descname"><span class="pre">OnDisconnectABC</span></span><a class="headerlink" href="#cpl_discord.events.on_disconnect_abc.OnDisconnectABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_disconnect_abc.OnDisconnectABC.on_disconnect">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_disconnect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_disconnect_abc.OnDisconnectABC.on_disconnect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_error_abc">
|
||||||
|
<span id="cpl-discord-events-on-error-abc"></span><h2>cpl_discord.events.on_error_abc<a class="headerlink" href="#module-cpl_discord.events.on_error_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_error_abc.OnErrorABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_error_abc.</span></span><span class="sig-name descname"><span class="pre">OnErrorABC</span></span><a class="headerlink" href="#cpl_discord.events.on_error_abc.OnErrorABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_error_abc.OnErrorABC.on_error">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_error_abc.OnErrorABC.on_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_group_join_abc">
|
||||||
|
<span id="cpl-discord-events-on-group-join-abc"></span><h2>cpl_discord.events.on_group_join_abc<a class="headerlink" href="#module-cpl_discord.events.on_group_join_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_group_join_abc.OnGroupJoinABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_group_join_abc.</span></span><span class="sig-name descname"><span class="pre">OnGroupJoinABC</span></span><a class="headerlink" href="#cpl_discord.events.on_group_join_abc.OnGroupJoinABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_group_join_abc.OnGroupJoinABC.on_group_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chhanel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_group_join_abc.OnGroupJoinABC.on_group_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_group_remove_abc">
|
||||||
|
<span id="cpl-discord-events-on-group-remove-abc"></span><h2>cpl_discord.events.on_group_remove_abc<a class="headerlink" href="#module-cpl_discord.events.on_group_remove_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_group_remove_abc.</span></span><span class="sig-name descname"><span class="pre">OnGroupRemoveABC</span></span><a class="headerlink" href="#cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC.on_group_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chhanel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_group_remove_abc.OnGroupRemoveABC.on_group_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_available_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-available-abc"></span><h2>cpl_discord.events.on_guild_available_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_available_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_available_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildAvailableABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC.on_guild_available">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_available_abc.OnGuildAvailableABC.on_guild_available" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_channel_create_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-channel-create-abc"></span><h2>cpl_discord.events.on_guild_channel_create_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_channel_create_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_channel_create_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildChannelCreateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC.on_guild_channel_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_create_abc.OnGuildChannelCreateABC.on_guild_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_channel_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-channel-delete-abc"></span><h2>cpl_discord.events.on_guild_channel_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_channel_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_channel_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildChannelDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC.on_guild_channel_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_delete_abc.OnGuildChannelDeleteABC.on_guild_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_channel_pins_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-channel-pins-update-abc"></span><h2>cpl_discord.events.on_guild_channel_pins_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_channel_pins_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_channel_pins_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildChannelPinsUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_pins_update_abc.OnGuildChannelPinsUpdateABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_channel_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-channel-update-abc"></span><h2>cpl_discord.events.on_guild_channel_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_channel_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_channel_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildChannelUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC.on_guild_channel_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_channel_update_abc.OnGuildChannelUpdateABC.on_guild_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_emojis_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-emojis-update-abc"></span><h2>cpl_discord.events.on_guild_emojis_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_emojis_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_emojis_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildEmojisUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC.on_guild_emojis_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_emojis_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_emojis_update_abc.OnGuildEmojisUpdateABC.on_guild_emojis_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_integrations_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-integrations-update-abc"></span><h2>cpl_discord.events.on_guild_integrations_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_integrations_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_integrations_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildIntegrationsUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC.on_guild_integrations_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_integrations_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_integrations_update_abc.OnGuildIntegrationsUpdateABC.on_guild_integrations_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_join_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-join-abc"></span><h2>cpl_discord.events.on_guild_join_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_join_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_join_abc.OnGuildJoinABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_join_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildJoinABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_join_abc.OnGuildJoinABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_join_abc.OnGuildJoinABC.on_guild_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_join_abc.OnGuildJoinABC.on_guild_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_remove_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-remove-abc"></span><h2>cpl_discord.events.on_guild_remove_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_remove_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_remove_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildRemoveABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC.on_guild_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_remove_abc.OnGuildRemoveABC.on_guild_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_role_create_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-role-create-abc"></span><h2>cpl_discord.events.on_guild_role_create_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_role_create_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_role_create_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildRoleCreateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC.on_guild_role_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_role_create_abc.OnGuildRoleCreateABC.on_guild_role_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_role_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-role-delete-abc"></span><h2>cpl_discord.events.on_guild_role_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_role_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_role_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildRoleDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC.on_guild_role_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_role_delete_abc.OnGuildRoleDeleteABC.on_guild_role_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_role_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-role-update-abc"></span><h2>cpl_discord.events.on_guild_role_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_role_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_role_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildRoleUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC.on_guild_role_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_role_update_abc.OnGuildRoleUpdateABC.on_guild_role_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_unavailable_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-unavailable-abc"></span><h2>cpl_discord.events.on_guild_unavailable_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_unavailable_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_unavailable_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildUnavailableABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC.on_guild_unavailable">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_unavailable_abc.OnGuildUnavailableABC.on_guild_unavailable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_guild_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-guild-update-abc"></span><h2>cpl_discord.events.on_guild_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_guild_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_guild_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnGuildUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC.on_guild_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_guild_update_abc.OnGuildUpdateABC.on_guild_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_invite_create_abc">
|
||||||
|
<span id="cpl-discord-events-on-invite-create-abc"></span><h2>cpl_discord.events.on_invite_create_abc<a class="headerlink" href="#module-cpl_discord.events.on_invite_create_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_invite_create_abc.OnInviteCreateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_invite_create_abc.</span></span><span class="sig-name descname"><span class="pre">OnInviteCreateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_invite_create_abc.OnInviteCreateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_invite_create_abc.OnInviteCreateABC.on_invite_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_invite_create_abc.OnInviteCreateABC.on_invite_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_invite_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-invite-delete-abc"></span><h2>cpl_discord.events.on_invite_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_invite_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_invite_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnInviteDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC.on_invite_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_invite_delete_abc.OnInviteDeleteABC.on_invite_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_member_ban_abc">
|
||||||
|
<span id="cpl-discord-events-on-member-ban-abc"></span><h2>cpl_discord.events.on_member_ban_abc<a class="headerlink" href="#module-cpl_discord.events.on_member_ban_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_ban_abc.OnMemberBanABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_member_ban_abc.</span></span><span class="sig-name descname"><span class="pre">OnMemberBanABC</span></span><a class="headerlink" href="#cpl_discord.events.on_member_ban_abc.OnMemberBanABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_ban_abc.OnMemberBanABC.on_member_ban">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_ban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_member_ban_abc.OnMemberBanABC.on_member_ban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_member_join_abc">
|
||||||
|
<span id="cpl-discord-events-on-member-join-abc"></span><h2>cpl_discord.events.on_member_join_abc<a class="headerlink" href="#module-cpl_discord.events.on_member_join_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_join_abc.OnMemberJoinABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_member_join_abc.</span></span><span class="sig-name descname"><span class="pre">OnMemberJoinABC</span></span><a class="headerlink" href="#cpl_discord.events.on_member_join_abc.OnMemberJoinABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_join_abc.OnMemberJoinABC.on_member_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_member_join_abc.OnMemberJoinABC.on_member_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_member_remove_abc">
|
||||||
|
<span id="cpl-discord-events-on-member-remove-abc"></span><h2>cpl_discord.events.on_member_remove_abc<a class="headerlink" href="#module-cpl_discord.events.on_member_remove_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_member_remove_abc.</span></span><span class="sig-name descname"><span class="pre">OnMemberRemoveABC</span></span><a class="headerlink" href="#cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC.on_member_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_member_remove_abc.OnMemberRemoveABC.on_member_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_member_unban_abc">
|
||||||
|
<span id="cpl-discord-events-on-member-unban-abc"></span><h2>cpl_discord.events.on_member_unban_abc<a class="headerlink" href="#module-cpl_discord.events.on_member_unban_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_member_unban_abc.</span></span><span class="sig-name descname"><span class="pre">OnMemberUnbanABC</span></span><a class="headerlink" href="#cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC.on_member_unban">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_unban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_member_unban_abc.OnMemberUnbanABC.on_member_unban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_member_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-member-update-abc"></span><h2>cpl_discord.events.on_member_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_member_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_update_abc.OnMemberUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_member_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnMemberUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_member_update_abc.OnMemberUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_member_update_abc.OnMemberUpdateABC.on_member_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_member_update_abc.OnMemberUpdateABC.on_member_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_message_abc">
|
||||||
|
<span id="cpl-discord-events-on-message-abc"></span><h2>cpl_discord.events.on_message_abc<a class="headerlink" href="#module-cpl_discord.events.on_message_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_abc.OnMessageABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_message_abc.</span></span><span class="sig-name descname"><span class="pre">OnMessageABC</span></span><a class="headerlink" href="#cpl_discord.events.on_message_abc.OnMessageABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_abc.OnMessageABC.on_message">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_message_abc.OnMessageABC.on_message" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_message_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-message-delete-abc"></span><h2>cpl_discord.events.on_message_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_message_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_message_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnMessageDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC.on_message_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_message_delete_abc.OnMessageDeleteABC.on_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_message_edit_abc">
|
||||||
|
<span id="cpl-discord-events-on-message-edit-abc"></span><h2>cpl_discord.events.on_message_edit_abc<a class="headerlink" href="#module-cpl_discord.events.on_message_edit_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_edit_abc.OnMessageEditABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_message_edit_abc.</span></span><span class="sig-name descname"><span class="pre">OnMessageEditABC</span></span><a class="headerlink" href="#cpl_discord.events.on_message_edit_abc.OnMessageEditABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_message_edit_abc.OnMessageEditABC.on_message_edit">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_edit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_message_edit_abc.OnMessageEditABC.on_message_edit" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_private_channel_create_abc">
|
||||||
|
<span id="cpl-discord-events-on-private-channel-create-abc"></span><h2>cpl_discord.events.on_private_channel_create_abc<a class="headerlink" href="#module-cpl_discord.events.on_private_channel_create_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_private_channel_create_abc.</span></span><span class="sig-name descname"><span class="pre">OnPrivateChannelCreateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC.on_private_channel_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_create_abc.OnPrivateChannelCreateABC.on_private_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_private_channel_delete_abc">
|
||||||
|
<span id="cpl-discord-events-on-private-channel-delete-abc"></span><h2>cpl_discord.events.on_private_channel_delete_abc<a class="headerlink" href="#module-cpl_discord.events.on_private_channel_delete_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_private_channel_delete_abc.</span></span><span class="sig-name descname"><span class="pre">OnPrivateChannelDeleteABC</span></span><a class="headerlink" href="#cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC.on_private_channel_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_delete_abc.OnPrivateChannelDeleteABC.on_private_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_private_channel_pins_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-private-channel-pins-update-abc"></span><h2>cpl_discord.events.on_private_channel_pins_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_private_channel_pins_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_private_channel_pins_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnPrivateChannelPinsUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_pins_update_abc.OnPrivateChannelPinsUpdateABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_private_channel_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-private-channel-update-abc"></span><h2>cpl_discord.events.on_private_channel_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_private_channel_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_private_channel_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnPrivateChannelUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC.on_private_channel_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_private_channel_update_abc.OnPrivateChannelUpdateABC.on_private_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_raw_reaction_add_abc">
|
||||||
|
<span id="cpl-discord-events-on-raw-reaction-add-abc"></span><h2>cpl_discord.events.on_raw_reaction_add_abc<a class="headerlink" href="#module-cpl_discord.events.on_raw_reaction_add_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_raw_reaction_add_abc.</span></span><span class="sig-name descname"><span class="pre">OnRawReactionAddABC</span></span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC.on_raw_reaction_add">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_add_abc.OnRawReactionAddABC.on_raw_reaction_add" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_raw_reaction_clear_abc">
|
||||||
|
<span id="cpl-discord-events-on-raw-reaction-clear-abc"></span><h2>cpl_discord.events.on_raw_reaction_clear_abc<a class="headerlink" href="#module-cpl_discord.events.on_raw_reaction_clear_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_raw_reaction_clear_abc.</span></span><span class="sig-name descname"><span class="pre">OnRawReactionClearABC</span></span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC.on_raw_reaction_clear">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_clear_abc.OnRawReactionClearABC.on_raw_reaction_clear" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">
|
||||||
|
<span id="cpl-discord-events-on-raw-reaction-clear-emoji-abc"></span><h2>cpl_discord.events.on_raw_reaction_clear_emoji_abc<a class="headerlink" href="#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_raw_reaction_clear_emoji_abc.</span></span><span class="sig-name descname"><span class="pre">OnRawReactionClearEmojiABC</span></span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC.on_raw_reaction_clear_emoji">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_clear_emoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_clear_emoji_abc.OnRawReactionClearEmojiABC.on_raw_reaction_clear_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_raw_reaction_remove_abc">
|
||||||
|
<span id="cpl-discord-events-on-raw-reaction-remove-abc"></span><h2>cpl_discord.events.on_raw_reaction_remove_abc<a class="headerlink" href="#module-cpl_discord.events.on_raw_reaction_remove_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_raw_reaction_remove_abc.</span></span><span class="sig-name descname"><span class="pre">OnRawReactionRemoveABC</span></span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC.on_raw_reaction_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_raw_reaction_remove_abc.OnRawReactionRemoveABC.on_raw_reaction_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_reaction_add_abc">
|
||||||
|
<span id="cpl-discord-events-on-reaction-add-abc"></span><h2>cpl_discord.events.on_reaction_add_abc<a class="headerlink" href="#module-cpl_discord.events.on_reaction_add_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_add_abc.OnReactionAddABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_reaction_add_abc.</span></span><span class="sig-name descname"><span class="pre">OnReactionAddABC</span></span><a class="headerlink" href="#cpl_discord.events.on_reaction_add_abc.OnReactionAddABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_add_abc.OnReactionAddABC.on_reaction_add">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_reaction_add_abc.OnReactionAddABC.on_reaction_add" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_reaction_clear_abc">
|
||||||
|
<span id="cpl-discord-events-on-reaction-clear-abc"></span><h2>cpl_discord.events.on_reaction_clear_abc<a class="headerlink" href="#module-cpl_discord.events.on_reaction_clear_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_reaction_clear_abc.</span></span><span class="sig-name descname"><span class="pre">OnReactionClearABC</span></span><a class="headerlink" href="#cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC.on_reaction_clear">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reactions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.reaction.Reaction</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_reaction_clear_abc.OnReactionClearABC.on_reaction_clear" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_reaction_clear_emoji_abc">
|
||||||
|
<span id="cpl-discord-events-on-reaction-clear-emoji-abc"></span><h2>cpl_discord.events.on_reaction_clear_emoji_abc<a class="headerlink" href="#module-cpl_discord.events.on_reaction_clear_emoji_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_reaction_clear_emoji_abc.</span></span><span class="sig-name descname"><span class="pre">OnReactionClearEmojiABC</span></span><a class="headerlink" href="#cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC.on_reaction_clear_emoji">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear_emoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_reaction_clear_emoji_abc.OnReactionClearEmojiABC.on_reaction_clear_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_reaction_remove_abc">
|
||||||
|
<span id="cpl-discord-events-on-reaction-remove-abc"></span><h2>cpl_discord.events.on_reaction_remove_abc<a class="headerlink" href="#module-cpl_discord.events.on_reaction_remove_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_reaction_remove_abc.</span></span><span class="sig-name descname"><span class="pre">OnReactionRemoveABC</span></span><a class="headerlink" href="#cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC.on_reaction_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_reaction_remove_abc.OnReactionRemoveABC.on_reaction_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_ready_abc">
|
||||||
|
<span id="cpl-discord-events-on-ready-abc"></span><h2>cpl_discord.events.on_ready_abc<a class="headerlink" href="#module-cpl_discord.events.on_ready_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_ready_abc.OnReadyABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_ready_abc.</span></span><span class="sig-name descname"><span class="pre">OnReadyABC</span></span><a class="headerlink" href="#cpl_discord.events.on_ready_abc.OnReadyABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_ready_abc.OnReadyABC.on_ready">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_ready_abc.OnReadyABC.on_ready" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_resume_abc">
|
||||||
|
<span id="cpl-discord-events-on-resume-abc"></span><h2>cpl_discord.events.on_resume_abc<a class="headerlink" href="#module-cpl_discord.events.on_resume_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_resume_abc.OnResumeABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_resume_abc.</span></span><span class="sig-name descname"><span class="pre">OnResumeABC</span></span><a class="headerlink" href="#cpl_discord.events.on_resume_abc.OnResumeABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_resume_abc.OnResumeABC.on_resume">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_resume</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_resume_abc.OnResumeABC.on_resume" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_typing_abc">
|
||||||
|
<span id="cpl-discord-events-on-typing-abc"></span><h2>cpl_discord.events.on_typing_abc<a class="headerlink" href="#module-cpl_discord.events.on_typing_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_typing_abc.OnTypingABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_typing_abc.</span></span><span class="sig-name descname"><span class="pre">OnTypingABC</span></span><a class="headerlink" href="#cpl_discord.events.on_typing_abc.OnTypingABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_typing_abc.OnTypingABC.on_typing">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_typing_abc.OnTypingABC.on_typing" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_user_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-user-update-abc"></span><h2>cpl_discord.events.on_user_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_user_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_user_update_abc.OnUserUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_user_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnUserUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_user_update_abc.OnUserUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_user_update_abc.OnUserUpdateABC.on_user_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_user_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_user_update_abc.OnUserUpdateABC.on_user_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_voice_state_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-voice-state-update-abc"></span><h2>cpl_discord.events.on_voice_state_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_voice_state_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_voice_state_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnVoiceStateUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC.on_voice_state_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_voice_state_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_voice_state_update_abc.OnVoiceStateUpdateABC.on_voice_state_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.events.on_webhooks_update_abc">
|
||||||
|
<span id="cpl-discord-events-on-webhooks-update-abc"></span><h2>cpl_discord.events.on_webhooks_update_abc<a class="headerlink" href="#module-cpl_discord.events.on_webhooks_update_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.events.on_webhooks_update_abc.</span></span><span class="sig-name descname"><span class="pre">OnWebhooksUpdateABC</span></span><a class="headerlink" href="#cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC.on_webhooks_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_webhooks_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.events.on_webhooks_update_abc.OnWebhooksUpdateABC.on_webhooks_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.container.html" class="btn btn-neutral float-left" title="cpl_discord.container" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.helper.html" class="btn btn-neutral float-right" title="cpl_discord.helper" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
138
docs/build/html/cpl_discord.helper.html
vendored
Normal file
138
docs/build/html/cpl_discord.helper.html
vendored
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.helper — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.service" href="cpl_discord.service.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.events" href="cpl_discord.events.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.helper</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.helper.to_containers_converter">cpl_discord.helper.to_containers_converter</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.helper</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.helper.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-helper">
|
||||||
|
<h1>cpl_discord.helper<a class="headerlink" href="#cpl-discord-helper" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.helper.to_containers_converter">
|
||||||
|
<span id="cpl-discord-helper-to-containers-converter"></span><h2>cpl_discord.helper.to_containers_converter<a class="headerlink" href="#module-cpl_discord.helper.to_containers_converter" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.helper.to_containers_converter.ToContainersConverter">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.helper.to_containers_converter.</span></span><span class="sig-name descname"><span class="pre">ToContainersConverter</span></span><a class="headerlink" href="#cpl_discord.helper.to_containers_converter.ToContainersConverter" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.helper.to_containers_converter.ToContainersConverter.convert">
|
||||||
|
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_l</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">object</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.container.Container" title="cpl_discord.container.container.Container"><span class="pre">cpl_discord.container.container.Container</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_discord.helper.to_containers_converter.ToContainersConverter.convert" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.events.html" class="btn btn-neutral float-left" title="cpl_discord.events" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.service.html" class="btn btn-neutral float-right" title="cpl_discord.service" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
216
docs/build/html/cpl_discord.html
vendored
Normal file
216
docs/build/html/cpl_discord.html
vendored
Normal file
@ -0,0 +1,216 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>Discord reference — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_discord.application" href="cpl_discord.application.html" />
|
||||||
|
<link rel="prev" title="cpl_core.utils" href="cpl_core.utils.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Discord reference</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li>Discord reference</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="discord-reference">
|
||||||
|
<h1>Discord reference<a class="headerlink" href="#discord-reference" title="Permalink to this heading"></a></h1>
|
||||||
|
<div class="toctree-wrapper compound">
|
||||||
|
<ul>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html#module-cpl_discord.application.discord_bot_application_abc">cpl_discord.application.discord_bot_application_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html#module-cpl_discord.command.discord_command_abc">cpl_discord.command.discord_command_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html#module-cpl_discord.command.discord_commands_meta">cpl_discord.command.discord_commands_meta</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html#module-cpl_discord.configuration.discord_bot_settings">cpl_discord.configuration.discord_bot_settings</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.category_channel">cpl_discord.container.category_channel</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.container">cpl_discord.container.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.guild">cpl_discord.container.guild</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.member">cpl_discord.container.member</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.role">cpl_discord.container.role</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.text_channel">cpl_discord.container.text_channel</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.thread">cpl_discord.container.thread</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html#module-cpl_discord.container.voice_channel">cpl_discord.container.voice_channel</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_bulk_message_delete_abc">cpl_discord.events.on_bulk_message_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_abc">cpl_discord.events.on_command_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_completion_abc">cpl_discord.events.on_command_completion_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_command_error_abc">cpl_discord.events.on_command_error_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_connect_abc">cpl_discord.events.on_connect_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_disconnect_abc">cpl_discord.events.on_disconnect_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_error_abc">cpl_discord.events.on_error_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_group_join_abc">cpl_discord.events.on_group_join_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_group_remove_abc">cpl_discord.events.on_group_remove_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_available_abc">cpl_discord.events.on_guild_available_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_create_abc">cpl_discord.events.on_guild_channel_create_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_delete_abc">cpl_discord.events.on_guild_channel_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_pins_update_abc">cpl_discord.events.on_guild_channel_pins_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_channel_update_abc">cpl_discord.events.on_guild_channel_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_emojis_update_abc">cpl_discord.events.on_guild_emojis_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_integrations_update_abc">cpl_discord.events.on_guild_integrations_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_join_abc">cpl_discord.events.on_guild_join_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_remove_abc">cpl_discord.events.on_guild_remove_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_create_abc">cpl_discord.events.on_guild_role_create_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_delete_abc">cpl_discord.events.on_guild_role_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_role_update_abc">cpl_discord.events.on_guild_role_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_unavailable_abc">cpl_discord.events.on_guild_unavailable_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_guild_update_abc">cpl_discord.events.on_guild_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_invite_create_abc">cpl_discord.events.on_invite_create_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_invite_delete_abc">cpl_discord.events.on_invite_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_ban_abc">cpl_discord.events.on_member_ban_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_join_abc">cpl_discord.events.on_member_join_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_remove_abc">cpl_discord.events.on_member_remove_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_unban_abc">cpl_discord.events.on_member_unban_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_member_update_abc">cpl_discord.events.on_member_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_abc">cpl_discord.events.on_message_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_delete_abc">cpl_discord.events.on_message_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_message_edit_abc">cpl_discord.events.on_message_edit_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_create_abc">cpl_discord.events.on_private_channel_create_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_delete_abc">cpl_discord.events.on_private_channel_delete_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_pins_update_abc">cpl_discord.events.on_private_channel_pins_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_private_channel_update_abc">cpl_discord.events.on_private_channel_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_add_abc">cpl_discord.events.on_raw_reaction_add_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_clear_abc">cpl_discord.events.on_raw_reaction_clear_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_clear_emoji_abc">cpl_discord.events.on_raw_reaction_clear_emoji_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_raw_reaction_remove_abc">cpl_discord.events.on_raw_reaction_remove_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_add_abc">cpl_discord.events.on_reaction_add_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_clear_abc">cpl_discord.events.on_reaction_clear_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_clear_emoji_abc">cpl_discord.events.on_reaction_clear_emoji_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_reaction_remove_abc">cpl_discord.events.on_reaction_remove_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_ready_abc">cpl_discord.events.on_ready_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_resume_abc">cpl_discord.events.on_resume_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_typing_abc">cpl_discord.events.on_typing_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_user_update_abc">cpl_discord.events.on_user_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_voice_state_update_abc">cpl_discord.events.on_voice_state_update_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html#module-cpl_discord.events.on_webhooks_update_abc">cpl_discord.events.on_webhooks_update_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html#module-cpl_discord.helper.to_containers_converter">cpl_discord.helper.to_containers_converter</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service</a><ul>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.command_error_handler_service">cpl_discord.service.command_error_handler_service</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_bot_service">cpl_discord.service.discord_bot_service</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_bot_service_abc">cpl_discord.service.discord_bot_service_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_collection">cpl_discord.service.discord_collection</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_collection_abc">cpl_discord.service.discord_collection_abc</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_service">cpl_discord.service.discord_service</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html#module-cpl_discord.service.discord_service_abc">cpl_discord.service.discord_service_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_core.utils.html" class="btn btn-neutral float-left" title="cpl_core.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_discord.application.html" class="btn btn-neutral float-right" title="cpl_discord.application" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
780
docs/build/html/cpl_discord.service.html
vendored
Normal file
780
docs/build/html/cpl_discord.service.html
vendored
Normal file
@ -0,0 +1,780 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_discord.service — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="Query reference" href="cpl_query.html" />
|
||||||
|
<link rel="prev" title="cpl_discord.helper" href="cpl_discord.helper.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_discord.html">Discord reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_discord.service</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.command_error_handler_service">cpl_discord.service.command_error_handler_service</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service">cpl_discord.service.discord_bot_service</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_bot_service_abc">cpl_discord.service.discord_bot_service_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection">cpl_discord.service.discord_collection</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_collection_abc">cpl_discord.service.discord_collection_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service">cpl_discord.service.discord_service</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_discord.service.discord_service_abc">cpl_discord.service.discord_service_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_discord.html">Discord reference</a> »</li>
|
||||||
|
<li>cpl_discord.service</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_discord.service.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-discord-service">
|
||||||
|
<h1>cpl_discord.service<a class="headerlink" href="#cpl-discord-service" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_discord.service.command_error_handler_service">
|
||||||
|
<span id="cpl-discord-service-command-error-handler-service"></span><h2>cpl_discord.service.command_error_handler_service<a class="headerlink" href="#module-cpl_discord.service.command_error_handler_service" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.command_error_handler_service.CommandErrorHandlerService">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.command_error_handler_service.</span></span><span class="sig-name descname"><span class="pre">CommandErrorHandlerService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.command_error_handler_service.CommandErrorHandlerService" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="cpl_discord.events.html#cpl_discord.events.on_command_error_abc.OnCommandErrorABC" title="cpl_discord.events.on_command_error_abc.OnCommandErrorABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OnCommandErrorABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.command_error_handler_service.CommandErrorHandlerService.on_command_error">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">CommandError</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.command_error_handler_service.CommandErrorHandlerService.on_command_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_bot_service">
|
||||||
|
<span id="cpl-discord-service-discord-bot-service"></span><h2>cpl_discord.service.discord_bot_service<a class="headerlink" href="#module-cpl_discord.service.discord_bot_service" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service.</span></span><span class="sig-name descname"><span class="pre">DiscordBotService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_abc.ConfigurationABC" title="cpl_core.configuration.configuration_abc.ConfigurationABC"><span class="pre">ConfigurationABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_bot_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_discord.configuration.html#cpl_discord.configuration.discord_bot_settings.DiscordBotSettings" title="cpl_discord.configuration.discord_bot_settings.DiscordBotSettings"><span class="pre">DiscordBotSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging_st</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logging_settings.LoggingSettings" title="cpl_core.logging.logging_settings.LoggingSettings"><span class="pre">LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">discord_service</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><span class="pre">DiscordServiceABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordBotServiceABC</span></code></a></p>
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.guilds">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">guilds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService.guilds" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sequence[<a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><code class="xref py py-class docutils literal notranslate"><span class="pre">Guild</span></code></a>]: The guilds that the connected client is a member of.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.on_ready">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService.on_ready" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.start_async">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService.start_async" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service.DiscordBotService.stop_async">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stop_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service.DiscordBotService.stop_async" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_bot_service_abc">
|
||||||
|
<span id="cpl-discord-service-discord-bot-service-abc"></span><h2>cpl_discord.service.discord_bot_service_abc<a class="headerlink" href="#module-cpl_discord.service.discord_bot_service_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_bot_service_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordBotServiceABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></p>
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.guilds">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">guilds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><span class="pre">Guild</span></a></em><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.guilds" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sequence[<a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild" title="cpl_discord.container.guild.Guild"><code class="xref py py-class docutils literal notranslate"><span class="pre">Guild</span></code></a>]: The guilds that the connected client is a member of.</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.on_ready">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.on_ready" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.start_async">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.start_async" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.stop_async">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stop_async</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_bot_service_abc.DiscordBotServiceABC.stop_async" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_collection">
|
||||||
|
<span id="cpl-discord-service-discord-collection"></span><h2>cpl_discord.service.discord_collection<a class="headerlink" href="#module-cpl_discord.service.discord_collection" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_collection.</span></span><span class="sig-name descname"><span class="pre">DiscordCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service_collection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC" title="cpl_discord.service.discord_collection_abc.DiscordCollectionABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordCollectionABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.add_command">
|
||||||
|
<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_discord.command.html#cpl_discord.command.discord_command_abc.DiscordCommandABC" title="cpl_discord.command.discord_command_abc.DiscordCommandABC"><span class="pre">DiscordCommandABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.add_command" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.add_event">
|
||||||
|
<span class="sig-name descname"><span class="pre">add_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.add_event" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.get_commands">
|
||||||
|
<span class="sig-name descname"><span class="pre">get_commands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_discord.command.html#cpl_discord.command.discord_command_abc.DiscordCommandABC" title="cpl_discord.command.discord_command_abc.DiscordCommandABC"><span class="pre">DiscordCommandABC</span></a></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_commands" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base">
|
||||||
|
<span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_query.extension.html#cpl_query.extension.list.List" title="cpl_query.extension.list.List"><span class="pre">List</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection.DiscordCollection.get_events_by_base" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_collection_abc">
|
||||||
|
<span id="cpl-discord-service-discord-collection-abc"></span><h2>cpl_discord.service.discord_collection_abc<a class="headerlink" href="#module-cpl_discord.service.discord_collection_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection_abc.DiscordCollectionABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_collection_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordCollectionABC</span></span><a class="headerlink" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_command">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_discord.command.html#cpl_discord.command.discord_command_abc.DiscordCommandABC" title="cpl_discord.command.discord_command_abc.DiscordCommandABC"><span class="pre">DiscordCommandABC</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_command" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_event">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC.add_event" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_commands">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_commands</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_discord.command.html#cpl_discord.command.discord_command_abc.DiscordCommandABC" title="cpl_discord.command.discord_command_abc.DiscordCommandABC"><span class="pre">DiscordCommandABC</span></a></span></span><a class="headerlink" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_commands" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_events_by_base">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_events_by_base</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t_event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_collection_abc.DiscordCollectionABC.get_events_by_base" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_service">
|
||||||
|
<span id="cpl-discord-service-discord-service"></span><h2>cpl_discord.service.discord_service<a class="headerlink" href="#module-cpl_discord.service.discord_service" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_service.</span></span><span class="sig-name descname"><span class="pre">DiscordService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="cpl_discord.service.discord_service_abc.DiscordServiceABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">DiscordServiceABC</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Cog</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.init">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Bot</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.init" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_bulk_message_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_bulk_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.message.Message</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_bulk_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_command">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_command" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_command_completion">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_completion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_command_completion" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_command_error">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">CommandError</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_command_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_connect">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_connect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_disconnect">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_disconnect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_disconnect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_error">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_group_join">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_group_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_group_remove">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_group_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_available">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_available" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_channel_create">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_channel_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_channel_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_emojis_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_emojis_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_emojis_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_integrations_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_integrations_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_integrations_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_join">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_remove">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_role_create">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_role_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_role_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_role_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_role_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_role_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_unavailable">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_unavailable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_guild_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_guild_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_invite_create">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_invite_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_invite_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_invite_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_member_ban">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_ban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_member_ban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_member_join">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_member_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_member_remove">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_member_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_member_unban">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_unban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_member_unban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_member_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_member_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_message">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_message" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_message_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_message_edit">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_edit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_message_edit" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_private_channel_create">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_private_channel_delete">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_private_channel_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_private_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_raw_reaction_add">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_raw_reaction_add" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear_emoji">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_clear_emoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_raw_reaction_clear_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_raw_reaction_remove">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_raw_reaction_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">payload</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RawReactionActionEvent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_raw_reaction_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_reaction_add">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_reaction_add" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_reaction_clear">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reactions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.reaction.Reaction</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_reaction_clear" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_reaction_clear_emoji">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear_emoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_reaction_clear_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_reaction_remove">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_reaction_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_ready">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_ready" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_resume">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_resume</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_resume" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_typing">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_typing" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_user_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_user_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_user_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_voice_state_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_voice_state_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_voice_state_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service.DiscordService.on_webhooks_update">
|
||||||
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_webhooks_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service.DiscordService.on_webhooks_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_discord.service.discord_service_abc">
|
||||||
|
<span id="cpl-discord-service-discord-service-abc"></span><h2>cpl_discord.service.discord_service_abc<a class="headerlink" href="#module-cpl_discord.service.discord_service_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.service.discord_service_abc.</span></span><span class="sig-name descname"><span class="pre">DiscordServiceABC</span></span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.init">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Bot</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.init" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_bulk_message_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_bulk_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">messages</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.message.Message</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_bulk_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_completion">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_completion</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_completion" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_error">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_command_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_command_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_connect">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_connect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_disconnect">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_disconnect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_disconnect" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_error">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_error" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chhanel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_group_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chhanel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_group_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_available">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_available" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_emojis_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_emojis_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Emoji</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_emojis_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_integrations_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_integrations_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_integrations_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_role_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Role</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_role_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_unavailable">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_unavailable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_guild_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_invite_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Invite</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_invite_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_ban">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_ban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_ban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_join">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_join</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_join" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_unban">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_unban</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_unban" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_member_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_member_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_edit">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_message_edit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_message_edit" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_create">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_create" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_delete">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_delete" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_pins_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PrivateChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_pin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_pins_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_private_channel_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GroupChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_private_channel_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_add">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_add" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reactions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">discord.reaction.Reaction</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear_emoji">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_clear_emoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_clear_emoji" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_remove">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_reaction_remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_reaction_remove" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_ready">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_ready</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_ready" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_resume">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_resume</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_resume" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Messageable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">User</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Member</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">when</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_typing" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_user_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_user_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">User</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_user_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_voice_state_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_voice_state_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">VoiceState</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_voice_state_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_discord.service.discord_service_abc.DiscordServiceABC.on_webhooks_update">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_webhooks_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GuildChannel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.service.discord_service_abc.DiscordServiceABC.on_webhooks_update" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_discord.helper.html" class="btn btn-neutral float-left" title="cpl_discord.helper" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_query.html" class="btn btn-neutral float-right" title="Query reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
725
docs/build/html/cpl_query.base.html
vendored
Normal file
725
docs/build/html/cpl_query.base.html
vendored
Normal file
@ -0,0 +1,725 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_query.base — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_query.enumerable" href="cpl_query.enumerable.html" />
|
||||||
|
<link rel="prev" title="Query reference" href="cpl_query.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.base</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence_abc">cpl_query.base.sequence_abc</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence_values">cpl_query.base.sequence_values</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_query.html">Query reference</a> »</li>
|
||||||
|
<li>cpl_query.base</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_query.base.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-query-base">
|
||||||
|
<h1>cpl_query.base<a class="headerlink" href="#cpl-query-base" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_query.base.default_lambda">
|
||||||
|
<span id="cpl-query-base-default-lambda"></span><h2>cpl_query.base.default_lambda<a class="headerlink" href="#module-cpl_query.base.default_lambda" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py function">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.default_lambda.default_lambda">
|
||||||
|
<span class="sig-prename descclassname"><span class="pre">cpl_query.base.default_lambda.</span></span><span class="sig-name descname"><span class="pre">default_lambda</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.default_lambda.default_lambda" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.base.ordered_queryable">
|
||||||
|
<span id="cpl-query-base-ordered-queryable"></span><h2>cpl_query.base.ordered_queryable<a class="headerlink" href="#module-cpl_query.base.ordered_queryable" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></p>
|
||||||
|
<p>Implementation of :class: <cite>cpl_query.extension.Iterable</cite> <cite>cpl_query.extension.OrderedIterableABC</cite></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by">
|
||||||
|
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending">
|
||||||
|
<span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.base.ordered_queryable_abc">
|
||||||
|
<span id="cpl-query-base-ordered-queryable-abc"></span><h2>cpl_query.base.ordered_queryable_abc<a class="headerlink" href="#module-cpl_query.base.ordered_queryable_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending">
|
||||||
|
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.iterable.ordered_iterable_abc.OrderedIterableABC</span></code></p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.base.queryable_abc">
|
||||||
|
<span id="cpl-query-base-queryable-abc"></span><h2>cpl_query.base.queryable_abc<a class="headerlink" href="#module-cpl_query.base.queryable_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.sequence_abc.SequenceABC" title="cpl_query.base.sequence_abc.SequenceABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">SequenceABC</span></code></a></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.all">
|
||||||
|
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Checks if every element of list equals result found by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>bool</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.any">
|
||||||
|
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Checks if list contains result found by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>bool</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.average">
|
||||||
|
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns average value of list</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Union[int, float, complex]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.contains">
|
||||||
|
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.contains" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Checks if list contains value given by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>value: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>bool</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.count">
|
||||||
|
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns length of list or count of found elements</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>int</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.distinct">
|
||||||
|
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns list without redundancies</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at">
|
||||||
|
<span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns element at given index</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Value at _index: any</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at_or_default">
|
||||||
|
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns element at given index or None</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Value at _index: Optional[any]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first">
|
||||||
|
<span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns first element</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>First element of list: any</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first_or_default">
|
||||||
|
<span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first_or_default" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns first element or None</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>First element of list: Optional[any]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.for_each">
|
||||||
|
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Runs given function for each element of list</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: :class: <cite>Callable</cite></dt><dd><p>function to call</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.group_by">
|
||||||
|
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Groups by func</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Grouped list[list[any]]: any</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last">
|
||||||
|
<span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns last element</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Last element of list: any</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last_or_default">
|
||||||
|
<span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last_or_default" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns last element or None</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Last element of list: Optional[any]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.max">
|
||||||
|
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns the highest value</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Union[int, float, complex]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.median">
|
||||||
|
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Return the median value of data elements</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Union[int, float]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.min">
|
||||||
|
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns the lowest value</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Union[int, float, complex]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by">
|
||||||
|
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts elements by function in ascending order</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by_descending">
|
||||||
|
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sorts elements by function in descending order</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.reverse">
|
||||||
|
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.reverse" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Reverses list</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select">
|
||||||
|
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Formats each element of list to a given format</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select_many">
|
||||||
|
<span class="sig-name descname"><span class="pre">select_many</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select_many" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Flattens resulting lists to one</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single">
|
||||||
|
<span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns one single element of list</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Found value: any</p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>ArgumentNoneException: when argument is None
|
||||||
|
Exception: when argument is None or found more than one element</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single_or_default">
|
||||||
|
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns one single element of list</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Found value: Optional[any]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip">
|
||||||
|
<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Skips all elements from index</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip_last">
|
||||||
|
<span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip_last" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Skips all elements after index</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.sum">
|
||||||
|
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Sum of all values</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Union[int, float, complex]</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take">
|
||||||
|
<span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Takes all elements from index</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take_last">
|
||||||
|
<span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take_last" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Takes all elements after index</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.where">
|
||||||
|
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Select element by function</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="simple">
|
||||||
|
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.base.sequence_abc">
|
||||||
|
<span id="cpl-query-base-sequence-abc"></span><h2>cpl_query.base.sequence_abc<a class="headerlink" href="#module-cpl_query.base.sequence_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence_abc.</span></span><span class="sig-name descname"><span class="pre">SequenceABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.copy">
|
||||||
|
<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence_abc.SequenceABC" title="cpl_query.base.sequence_abc.SequenceABC"><span class="pre">SequenceABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.copy" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Creates a copy of sequence</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>SequenceABC</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.empty">
|
||||||
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">empty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence_abc.SequenceABC" title="cpl_query.base.sequence_abc.SequenceABC"><span class="pre">SequenceABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.empty" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns an empty sequence</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Sequence object that contains no elements</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.index">
|
||||||
|
<span class="sig-name descname"><span class="pre">index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.index" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Returns the index of given element</p>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>Index of object</p>
|
||||||
|
</div></blockquote>
|
||||||
|
<blockquote>
|
||||||
|
<div><p>IndexError if object not in sequence</p>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.next">
|
||||||
|
<span class="sig-name descname"><span class="pre">next</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.next" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.range">
|
||||||
|
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence_abc.SequenceABC" title="cpl_query.base.sequence_abc.SequenceABC"><span class="pre">SequenceABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.range" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.to_list">
|
||||||
|
<span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.to_list" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Converts :class: <cite>cpl_query.base.sequence_abc.SequenceABC</cite> to :class: <cite>list</cite></p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>list</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py property">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_abc.SequenceABC.type">
|
||||||
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_query.base.sequence_abc.SequenceABC.type" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.base.sequence_values">
|
||||||
|
<span id="cpl-query-base-sequence-values"></span><h2>cpl_query.base.sequence_values<a class="headerlink" href="#module-cpl_query.base.sequence_values" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_values.SequenceValues">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence_values.</span></span><span class="sig-name descname"><span class="pre">SequenceValues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence_values.SequenceValues" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_values.SequenceValues.next">
|
||||||
|
<span class="sig-name descname"><span class="pre">next</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence_values.SequenceValues.next" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.base.sequence_values.SequenceValues.reset">
|
||||||
|
<span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.base.sequence_values.SequenceValues.reset" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd></dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_query.html" class="btn btn-neutral float-left" title="Query reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_query.enumerable.html" class="btn btn-neutral float-right" title="cpl_query.enumerable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
161
docs/build/html/cpl_query.enumerable.html
vendored
Normal file
161
docs/build/html/cpl_query.enumerable.html
vendored
Normal file
@ -0,0 +1,161 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html class="writer-html5" lang="en" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>cpl_query.enumerable — Common Python Library documentation</title>
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="_static/js/html5shiv.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/js/theme.js"></script>
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
<link rel="next" title="cpl_query.extension" href="cpl_query.extension.html" />
|
||||||
|
<link rel="prev" title="cpl_query.base" href="cpl_query.base.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" >
|
||||||
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||||
|
</a>
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" placeholder="Search docs" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||||
|
<ul class="current">
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base</a></li>
|
||||||
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.enumerable</a><ul>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable">cpl_query.enumerable.enumerable</a></li>
|
||||||
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="index.html">Common Python Library</a>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
<div class="rst-content">
|
||||||
|
<div role="navigation" aria-label="Page navigation">
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
|
<li><a href="cpl_query.html">Query reference</a> »</li>
|
||||||
|
<li>cpl_query.enumerable</li>
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
<a href="_sources/cpl_query.enumerable.rst.txt" rel="nofollow"> View page source</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
|
||||||
|
<section id="cpl-query-enumerable">
|
||||||
|
<h1>cpl_query.enumerable<a class="headerlink" href="#cpl-query-enumerable" title="Permalink to this heading"></a></h1>
|
||||||
|
<section id="module-cpl_query.enumerable.enumerable">
|
||||||
|
<span id="cpl-query-enumerable-enumerable"></span><h2>cpl_query.enumerable.enumerable<a class="headerlink" href="#module-cpl_query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable.Enumerable">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
|
||||||
|
<p>Implementation of :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<section id="module-cpl_query.enumerable.enumerable_abc">
|
||||||
|
<span id="cpl-query-enumerable-enumerable-abc"></span><h2>cpl_query.enumerable.enumerable_abc<a class="headerlink" href="#module-cpl_query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
|
||||||
|
<dl class="py class">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC">
|
||||||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
|
||||||
|
<p>ABC to define functions on list</p>
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC.set_remove_error_check">
|
||||||
|
<span class="sig-name descname"><span class="pre">set_remove_error_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC.set_remove_error_check" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Set flag to check if element exists before removing</p>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="py method">
|
||||||
|
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable">
|
||||||
|
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable" title="Permalink to this definition"></a></dt>
|
||||||
|
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||||
|
<blockquote>
|
||||||
|
<div><dl class="field-list simple">
|
||||||
|
<dt class="field-odd">class</dt>
|
||||||
|
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div></blockquote>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
|
<a href="cpl_query.base.html" class="btn btn-neutral float-left" title="cpl_query.base" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
|
<a href="cpl_query.extension.html" class="btn btn-neutral float-right" title="cpl_query.extension" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</div>
|
||||||
|
<script>
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable(true);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
178
docs/build/html/cpl_query.exceptions.html
vendored
178
docs/build/html/cpl_query.exceptions.html
vendored
@ -1,178 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html class="writer-html5" lang="en" >
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
||||||
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>cpl_query.exceptions — Common Python Library documentation</title>
|
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
||||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
||||||
<!--[if lt IE 9]>
|
|
||||||
<script src="_static/js/html5shiv.min.js"></script>
|
|
||||||
<![endif]-->
|
|
||||||
|
|
||||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
||||||
<script src="_static/jquery.js"></script>
|
|
||||||
<script src="_static/underscore.js"></script>
|
|
||||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
||||||
<script src="_static/doctools.js"></script>
|
|
||||||
<script src="_static/js/theme.js"></script>
|
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
|
||||||
<link rel="search" title="Search" href="search.html" />
|
|
||||||
<link rel="prev" title="cpl_query.extension" href="cpl_query.extension.html" />
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
|
||||||
<div class="wy-grid-for-nav">
|
|
||||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
||||||
<div class="wy-side-scroll">
|
|
||||||
<div class="wy-side-nav-search" >
|
|
||||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
|
||||||
</a>
|
|
||||||
<div role="search">
|
|
||||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
||||||
<input type="text" name="q" placeholder="Search docs" />
|
|
||||||
<input type="hidden" name="check_keywords" value="yes" />
|
|
||||||
<input type="hidden" name="area" value="default" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
||||||
<ul class="current">
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query Reference</a><ul class="current">
|
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension</a></li>
|
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.exceptions</a><ul>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#id1">cpl_query.exceptions</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
||||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
||||||
<a href="index.html">Common Python Library</a>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
<div class="wy-nav-content">
|
|
||||||
<div class="rst-content">
|
|
||||||
<div role="navigation" aria-label="Page navigation">
|
|
||||||
<ul class="wy-breadcrumbs">
|
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|
||||||
<li><a href="cpl_query.html">Query Reference</a> »</li>
|
|
||||||
<li>cpl_query.exceptions</li>
|
|
||||||
<li class="wy-breadcrumbs-aside">
|
|
||||||
<a href="_sources/cpl_query.exceptions.rst.txt" rel="nofollow"> View page source</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<hr/>
|
|
||||||
</div>
|
|
||||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
||||||
<div itemprop="articleBody">
|
|
||||||
|
|
||||||
<section id="cpl-query-exceptions">
|
|
||||||
<h1>cpl_query.exceptions<a class="headerlink" href="#cpl-query-exceptions" title="Permalink to this heading"></a></h1>
|
|
||||||
<section id="id1">
|
|
||||||
<h2>cpl_query.exceptions<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
|
|
||||||
<span class="target" id="module-cpl_query.exceptions"></span><dl class="py exception">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ArgumentNoneException">
|
|
||||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.exceptions.</span></span><span class="sig-name descname"><span class="pre">ArgumentNoneException</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_query.exceptions.ExceptionArgument" title="cpl_query.exceptions.ExceptionArgument"><span class="pre">ExceptionArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.exceptions.ArgumentNoneException" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
|
||||||
<p>Exception when argument is None</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.exceptions.</span></span><span class="sig-name descname"><span class="pre">ExceptionArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|
||||||
<p>An enumeration.</p>
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument.func">
|
|
||||||
<span class="sig-name descname"><span class="pre">func</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'func'</span></em><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument.func" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument.index">
|
|
||||||
<span class="sig-name descname"><span class="pre">index</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'index'</span></em><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument.index" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument.list">
|
|
||||||
<span class="sig-name descname"><span class="pre">list</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'list'</span></em><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument.list" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument.type">
|
|
||||||
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'type'</span></em><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument.type" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py attribute">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.ExceptionArgument.value">
|
|
||||||
<span class="sig-name descname"><span class="pre">value</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'value'</span></em><a class="headerlink" href="#cpl_query.exceptions.ExceptionArgument.value" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py exception">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.IndexOutOfRangeException">
|
|
||||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.exceptions.</span></span><span class="sig-name descname"><span class="pre">IndexOutOfRangeException</span></span><a class="headerlink" href="#cpl_query.exceptions.IndexOutOfRangeException" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
|
||||||
<p>Exception when index is out of range</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py exception">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.InvalidTypeException">
|
|
||||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.exceptions.</span></span><span class="sig-name descname"><span class="pre">InvalidTypeException</span></span><a class="headerlink" href="#cpl_query.exceptions.InvalidTypeException" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
|
||||||
<p>Exception when type is invalid</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py exception">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.exceptions.WrongTypeException">
|
|
||||||
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.exceptions.</span></span><span class="sig-name descname"><span class="pre">WrongTypeException</span></span><a class="headerlink" href="#cpl_query.exceptions.WrongTypeException" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
|
||||||
<p>Exception when type is unexpected</p>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
||||||
<a href="cpl_query.extension.html" class="btn btn-neutral float-left" title="cpl_query.extension" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<hr/>
|
|
||||||
|
|
||||||
<div role="contentinfo">
|
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
||||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
||||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
||||||
|
|
||||||
|
|
||||||
</footer>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
jQuery(function () {
|
|
||||||
SphinxRtdTheme.Navigation.enable(true);
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
936
docs/build/html/cpl_query.extension.html
vendored
936
docs/build/html/cpl_query.extension.html
vendored
@ -19,8 +19,8 @@
|
|||||||
<script src="_static/js/theme.js"></script>
|
<script src="_static/js/theme.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="cpl_query.exceptions" href="cpl_query.exceptions.html" />
|
<link rel="next" title="cpl_query.iterable" href="cpl_query.iterable.html" />
|
||||||
<link rel="prev" title="Query Reference" href="cpl_query.html" />
|
<link rel="prev" title="cpl_query.enumerable" href="cpl_query.enumerable.html" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body class="wy-body-for-nav">
|
<body class="wy-body-for-nav">
|
||||||
@ -42,20 +42,20 @@
|
|||||||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query Reference</a><ul class="current">
|
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||||
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base</a></li>
|
||||||
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable</a></li>
|
||||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.extension</a><ul>
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.extension</a><ul>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.iterable_abc">cpl_query.extension.iterable_abc</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.iterable">cpl_query.extension.iterable</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.list">cpl_query.extension.list</a></li>
|
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.list">cpl_query.extension.list</a></li>
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.ordered_iterable_abc">cpl_query.extension.ordered_iterable_abc</a></li>
|
|
||||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.extension.ordered_iterable">cpl_query.extension.ordered_iterable</a></li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.exceptions.html">cpl_query.exceptions</a></li>
|
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@ -72,7 +72,7 @@
|
|||||||
<div role="navigation" aria-label="Page navigation">
|
<div role="navigation" aria-label="Page navigation">
|
||||||
<ul class="wy-breadcrumbs">
|
<ul class="wy-breadcrumbs">
|
||||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||||
<li><a href="cpl_query.html">Query Reference</a> »</li>
|
<li><a href="cpl_query.html">Query reference</a> »</li>
|
||||||
<li>cpl_query.extension</li>
|
<li>cpl_query.extension</li>
|
||||||
<li class="wy-breadcrumbs-aside">
|
<li class="wy-breadcrumbs-aside">
|
||||||
<a href="_sources/cpl_query.extension.rst.txt" rel="nofollow"> View page source</a>
|
<a href="_sources/cpl_query.extension.rst.txt" rel="nofollow"> View page source</a>
|
||||||
@ -85,908 +85,36 @@
|
|||||||
|
|
||||||
<section id="cpl-query-extension">
|
<section id="cpl-query-extension">
|
||||||
<h1>cpl_query.extension<a class="headerlink" href="#cpl-query-extension" title="Permalink to this heading"></a></h1>
|
<h1>cpl_query.extension<a class="headerlink" href="#cpl-query-extension" title="Permalink to this heading"></a></h1>
|
||||||
<section id="module-cpl_query.extension.iterable_abc">
|
|
||||||
<span id="cpl-query-extension-iterable-abc"></span><h2>cpl_query.extension.iterable_abc<a class="headerlink" href="#module-cpl_query.extension.iterable_abc" title="Permalink to this heading"></a></h2>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
|
|
||||||
<p>ABC to define functions on list</p>
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.all">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.all" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if every element of list equals result found by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.any">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if list contains result found by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.append">
|
|
||||||
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.append" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Adds element to list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>__object: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.average">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.average" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns average value of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.contains">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.contains" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if list contains value given by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>value: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.count">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.count" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns length of list or count of found elements</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>int</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.distinct">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.distinct" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns list without redundancies</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.element_at">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns element at given index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Value at index: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.element_at_or_default">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns element at given index or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Value at index: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.extend">
|
|
||||||
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.extend" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Adds elements of given list to list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>__iterable: :class: <cite>cpl_query.extension.iterable.Iterable</cite></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.first">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns first element</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>First element of list: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.first_or_default">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns first element or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>First element of list: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.for_each">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.for_each" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Runs given function for each element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: :class: <cite>Callable</cite></dt><dd><p>function to call</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.last">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns last element</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Last element of list: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.last_or_default">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns last element or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Last element of list: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.max">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.max" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns highest value</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.min">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.min" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns highest value</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.order_by">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts elements by function in ascending order</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.order_by_descending">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by_descending" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts elements by function in descending order</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.reverse">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.reverse" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Reverses list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.single">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns one single element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Found value: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>ArgumentNoneException: when argument is None
|
|
||||||
Exception: when argument is None or found more than one element</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.single_or_default">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns one single element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Found value: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.skip">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Skips all elements from index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.skip_last">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip_last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Skips all elements after index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.sum">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.sum" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sum of all values</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.take">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Takes all elements from index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.take_last">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take_last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Takes all elements after index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.to_list">
|
|
||||||
<span class="sig-name descname"><span class="pre">to_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.to_list" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Converts :class: <cite>cpl_query.extension.iterable_abc.IterableABC</cite> to :class: <cite>list</cite></p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>list</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py property">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.type">
|
|
||||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.type" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd></dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.where">
|
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.where" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Select element by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_query.extension.iterable">
|
|
||||||
<span id="cpl-query-extension-iterable"></span><h2>cpl_query.extension.iterable<a class="headerlink" href="#module-cpl_query.extension.iterable" title="Permalink to this heading"></a></h2>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.all">
|
|
||||||
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.all" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if every element of list equals result found by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.any">
|
|
||||||
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.any" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if list contains result found by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.average">
|
|
||||||
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.average" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns average value of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.contains">
|
|
||||||
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.contains" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Checks if list contains value given by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>value: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>bool</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.count">
|
|
||||||
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.count" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns length of list or count of found elements</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>int</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.distinct">
|
|
||||||
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.distinct" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns list without redundancies</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.element_at">
|
|
||||||
<span class="sig-name descname"><span class="pre">element_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns element at given index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Value at index: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.element_at_or_default">
|
|
||||||
<span class="sig-name descname"><span class="pre">element_at_or_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns element at given index or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Value at index: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.first">
|
|
||||||
<span class="sig-name descname"><span class="pre">first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns first element</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>First element of list: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.first_or_default">
|
|
||||||
<span class="sig-name descname"><span class="pre">first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns first element or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>First element of list: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.for_each">
|
|
||||||
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.for_each" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Runs given function for each element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: :class: <cite>Callable</cite></dt><dd><p>function to call</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.last">
|
|
||||||
<span class="sig-name descname"><span class="pre">last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns last element</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Last element of list: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.last_or_default">
|
|
||||||
<span class="sig-name descname"><span class="pre">last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns last element or None</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Last element of list: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.max">
|
|
||||||
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.max" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns highest value</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.min">
|
|
||||||
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.min" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns highest value</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.order_by">
|
|
||||||
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts elements by function in ascending order</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.order_by_descending">
|
|
||||||
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by_descending" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts elements by function in descending order</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.reverse">
|
|
||||||
<span class="sig-name descname"><span class="pre">reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.reverse" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Reverses list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.single">
|
|
||||||
<span class="sig-name descname"><span class="pre">single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns one single element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Found value: any</p>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>ArgumentNoneException: when argument is None
|
|
||||||
Exception: when argument is None or found more than one element</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.single_or_default">
|
|
||||||
<span class="sig-name descname"><span class="pre">single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single_or_default" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Returns one single element of list</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Found value: Optional[any]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.skip">
|
|
||||||
<span class="sig-name descname"><span class="pre">skip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Skips all elements from index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.skip_last">
|
|
||||||
<span class="sig-name descname"><span class="pre">skip_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip_last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Skips all elements after index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.sum">
|
|
||||||
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.sum" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sum of all values</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>Union[int, float, complex]</p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.take">
|
|
||||||
<span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Takes all elements from index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.take_last">
|
|
||||||
<span class="sig-name descname"><span class="pre">take_last</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take_last" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Takes all elements after index</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.where">
|
|
||||||
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.where" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Select element by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="simple">
|
|
||||||
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><dl class="field-list simple">
|
|
||||||
<dt class="field-odd">class</dt>
|
|
||||||
<dd class="field-odd"><p><cite>cpl_query.extension.iterable_abc.IterableABC</cite></p>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_query.extension.list">
|
<section id="module-cpl_query.extension.list">
|
||||||
<span id="cpl-query-extension-list"></span><h2>cpl_query.extension.list<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this heading"></a></h2>
|
<span id="cpl-query-extension-list"></span><h2>cpl_query.extension.list<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this heading"></a></h2>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.list.List">
|
<dt class="sig sig-object py" id="cpl_query.extension.list.List">
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
|
<dd><p>Bases: <a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
|
||||||
<p>Implementation of :class: <cite>cpl_query.extension.iterable.Iterable</cite></p>
|
<p>Implementation of :class: <cite>cpl_query.extension.iterable.Iterable</cite></p>
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_query.extension.ordered_iterable_abc">
|
|
||||||
<span id="cpl-query-extension-ordered-iterable-abc"></span><h2>cpl_query.extension.ordered_iterable_abc<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable_abc" title="Permalink to this heading"></a></h2>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedIterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by">
|
<dt class="sig sig-object py" id="cpl_query.extension.list.List.to_enumerable">
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.list.List.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
<div><dl class="field-list simple">
|
||||||
</div></blockquote>
|
<dt class="field-odd">class</dt>
|
||||||
<blockquote>
|
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||||
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.OrderedIterableABC</span></code></p>
|
</dd>
|
||||||
|
</dl>
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="py method">
|
<dl class="py method">
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by_descending">
|
<dt class="sig sig-object py" id="cpl_query.extension.list.List.to_iterable">
|
||||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by_descending" title="Permalink to this definition"></a></dt>
|
<span class="sig-name descname"><span class="pre">to_iterable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.list.List.to_iterable" title="Permalink to this definition"></a></dt>
|
||||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
<div><dl class="field-list simple">
|
||||||
</div></blockquote>
|
<dt class="field-odd">class</dt>
|
||||||
<blockquote>
|
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
|
||||||
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.OrderedIterableABC</span></code></p>
|
</dd>
|
||||||
</div></blockquote>
|
</dl>
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
</section>
|
|
||||||
<section id="module-cpl_query.extension.ordered_iterable">
|
|
||||||
<span id="cpl-query-extension-ordered-iterable"></span><h2>cpl_query.extension.ordered_iterable<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable" title="Permalink to this heading"></a></h2>
|
|
||||||
<dl class="py class">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable">
|
|
||||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable.</span></span><span class="sig-name descname"><span class="pre">OrderedIterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>, <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedIterableABC</span></code></a></p>
|
|
||||||
<p>Implementation of :class: <cite>cpl_query.extension.Iterable</cite> <cite>cpl_query.extension.OrderedIterableABC</cite></p>
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable.then_by">
|
|
||||||
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.OrderedIterableABC</span></code></p>
|
|
||||||
</div></blockquote>
|
|
||||||
</dd></dl>
|
|
||||||
|
|
||||||
<dl class="py method">
|
|
||||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable.then_by_descending">
|
|
||||||
<span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by_descending" title="Permalink to this definition"></a></dt>
|
|
||||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
|
||||||
</div></blockquote>
|
|
||||||
<blockquote>
|
|
||||||
<div><p>list of <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.OrderedIterableABC</span></code></p>
|
|
||||||
</div></blockquote>
|
</div></blockquote>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
@ -999,14 +127,14 @@ Exception: when argument is None or found more than one element</p>
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||||
<a href="cpl_query.html" class="btn btn-neutral float-left" title="Query Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
<a href="cpl_query.enumerable.html" class="btn btn-neutral float-left" title="cpl_query.enumerable" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||||
<a href="cpl_query.exceptions.html" class="btn btn-neutral float-right" title="cpl_query.exceptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
<a href="cpl_query.iterable.html" class="btn btn-neutral float-right" title="cpl_query.iterable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<div role="contentinfo">
|
<div role="contentinfo">
|
||||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user