From bea01f55a87a9f5c523ed9419419187a70798cf4 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Tue, 18 Feb 2025 19:41:52 +0000 Subject: Deploying to docs from @ python-discord/bot-core@16835478af6b842d776d634e53aab8ee31bd350c 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v10.7.0/output/pydis_core.utils.pagination.html | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'v10.7.0/output/pydis_core.utils.pagination.html') diff --git a/v10.7.0/output/pydis_core.utils.pagination.html b/v10.7.0/output/pydis_core.utils.pagination.html index 58ac6d53..c9ceb084 100644 --- a/v10.7.0/output/pydis_core.utils.pagination.html +++ b/v10.7.0/output/pydis_core.utils.pagination.html @@ -7,12 +7,12 @@ pagination - Pydis Core v10.7.0 - + - - + + @@ -468,7 +468,7 @@
class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
-

Bases: Paginator

+

Bases: Paginator

A class that aids in paginating code blocks for Discord messages.

Parameters:
@@ -532,15 +532,15 @@ to any user with a moderation role.

  • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

  • lines (list[str]) – A list of lines to be added to the paginated content.

    • -

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • -

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • +

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • +

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

  • prefix (str) – The prefix inserted to every page. e.g. three backticks.

  • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

  • max_lines (int) – The maximum amount of lines allowed in a page.

  • max_size (int) – The maximum amount of codepoints allowed in a page.

  • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

  • empty (bool) – Indicates whether an empty line should be added to each provided line.

    • -

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • +

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

  • timeout (int) – The timeout after which users cannot change pages anymore.

  • footer_text (str) – Text to be added as a footer for each page.

  • url (str) – The url to be set for the pagination embed.

    • @@ -550,7 +550,7 @@ to any user with a moderation role.

Return type:
-

Message | None

+

Message | None

Example: @@ -592,7 +592,7 @@ to any user with a moderation role.

