feat(components,commands): support restricting allowed file types in FileUpload modal components and slash command attachment options

[shiftinv]

Summary

Note

This is in private testing at the moment, and will be made available to everyone within the next couple weeks.

This adds a file_types parameter/field to components.FileUpload and ui.FileUpload, as well as Option and Param/ParamInfo for slash commands.

Valid values are the predefined image/video/audio groups and arbitrary extensions such as .pdf, or any combination thereof (up to 10, where each one can be up to 16 chars).

IMAGE_EXTENSIONS = ('.png', '.gif', '.jpg', '.jpeg', '.jfif', '.webp', '.avif')
VIDEO_EXTENSIONS = ('.mp4', '.mov', '.qt', '.webm')
AUDIO_EXTENSIONS = ('.mp3', '.m4a', '.wav', '.ogg', '.opus', '.flac')

(and, once again, we're at a point where a Sequence[str] that doesn't allow str would be great)

Modal FileUpload example

Checklist

• If code changes were made, then they have been tested
  • I have updated the documentation to reflect the changes
  • I have formatted the code properly by running uv run nox -s lint
  • I have type-checked the code by running uv run nox -s pyright
• This PR fixes an issue
• This PR adds something new (e.g. new method or parameters)
• This PR is a breaking change (e.g. methods or parameters removed/renamed)
• This PR is not a code change (e.g. documentation, README, ...)

[read-the-docs-community]

Documentation build overview

📚 disnake | 🛠️ Build #33478849 | 📁 Comparing a3263ba against latest (57e1005)

  🔍 Preview build  

51 files changed · ± 51 modified

± Modified

• faq.html
• genindex.html
• index.html
• whats_new.html
• api/abc.html
• api/activities.html
• api/app_commands.html
• api/app_info.html
• api/audit_logs.html
• api/automod.html
• and 41 more...

[Enegg]

Could you clarify:

Valid values are the predefined image/video/audio groups

Are those pre-defined by discord, or are they library-supplied shorthands?

I'm assuming the former, since the PR doesn't seem to include any lib-specific mechanisms

[shiftinv]

Are those pre-defined by discord, or are they library-supplied shorthands?

I'm assuming the former, since the PR doesn't seem to include any lib-specific mechanisms

Yup. The mappings are mentioned in the PR description (copied 1:1 from the announcement), I'm still kind of debating whether we should document them.

[Enegg]

I'm still kind of debating whether we should document them.

Hmm, what do you think of doing something like

file_types: list[str | Literal["image", "video", "audio"]] | None = None

So just by inspecting the signature you could see there are some magic values available
(docstring can stay file_types: :class:'list'[:class:'str'] | :data:'None' since it is explained below)

Pylance may even offer some autocompletion

Though it's not smart enough to do it for the list display

[shiftinv]

So just by inspecting the signature you could see there are some magic values available

Hmm, good point, I'll add those again to at least have them show up in the signature.
I did try it originally, but also noticed the same behavior you saw, with pylance not suggesting these literal values in lists -- unfortunate :/