import io from typing import Any, Iterable, List, Optional from urllib.parse import urlencode from multidict import MultiDict, MultiDictProxy from . import hdrs, multipart, payload from .helpers import guess_filename from .payload import Payload __all__ = ("FormData",) class FormData: """Helper class for form body generation. Supports multipart/form-data and application/x-www-form-urlencoded. """ def __init__( self, fields: Iterable[Any] = (), quote_fields: bool = True, charset: Optional[str] = None, ) -> None: self._writer = multipart.MultipartWriter("form-data") self._fields: List[Any] = [] self._is_multipart = False self._is_processed = False self._quote_fields = quote_fields self._charset = charset if isinstance(fields, dict): fields = list(fields.items()) elif not isinstance(fields, (list, tuple)): fields = (fields,) self.add_fields(*fields) @property def is_multipart(self) -> bool: return self._is_multipart def add_field( self, name: str, value: Any, *, content_type: Optional[str] = None, filename: Optional[str] = None, content_transfer_encoding: Optional[str] = None, ) -> None: if isinstance(value, io.IOBase): self._is_multipart = True elif isinstance(value, (bytes, bytearray, memoryview)): if filename is None and content_transfer_encoding is None: filename = name type_options: MultiDict[str] = MultiDict({"name": name}) if filename is not None and not isinstance(filename, str): raise TypeError( "filename must be an instance of str. " "Got: %s" % filename ) if filename is None and isinstance(value, io.IOBase): filename = guess_filename(value, name) if filename is not None: type_options["filename"] = filename self._is_multipart = True headers = {} if content_type is not None: if not isinstance(content_type, str): raise TypeError( "content_type must be an instance of str. " "Got: %s" % content_type ) headers[hdrs.CONTENT_TYPE] = content_type self._is_multipart = True if content_transfer_encoding is not None: if not isinstance(content_transfer_encoding, str): raise TypeError( "content_transfer_encoding must be an instance" " of str. Got: %s" % content_transfer_encoding ) headers[hdrs.CONTENT_TRANSFER_ENCODING] = content_transfer_encoding self._is_multipart = True self._fields.append((type_options, headers, value)) def add_fields(self, *fields: Any) -> None: to_add = list(fields) while to_add: rec = to_add.pop(0) if isinstance(rec, io.IOBase): k = guess_filename(rec, "unknown") self.add_field(k, rec) # type: ignore[arg-type] elif isinstance(rec, (MultiDictProxy, MultiDict)): to_add.extend(rec.items()) elif isinstance(rec, (list, tuple)) and len(rec) == 2: k, fp = rec self.add_field(k, fp) # type: ignore[arg-type] else: raise TypeError( "Only io.IOBase, multidict and (name, file) " "pairs allowed, use .add_field() for passing " "more complex parameters, got {!r}".format(rec) ) def _gen_form_urlencoded(self) -> payload.BytesPayload: # form data (x-www-form-urlencoded) data = [] for type_options, _, value in self._fields: data.append((type_options["name"], value)) charset = self._charset if self._charset is not None else "utf-8" if charset == "utf-8": content_type = "application/x-www-form-urlencoded" else: content_type = "application/x-www-form-urlencoded; " "charset=%s" % charset return payload.BytesPayload( urlencode(data, doseq=True, encoding=charset).encode(), content_type=content_type, ) def _gen_form_data(self) -> multipart.MultipartWriter: """Encode a list of fields using the multipart/form-data MIME format""" if self._is_processed: raise RuntimeError("Form data has been processed already") for dispparams, headers, value in self._fields: try: if hdrs.CONTENT_TYPE in headers: part = payload.get_payload( value, content_type=headers[hdrs.CONTENT_TYPE], headers=headers, encoding=self._charset, ) else: part = payload.get_payload( value, headers=headers, encoding=self._charset ) except Exception as exc: raise TypeError( "Can not serialize value type: %r\n " "headers: %r\n value: %r" % (type(value), headers, value) ) from exc if dispparams: part.set_content_disposition( "form-data", quote_fields=self._quote_fields, **dispparams ) # FIXME cgi.FieldStorage doesn't likes body parts with # Content-Length which were sent via chunked transfer encoding assert part.headers is not None part.headers.popall(hdrs.CONTENT_LENGTH, None) self._writer.append_payload(part) self._is_processed = True return self._writer def __call__(self) -> Payload: if self._is_multipart: return self._gen_form_data() else: return self._gen_form_urlencoded()
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
.hash | Folder | 0755 |
|
|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 7.58 KB | 0644 |
|
_cparser.pxd | File | 4.22 KB | 0644 |
|
_find_header.pxd | File | 68 B | 0644 |
|
_headers.pxi | File | 1.96 KB | 0644 |
|
_helpers.cpython-311-x86_64-linux-gnu.so | File | 86.01 KB | 0755 |
|
_helpers.pyi | File | 202 B | 0644 |
|
_helpers.pyx | File | 1.02 KB | 0644 |
|
_http_parser.cpython-311-x86_64-linux-gnu.so | File | 569.59 KB | 0755 |
|
_http_parser.pyx | File | 27.4 KB | 0644 |
|
_http_writer.cpython-311-x86_64-linux-gnu.so | File | 75.01 KB | 0755 |
|
_http_writer.pyx | File | 4.47 KB | 0644 |
|
_websocket.cpython-311-x86_64-linux-gnu.so | File | 53.37 KB | 0755 |
|
_websocket.pyx | File | 1.52 KB | 0644 |
|
abc.py | File | 5.37 KB | 0644 |
|
base_protocol.py | File | 2.68 KB | 0644 |
|
client.py | File | 46.17 KB | 0644 |
|
client_exceptions.py | File | 9.19 KB | 0644 |
|
client_proto.py | File | 8.45 KB | 0644 |
|
client_reqrep.py | File | 38.75 KB | 0644 |
|
client_ws.py | File | 10.75 KB | 0644 |
|
compression_utils.py | File | 4.9 KB | 0644 |
|
connector.py | File | 51.56 KB | 0644 |
|
cookiejar.py | File | 13.69 KB | 0644 |
|
formdata.py | File | 5.96 KB | 0644 |
|
hdrs.py | File | 4.5 KB | 0644 |
|
helpers.py | File | 29.55 KB | 0644 |
|
http.py | File | 1.8 KB | 0644 |
|
http_exceptions.py | File | 2.65 KB | 0644 |
|
http_parser.py | File | 34.66 KB | 0644 |
|
http_websocket.py | File | 26.09 KB | 0644 |
|
http_writer.py | File | 5.79 KB | 0644 |
|
locks.py | File | 1.11 KB | 0644 |
|
log.py | File | 325 B | 0644 |
|
multipart.py | File | 31.71 KB | 0644 |
|
payload.py | File | 13.22 KB | 0644 |
|
payload_streamer.py | File | 2.04 KB | 0644 |
|
py.typed | File | 7 B | 0644 |
|
pytest_plugin.py | File | 11.33 KB | 0644 |
|
resolver.py | File | 4.95 KB | 0644 |
|
streams.py | File | 20.35 KB | 0644 |
|
tcp_helpers.py | File | 961 B | 0644 |
|
test_utils.py | File | 19.71 KB | 0644 |
|
tracing.py | File | 14.78 KB | 0644 |
|
typedefs.py | File | 1.44 KB | 0644 |
|
web.py | File | 18.81 KB | 0644 |
|
web_app.py | File | 17.88 KB | 0644 |
|
web_exceptions.py | File | 10.12 KB | 0644 |
|
web_fileresponse.py | File | 11.15 KB | 0644 |
|
web_log.py | File | 7.62 KB | 0644 |
|
web_middlewares.py | File | 3.94 KB | 0644 |
|
web_protocol.py | File | 22.5 KB | 0644 |
|
web_request.py | File | 28.08 KB | 0644 |
|
web_response.py | File | 27.08 KB | 0644 |
|
web_routedef.py | File | 5.99 KB | 0644 |
|
web_runner.py | File | 11.46 KB | 0644 |
|
web_server.py | File | 2.53 KB | 0644 |
|
web_urldispatcher.py | File | 39.12 KB | 0644 |
|
web_ws.py | File | 18.21 KB | 0644 |
|
worker.py | File | 7.78 KB | 0644 |
|