mirror/fastapi
1
0
Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-04-16 12:57:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

📝 Add docs about params as functions for mypy (#231)

Browse Source
This commit is contained in:
Sebastián Ramírez
2019-05-15 22:01:23 +04:00
committed by GitHub
parent ca27317b65
commit d240421378
7 changed files with 29 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/tutorial/path-params-numeric-validations.md
View File

@@ -103,6 +103,17 @@ And you can also declare numeric validations:
* `le`: `l`ess than or `e`qual
!!! info
`Query`, `Path` and others you will see later are subclasses of a common `Param` class (that you don't need to use).
And all of them share the same all these same parameters of additional validation and metadata you have seen.
`Query`, `Path` and others you will see later subclasses of a common `Param` class (that you don't need to use).
And all of them share the same all these same parameters of additional validation and metadata you have seen.
!!! note "Technical Details"
When you import `Query`, `Path` and others from `fastapi`, they are actually functions.
That when called, return instances of classes of the same name.
So, you import `Query`, which is a function. And when you call it, it returns an instance of a class also named `Query`.
These functions are there (instead of just using the classes directly) so that your editor doesn't mark errors about their types.
That way you can use your normal editor and coding tools without having to add custom configurations to disregard those errors.