.. currentmodule:: jishaku

jishaku as an API
=================

jishaku contains numerous internal classes and functions it uses to facilitate
both the commands in the `cog <cog.html>`_ and miscellaneous parts of bot development.

You can use almost all of these for your own use, but be aware that the internals
of jishaku, and how they work, are subject to change.

Most of the content in this document is autogenerated.

REPL-related classes and functions
----------------------------------

.. currentmodule:: jishaku.repl.scope

.. autoclass:: Scope
    :members:

.. autofunction:: get_parent_scope_from_var

.. autofunction:: get_parent_var

.. currentmodule:: jishaku.repl.compilation

.. autoclass:: AsyncCodeExecutor
    :members:

.. currentmodule:: jishaku.shell

.. autoclass:: ShellReader
    :members:

Function-related tools
-----------------------

.. currentmodule:: jishaku.functools

.. autofunction:: executor_function


Paginator-related tools
-----------------------

.. currentmodule:: jishaku.paginators

.. autoclass:: PaginatorInterface
    :members:

.. autoclass:: PaginatorEmbedInterface
    :members:

.. autoclass:: FilePaginator
    :members:

.. autoclass:: WrappedPaginator
    :members:

Help command classes
--------------------

These are classes you can use, or subclass yourself, for help commands.

You can use them like this:

.. code:: python3

    from discord.ext import commands

    from jishaku.help_command import MinimalPaginatorHelp

    bot = commands.Bot('?', help_command=MinimalPaginatorHelp())

.. currentmodule:: jishaku.help_command

.. autoclass:: DefaultPaginatorHelp
    :members:

.. autoclass:: DefaultEmbedPaginatorHelp
    :members:

.. autoclass:: MinimalPaginatorHelp
    :members:

.. autoclass:: MinimalEmbedPaginatorHelp
    :members: