Commit Graph

30 Commits

Author SHA1 Message Date
julien4215 9f16bf5c25
Fix documentation on client address type (#2580) 2024-04-25 08:49:38 +02:00
Sebastián Ramírez 8c74c2c8db
Merge pull request from GHSA-74m5-2c7w-9w3x
* ♻️ Refactor multipart parser logic to support limiting max fields and files

*  Add support for new request.form() parameters max_files and max_fields

*  Add tests for limiting max fields and files in form data

* 📝 Add docs about request.form() with new parameters max_files and max_fields

* 📝 Update `docs/requests.md`

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>

* 📝 Tweak docs for request.form()

* ✏ Fix typo in `starlette/formparsers.py`

Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>

---------

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>
2023-02-14 09:01:32 +01:00
Rafał Pitoń 337ae243b1
Document that UploadFile's `filename` and `content_type` can be `None` (#2029) 2023-02-08 13:20:19 +08:00
Rafał Pitoń e05b632c56
Feature: Add size attribute to UploadFile (#1405) 2023-02-06 12:02:29 +00:00
Adrian Garcia Badaracco c568b55dff
allow using Request.form() as a context manager (#1903)
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2023-02-06 05:58:21 +00:00
Marcelo Trylesinski d81d8c8d3c
Update requests.md (#1792) 2022-08-06 23:46:06 +02:00
memsuser 92c1f1e550
Add notes on "filename" form-data field (#1704)
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>
2022-06-26 21:56:00 -07:00
Adrian Garcia Badaracco 4e86245c4c
Document and type annotate UploadFile as a bytes-only interface. Not bytes or text. (#1312) 2022-01-10 09:41:43 -08:00
Adrian Garcia Badaracco f1c5049643
feat: add headers attribute to UploadFile (#1382)
This preserves the multipart field headers that may have been included in the original request

Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-01-07 11:06:37 -08:00
Aviram Hassan c63f22fecb ignore malformed cookie instead of raising an exception 2020-03-18 10:00:30 +02:00
Liam O'Boyle 0e75f9f2b8 Document the `request.app` property.
* Mention it in the Request documentation
* Mention it in the Application documentation in the context of
  accessing the application state
2019-08-28 08:11:03 +10:00
Rafał Pitoń b155c44a21 Simplify example apps code to plain functions 2019-06-14 12:53:38 +02:00
rafalp 765bdd2fa6 Update response() calls in docs for ASGI 3 2019-06-14 12:39:41 +02:00
Sebastián Ramírez 8f138ce922 Add documentation for UploadFile class in the Request section (#418)
* Add documentation for UploadFile class in Request section

* Implement changes requested in code review

* Simplify upload file reading example
2019-03-04 19:25:03 +00:00
FoxMaSk dfb0d67b87 typo (#412) 2019-02-24 18:40:09 +00:00
Tom Christie 82c610559c
Request state (#404)
* Add Mount(routes=...)

* Lifespan route instance

* Lifespan as a standard routing component

* Linting

* Linting

* Version 0.10.6

* Release notes

* Version 0.11.0

* Drop redundant import

* Drop redundant database requirements

* Include htmlcov in scripts/clean

* Drop redundant import

* Release notes

* Linting

* Add request.state
2019-02-19 13:14:53 +00:00
Tom Christie d5c798e6b8
Example ASGI apps now ensure scope['type'] is expected message type. (#348) 2019-01-25 14:40:33 +00:00
Tom Christie f923c739e8 Version 0.9.11 2019-01-23 09:04:33 +00:00
Tom Christie c220994eb1
Add `request.is_disconnected()` (#320)
* Add request.is_disconnected()

* Add request.is_disconnected
2019-01-15 09:59:59 +00:00
Tom Christie a2613494a4
Add request.client (#272)
* Add request.client

* Docs for request.client
2018-12-14 09:58:27 +00:00
David Larlet 9a51a63d35 Documentation typo (#218) 2018-11-14 10:58:05 +00:00
Tom Christie 8da0f00fe7
Routing interface (#144)
* Path -> Route, PathPrefix -> Mount

* Route, WebSocketRoute, Mount

* Use Route(endpoint=...), not Route(app=...)

* Bare minimum docs update

* Add url_for

* request.path_params and session.path_params

* Version 0.6.0
2018-10-29 09:22:45 +00:00
Tom Christie 07581a7dd6 Tweak to cookie docs 2018-10-17 11:17:07 +01:00
Alexander Botello 4dedf7ce96 Add documentation for cookies (#116)
* Add cookies to request docs

* Add cookies to response docs

* Reformat the postion of methods
2018-10-17 11:15:32 +01:00
Tom Christie c43a070eed
Form parsing (#102)
* Work towards MultiPartParser

* Work towards MultiPartParser

* Add test for multipart files

* MultiPart parsing

* Fix for large multipart messages

* Add python-multipart to docs

* Add python-multipart to 'pip install starlette[full]'

* Add FormParser

* Add docs for request.form()

* Drop mypy momentarily
2018-10-12 18:15:04 +01:00
Tom Christie 94044e5991
Tweaks to URL datastructure (#81)
* Tweaks to URL datastructure

* Linting
2018-10-05 11:29:06 +01:00
Jordan Eremieff f4fe0ec312 Name changes (#55)
* Rename View -> HTTPEndpoint

* Rename views doc file -> endpoints

* Rename request/response files -> requests/responses, update imports, update docs

* Rename WebSocketSession -> WebSocket, rename session -> websocket in docs

* Full module imports in tests and source, removing imports from __init__ file

* Fix name in testclient doc
2018-09-05 10:29:04 +01:00
Tom Christie 2002eb1bd2 Drop licence footer from page content 2018-08-29 11:31:08 +01:00
Tom Christie 352ccda556 Update docs 2018-08-29 11:17:09 +01:00
Jeff Buttars bb6a8fb7c9 Initial conversion of README.md to mkdocs 2018-08-28 07:58:03 -06:00