From cf16350107a4ffd6a48d258a47fffc0733c138b2 Mon Sep 17 00:00:00 2001 From: jb3 Date: Fri, 17 Oct 2025 18:04:11 +0000 Subject: Deploying to docs from @ python-discord/bot-core@9f0162c0869ee8e0ae158636c8f0eac96159a675 ๐Ÿš€ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v11.0.0/output/pydis_core.utils.pagination.html | 64 ++++++++++++------------- 1 file changed, 32 insertions(+), 32 deletions(-) (limited to 'v11.0.0/output/pydis_core.utils.pagination.html') diff --git a/v11.0.0/output/pydis_core.utils.pagination.html b/v11.0.0/output/pydis_core.utils.pagination.html index c05fb505..3a73f3db 100644 --- a/v11.0.0/output/pydis_core.utils.pagination.html +++ b/v11.0.0/output/pydis_core.utils.pagination.html @@ -10,8 +10,8 @@ - + @@ -480,24 +480,24 @@
exception EmptyPaginatorEmbedError[source]ยถ
-

Bases: Exception

+

Bases: Exception

Raised when attempting to paginate with empty contents.

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:

  • pagination_emojis (PaginationEmojis) โ€“ The emojis used to navigate pages.

    • -

  • 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_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.

    • -

  • max_lines (int) โ€“ The maximum amount of lines allowed in a 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_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.

    • +

  • max_lines (int) โ€“ The maximum amount of lines allowed in a page.

@@ -526,12 +526,12 @@ page at a reasonable size.

Parameters:
    -

  • line (str) โ€“ The line to add to the paginated content.

    • -

  • empty (bool) โ€“ Indicates whether an empty line should be added at the end.

    • +

  • line (str) โ€“ The line to add to the paginated content.

    • +

  • empty (bool) โ€“ Indicates whether an empty line should be added at the end.

Return type:
-

None

+

None

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

Parameters:
Return type:
-

Message | None

+

Message | None

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

class PaginationEmojis(**data)[source]ยถ
-

Bases: BaseModel

+

Bases: BaseModel

The emojis that will be used for pagination.

@@ -611,7 +611,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:93951115501776', '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:94777189274352', '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.