-__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'pydis_core.utils.pagination.PaginationEmojis'>, 'config': {'title': 'PaginationEmojis'}, 'custom_init': False, 'metadata': {'pydantic_js_functions': [<bound method BaseModel.__get_pydantic_json_schema__ of <class 'pydis_core.utils.pagination.PaginationEmojis'>>]}, 'ref': 'pydis_core.utils.pagination.PaginationEmojis:94546162203648', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'delete': {'metadata': {}, 'schema': {'default': '<:trashcan:637136429717389331>', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'first': {'metadata': {}, 'schema': {'default': '⏮', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'last': {'metadata': {}, 'schema': {'default': '⏭', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'left': {'metadata': {}, 'schema': {'default': '⬅', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'right': {'metadata': {}, 'schema': {'default': '➡', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'PaginationEmojis', 'type': 'model-fields'}, 'type': 'model'}
+__pydantic_core_schema__: ClassVar[CoreSchema] = {'cls': <class 'pydis_core.utils.pagination.PaginationEmojis'>, 'config': {'title': 'PaginationEmojis'}, 'custom_init': False, 'metadata': {'pydantic_js_functions': [<bound method BaseModel.__get_pydantic_json_schema__ of <class 'pydis_core.utils.pagination.PaginationEmojis'>>]}, 'ref': 'pydis_core.utils.pagination.PaginationEmojis:94303830194896', 'root_model': False, 'schema': {'computed_fields': [], 'fields': {'delete': {'metadata': {}, 'schema': {'default': '<:trashcan:637136429717389331>', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'first': {'metadata': {}, 'schema': {'default': '⏮', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'last': {'metadata': {}, 'schema': {'default': '⏭', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'left': {'metadata': {}, 'schema': {'default': '⬅', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}, 'right': {'metadata': {}, 'schema': {'default': '➡', 'schema': {'type': 'str'}, 'type': 'default'}, 'type': 'model-field'}}, 'model_name': 'PaginationEmojis', 'type': 'model-fields'}, 'type': 'model'}

The core schema of the model.

@@ -655,13 +655,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b
-__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model(     ModelSerializer {         class: Py(             0x000055fd3e69bc00,         ),         serializer: Fields(             GeneralFieldsSerializer {                 fields: {                     "first": SerField {                         key_py: Py(                             0x00007fb5d15f47f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb5cccf7e60,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "last": SerField {                         key_py: Py(                             0x00007fb5d15d2170,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb5cccf7f00,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "delete": SerField {                         key_py: Py(                             0x00007fb5d1960eb0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb5cccf7f50,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "right": SerField {                         key_py: Py(                             0x00007fb5d15797b0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb5cccf7eb0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "left": SerField {                         key_py: Py(                             0x00007fb5d15797f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb5cccf7e10,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                 },                 computed_fields: Some(                     ComputedFields(                         [],                     ),                 ),                 mode: SimpleDict,                 extra_serializer: None,                 filter: SchemaFilter {                     include: None,                     exclude: None,                 },                 required_fields: 5,             },         ),         has_extra: false,         root_model: false,         name: "PaginationEmojis",     }, ), definitions=[])
+__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model(     ModelSerializer {         class: Py(             0x000055c4d24cbad0,         ),         serializer: Fields(             GeneralFieldsSerializer {                 fields: {                     "first": SerField {                         key_py: Py(                             0x00007fe3eedeb2f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fe3e9f6c120,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "left": SerField {                         key_py: Py(                             0x00007fe3eed7c230,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fe3e9f6c0d0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "delete": SerField {                         key_py: Py(                             0x00007fe3ef078eb0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fe3e9f6c210,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "right": SerField {                         key_py: Py(                             0x00007fe3eed7c1f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fe3e9f6c170,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "last": SerField {                         key_py: Py(                             0x00007fe3eedccd30,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fe3e9f6c1c0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                 },                 computed_fields: Some(                     ComputedFields(                         [],                     ),                 ),                 mode: SimpleDict,                 extra_serializer: None,                 filter: SchemaFilter {                     include: None,                     exclude: None,                 },                 required_fields: 5,             },         ),         has_extra: false,         root_model: false,         name: "PaginationEmojis",     }, ), definitions=[])

The pydantic-core SchemaSerializer used to dump instances of the model.

-__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="PaginationEmojis", validator=Model(     ModelValidator {         revalidate: Never,         validator: ModelFields(             ModelFieldsValidator {                 fields: [                     Field {                         name: "first",                         lookup_key: Simple {                             key: "first",                             py_key: Py(                                 0x00007fb5ce86d530,                             ),                             path: LookupPath(                                 [                                     S(                                         "first",                                         Py(                                             0x00007fb5cd596730,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb5d15f47f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb5cccf7e60,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb5d01463c0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "left",                         lookup_key: Simple {                             key: "left",                             py_key: Py(                                 0x00007fb5cd596ab0,                             ),                             path: LookupPath(                                 [                                     S(                                         "left",                                         Py(                                             0x00007fb5c7c357b0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb5d15797f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb5cccf7e10,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb5d01463c0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "right",                         lookup_key: Simple {                             key: "right",                             py_key: Py(                                 0x00007fb5c7c379b0,                             ),                             path: LookupPath(                                 [                                     S(                                         "right",                                         Py(                                             0x00007fb5c7c356b0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb5d15797b0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb5cccf7eb0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb5d01463c0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "last",                         lookup_key: Simple {                             key: "last",                             py_key: Py(                                 0x00007fb5c7c37f30,                             ),                             path: LookupPath(                                 [                                     S(                                         "last",                                         Py(                                             0x00007fb5c7c37fb0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb5d15d2170,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb5cccf7f00,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb5d01463c0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "delete",                         lookup_key: Simple {                             key: "delete",                             py_key: Py(                                 0x00007fb5c7c35ab0,                             ),                             path: LookupPath(                                 [                                     S(                                         "delete",                                         Py(                                             0x00007fb5c7c358b0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb5d1960eb0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb5cccf7f50,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb5d01463c0,                                 ),                             },                         ),                         frozen: false,                     },                 ],                 model_name: "PaginationEmojis",                 extra_behavior: Ignore,                 extras_validator: None,                 strict: false,                 from_attributes: false,                 loc_by_alias: true,             },         ),         class: Py(             0x000055fd3e69bc00,         ),         generic_origin: None,         post_init: None,         frozen: false,         custom_init: false,         root_model: false,         undefined: Py(             0x00007fb5d01463c0,         ),         name: "PaginationEmojis",     }, ), definitions=[], cache_strings=True)
+__pydantic_validator__: ClassVar[SchemaValidator | PluggableSchemaValidator] = SchemaValidator(title="PaginationEmojis", validator=Model(     ModelValidator {         revalidate: Never,         validator: ModelFields(             ModelFieldsValidator {                 fields: [                     Field {                         name: "first",                         lookup_key: Simple {                             key: "first",                             py_key: Py(                                 0x00007fe3e3fc1cb0,                             ),                             path: LookupPath(                                 [                                     S(                                         "first",                                         Py(                                             0x00007fe3ea5dfaf0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fe3eedeb2f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fe3e9f6c120,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fe3ed4ea390,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "left",                         lookup_key: Simple {                             key: "left",                             py_key: Py(                                 0x00007fe3ea5dfb70,                             ),                             path: LookupPath(                                 [                                     S(                                         "left",                                         Py(                                             0x00007fe3ebb6e330,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fe3eed7c230,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fe3e9f6c0d0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fe3ed4ea390,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "right",                         lookup_key: Simple {                             key: "right",                             py_key: Py(                                 0x00007fe3ea649cb0,                             ),                             path: LookupPath(                                 [                                     S(                                         "right",                                         Py(                                             0x00007fe3e94622f0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fe3eed7c1f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fe3e9f6c170,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fe3ed4ea390,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "last",                         lookup_key: Simple {                             key: "last",                             py_key: Py(                                 0x00007fe3e94619b0,                             ),                             path: LookupPath(                                 [                                     S(                                         "last",                                         Py(                                             0x00007fe3e9463fb0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fe3eedccd30,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fe3e9f6c1c0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fe3ed4ea390,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "delete",                         lookup_key: Simple {                             key: "delete",                             py_key: Py(                                 0x00007fe3e9461a70,                             ),                             path: LookupPath(                                 [                                     S(                                         "delete",                                         Py(                                             0x00007fe3e9462370,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fe3ef078eb0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fe3e9f6c210,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fe3ed4ea390,                                 ),                             },                         ),                         frozen: false,                     },                 ],                 model_name: "PaginationEmojis",                 extra_behavior: Ignore,                 extras_validator: None,                 strict: false,                 from_attributes: false,                 loc_by_alias: true,             },         ),         class: Py(             0x000055c4d24cbad0,         ),         generic_origin: None,         post_init: None,         frozen: false,         custom_init: false,         root_model: false,         undefined: Py(             0x00007fe3ed4ea390,         ),         name: "PaginationEmojis",     }, ), definitions=[], cache_strings=True)

The pydantic-core SchemaValidator used to validate instances of the model.

-- cgit v1.2.3