PyDrocsid.embeds ¶
send_long_embed
async
¶
send_long_embed(channel: Messageable | Message | InteractionResponse, embed: Embed, *, content: str | None = None, repeat_title: bool = False, repeat_thumbnail: bool = False, repeat_name: bool = False, repeat_image: bool = False, repeat_footer: bool = False, paginate: bool = False, pagination_user: User | Member | None = None, max_fields: int = 25, **kwargs: Any) -> list[Message]
Split and send a long embed in multiple messages.
Parameters:
-
channel
(
Messageable | Message | InteractionResponse
) –the channel into which the messages should be sent
-
embed
(
Embed
) –the embed to send
-
content
(
str | None
) –the content of the first message
-
repeat_title
(
bool
) –whether to repeat the embed title in every embed
-
repeat_thumbnail
(
bool
) –whether to repeat the thumbnail image in every embed
-
repeat_name
(
bool
) –whether to repeat field names in every embed
-
repeat_image
(
bool
) –whether to repeat the image in every embed
-
repeat_footer
(
bool
) –whether to repeat the footer in every embed
-
paginate
(
bool
) –whether to use pagination instead of multiple messages
-
pagination_user
(
User | Member | None
) –the user who should be able to control the pagination
-
max_fields
(
int
) –the maximum number of fields an embed is allowed to have
Returns:
Source code in PyDrocsid/embeds.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
split_lines ¶
split_lines(text: str, max_size: int, *, first_max_size: int | None = None) -> list[str]
Split a string into a list of substrings such that each substring contains no more than max_size characters. To achieve this, this function first tries to split the string at line breaks. Substrings which are still too long are split at spaces and (only if necessary) between any two characters.
Parameters:
-
text
(
str
) –the string
-
max_size
(
int
) –maximum number of characters allowed in each substring
-
first_max_size
(
int | None
) –optional override for max_size of first substring
Returns:
Source code in PyDrocsid/embeds.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
|