@@ -674,13 +674,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b
-__pydantic_serializer__: ClassVar[SchemaSerializer] = SchemaSerializer(serializer=Model(     ModelSerializer {         class: Py(             0x00005572b2dda0d0,         ),         serializer: Fields(             GeneralFieldsSerializer {                 fields: {                     "left": SerField {                         key_py: Py(                             0x00007faceb5783f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007face59873c0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "right": SerField {                         key_py: Py(                             0x00007faceb5783b0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007face5987460,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "delete": SerField {                         key_py: Py(                             0x00007faceb960eb0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007face5987500,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "first": SerField {                         key_py: Py(                             0x00007faceb5e74f0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007face5987410,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "last": SerField {                         key_py: Py(                             0x00007faceb5c8f30,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007face59874b0,                                         ),                                     ),                                     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(             0x0000563308b312f0,         ),         serializer: Fields(             GeneralFieldsSerializer {                 fields: {                     "delete": SerField {                         key_py: Py(                             0x00007fb4fb760eb0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb4f67233c0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "left": SerField {                         key_py: Py(                             0x00007fb4fb3783b0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb4f6723280,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "right": SerField {                         key_py: Py(                             0x00007fb4fb378370,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb4f6723320,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "first": SerField {                         key_py: Py(                             0x00007fb4fb3e74b0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb4f67232d0,                                         ),                                     ),                                     serializer: Str(                                         StrSerializer,                                     ),                                 },                             ),                         ),                         required: true,                     },                     "last": SerField {                         key_py: Py(                             0x00007fb4fb3c8eb0,                         ),                         alias: None,                         alias_py: None,                         serializer: Some(                             WithDefault(                                 WithDefaultSerializer {                                     default: Default(                                         Py(                                             0x00007fb4f6723370,                                         ),                                     ),                                     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(                                 0x00007face5fd15f0,                             ),                             path: LookupPath(                                 [                                     S(                                         "first",                                         Py(                                             0x00007face5f392b0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007faceb5e74f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007face5987410,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007face9d563e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "left",                         lookup_key: Simple {                             key: "left",                             py_key: Py(                                 0x00007face6010d70,                             ),                             path: LookupPath(                                 [                                     S(                                         "left",                                         Py(                                             0x00007face5f51230,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007faceb5783f0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007face59873c0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007face9d563e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "right",                         lookup_key: Simple {                             key: "right",                             py_key: Py(                                 0x00007face5f51ab0,                             ),                             path: LookupPath(                                 [                                     S(                                         "right",                                         Py(                                             0x00007face4fcdd30,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007faceb5783b0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007face5987460,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007face9d563e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "last",                         lookup_key: Simple {                             key: "last",                             py_key: Py(                                 0x00007face4fcdc30,                             ),                             path: LookupPath(                                 [                                     S(                                         "last",                                         Py(                                             0x00007face4fcff30,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007faceb5c8f30,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007face59874b0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007face9d563e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "delete",                         lookup_key: Simple {                             key: "delete",                             py_key: Py(                                 0x00007face4fcfe70,                             ),                             path: LookupPath(                                 [                                     S(                                         "delete",                                         Py(                                             0x00007face4fce1f0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007faceb960eb0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007face5987500,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007face9d563e0,                                 ),                             },                         ),                         frozen: false,                     },                 ],                 model_name: "PaginationEmojis",                 extra_behavior: Ignore,                 extras_validator: None,                 strict: false,                 from_attributes: false,                 loc_by_alias: true,             },         ),         class: Py(             0x00005572b2dda0d0,         ),         generic_origin: None,         post_init: None,         frozen: false,         custom_init: false,         root_model: false,         undefined: Py(             0x00007face9d563e0,         ),         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(                                 0x00007fb4f4858c70,                             ),                             path: LookupPath(                                 [                                     S(                                         "first",                                         Py(                                             0x00007fb4f826f2f0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb4fb3e74b0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb4f67232d0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb4f9bf23e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "left",                         lookup_key: Simple {                             key: "left",                             py_key: Py(                                 0x00007fb4f6f78730,                             ),                             path: LookupPath(                                 [                                     S(                                         "left",                                         Py(                                             0x00007fb4f6f4bcf0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb4fb3783b0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb4f6723280,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb4f9bf23e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "right",                         lookup_key: Simple {                             key: "right",                             py_key: Py(                                 0x00007fb4f451ae70,                             ),                             path: LookupPath(                                 [                                     S(                                         "right",                                         Py(                                             0x00007fb4f451b5f0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb4fb378370,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb4f6723320,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb4f9bf23e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "last",                         lookup_key: Simple {                             key: "last",                             py_key: Py(                                 0x00007fb4f451bfb0,                             ),                             path: LookupPath(                                 [                                     S(                                         "last",                                         Py(                                             0x00007fb4f451b2f0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb4fb3c8eb0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb4f6723370,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb4f9bf23e0,                                 ),                             },                         ),                         frozen: false,                     },                     Field {                         name: "delete",                         lookup_key: Simple {                             key: "delete",                             py_key: Py(                                 0x00007fb4f4519f70,                             ),                             path: LookupPath(                                 [                                     S(                                         "delete",                                         Py(                                             0x00007fb4f4519db0,                                         ),                                     ),                                 ],                             ),                         },                         name_py: Py(                             0x00007fb4fb760eb0,                         ),                         validator: WithDefault(                             WithDefaultValidator {                                 default: Default(                                     Py(                                         0x00007fb4f67233c0,                                     ),                                 ),                                 on_error: Raise,                                 validator: Str(                                     StrValidator {                                         strict: false,                                         coerce_numbers_to_str: false,                                     },                                 ),                                 validate_default: false,                                 copy_default: false,                                 name: "default[str]",                                 undefined: Py(                                     0x00007fb4f9bf23e0,                                 ),                             },                         ),                         frozen: false,                     },                 ],                 model_name: "PaginationEmojis",                 extra_behavior: Ignore,                 extras_validator: None,                 strict: false,                 from_attributes: false,                 loc_by_alias: true,             },         ),         class: Py(             0x0000563308b312f0,         ),         generic_origin: None,         post_init: None,         frozen: false,         custom_init: false,         root_model: false,         undefined: Py(             0x00007fb4f9bf23e0,         ),         name: "PaginationEmojis",     }, ), definitions=[], cache_strings=True)ยถ

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

-- cgit v1.2.3