Command
BaseCommand
¶
Bases: DictSerializationMixin
, CallbackObject
An object all commands inherit from. Outlines the basic structure of a command, and handles checks.
Attributes:
Name | Type | Description |
---|---|---|
extension | Optional[Extension] | The extension this command belongs to. |
enabled | bool | Whether this command is enabled |
checks | list | Any checks that must be run before this command can be run |
callback | Callable[..., Coroutine] | The coroutine to be called for this command |
error_callback | Callable[..., Coroutine] | The coroutine to be called when an error occurs |
pre_run_callback | Callable[..., Coroutine] | A coroutine to be called before this command is run but after the checks |
post_run_callback | Callable[..., Coroutine] | A coroutine to be called after this command has run |
Source code in interactions/models/internal/command.py
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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 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 |
|
__call__(context, *args, **kwargs)
async
¶
Calls this command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
context | BaseContext | The context of this command | required |
args | Any | () | |
kwargs | Any | {} |
Source code in interactions/models/internal/command.py
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 |
|
add_check(check)
¶
Adds a check into the command.
Source code in interactions/models/internal/command.py
236 237 238 |
|
error(call)
¶
A decorator to declare a coroutine as one that will be run upon an error.
Source code in interactions/models/internal/command.py
240 241 242 243 244 245 |
|
post_run(call)
¶
A decorator to declare a coroutine as one that will be run after the command has.
Source code in interactions/models/internal/command.py
254 255 256 257 258 259 |
|
pre_run(call)
¶
A decorator to declare a coroutine as one that will be run before the command.
Source code in interactions/models/internal/command.py
247 248 249 250 251 252 |
|
check(check)
¶
Add a check to a command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
check | Callable[..., Awaitable[bool]] | A coroutine as a check for this command | required |
Source code in interactions/models/internal/command.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
|
cooldown(bucket, rate, interval, cooldown_system=None)
¶
Add a cooldown to a command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
bucket | Buckets | The bucket used to track cooldowns | required |
rate | int | How many commands may be ran per interval | required |
interval | float | How many seconds to wait for a cooldown | required |
cooldown_system | typing.Type[CooldownSystem] | None | The cooldown system to use | None |
Source code in interactions/models/internal/command.py
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
|
max_concurrency(bucket, concurrent)
¶
Add a maximum number of concurrent instances to the command.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
bucket | Buckets | The bucket to enforce the maximum within | required |
concurrent | int | The maximum number of concurrent instances to allow | required |
Source code in interactions/models/internal/command.py
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
|