&Nj/6 % S SK Jr S SKrS SKrS SKrS SKrS SKrS SKJr S SK J
r
J r S SK J
r
S SKJrJr SSKJrJr SS KJrJrJrJr \( a\ S S
KJr S S KJrJ r J r J r J r " S S
\ 5 r " S S\ SS9r! " S S\ SS9r" " S S\ SS9r# " S S\ SS9r$ " S S\$5 r%\ S r&S\'S ' \(" 5 r) " S S \5 r* " S S \5 r+Sr,S!r-S"r.S#r/S$r0S%r1S&r2S'r3S(r4S)r5S r6S*r7\8" \75 r9S+r: S,r; S-r< S@S. jr=SAS/ jr> " S0 S15 r? " S2 S35 r@ " S4 S55 rA " S6 S7\A5 rB " S8 S9\A5 rC " S: S;\A5 rD " S< S=5 rE0 4 SBS> jjrF SC SDS? jjrGg)E ) annotationsN)IntEnum)BufferedRandomBytesIO)Number)
TYPE_CHECKINGcast )
Base64DecoderQuotedPrintableDecoder) FileErrorFormParserErrorMultipartParseErrorQuerystringParseError)Callable)AnyLiteralProtocol TypeAlias TypedDictc \ rS rSrSS jrSrg) SupportsRead c g N )self_SupportsRead__ns W/home/mande/repo/quber/.venv/lib/python3.13/site-packages/python_multipart/multipart.pyreadSupportsRead.read s 3 r N)r intreturnbytes)__name__
__module__ __qualname____firstlineno__r __static_attributes__r r" r r r s .r" r c H \ rS rSr% S\S' S\S' S\S' S\S' S\S' S rg
) QuerystringCallbacks Callable[[], None]on_field_start!Callable[[bytes, int, int], None]
on_field_name
on_field_data on_field_endon_endr Nr& r' r( r) __annotations__r* r r" r r, r, s **8888((""r" r, F)totalc 4 \ rS rSr% S\S' S\S' S\S' Srg) OctetStreamCallbacks r. on_startr0 on_datar4 r Nr5 r r" r r9 r9 s $$22""r" r9 c p \ rS rSr% S\S' S\S' S\S' S\S' S\S' S\S ' S\S
' S\S ' S\S ' S
rg)MultipartCallbacks# r.
on_part_beginr0 on_part_data on_part_endon_header_beginon_header_fieldon_header_value
on_header_endon_headers_finishedr4 r Nr5 r r" r r> r> # s8 ))77''++::::)) //""r" r> c H \ rS rSr% S\S' S\S' S\S' S\S' S\S ' S
rg )
FileConfig. str | bytes | None
UPLOAD_DIRboolUPLOAD_DELETE_TMPUPLOAD_KEEP_FILENAMEUPLOAD_KEEP_EXTENSIONSr# MAX_MEMORY_FILE_SIZEr Nr5 r r" r rI rI . s && "" $$ !!r" rI c > \ rS rSr% S\S' S\S' S\S' S\S' S rg
) FormParserConfig5 rM UPLOAD_ERROR_ON_BAD_CTEfloat
MAX_BODY_SIZEr# MAX_HEADER_COUNTMAX_HEADER_SIZEr Nr5 r r" r rS rS 5 s !%% r" rS )startdataend field_start
field_name
field_data field_end
part_begin part_datapart_end header_begin header_field header_value
header_endheaders_finishedr CallbackNamec $ \ rS rSrSrSrSrSrSrg)QuerystringStateQ zQuerystring parser states.
These are used to keep track of the state of the parser, and are used to determine
what to do when new data is encountered.
r r
r N) r& r' r( r) __doc__ BEFORE_FIELD
FIELD_NAME
FIELD_DATAr* r r" r rk rk Q s LJJr" rk c L \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrg)MultipartState] zMultipart parser states.
These are used to keep track of the state of the parser, and are used to determine
what to do when new data is encountered.
r r
rm
r N)r& r' r( r) rn STARTSTART_BOUNDARYHEADER_FIELD_START HEADER_FIELDHEADER_VALUE_START HEADER_VALUEHEADER_VALUE_ALMOST_DONEHEADERS_ALMOST_DONEPART_DATA_START PART_DATA
PART_DATA_END END_BOUNDARYENDr* r r" r rs rs ] sN
ENLL OIML
Cr" rs rm
r| : - & a z sM ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!#$%&'*+-.^_`|~rz i c d SU - n / nSnU R SU5 U:X Ga US-
nU R SU5 nUSpTUS: aN XPR SXC5 U R SXC5 -
-
nUS- S:X a O X@R SUS- 5 pCUS: a MN US: a [ U 5 nU R SX#5 nUS:X a XU nO9XU R 5 R 5 S- XS- U R 5 - nUR
UR 5 5 UnU R SU5 U:X a GM U$ ) N;r r
"\"rm =)findcountlenrstriplowerlstripappendstrip)splistrZ r\ inddiffifs r _parseparamr s:
aAE
E
&&e
%
ffS% 1TAg GGC*QWWUC-EE EDax1}FF3a 0 Ag
7a&C
FF3 # 7 A
!!#))+c1A!ecN4I4I4KKA
QWWY # &&e
%$ Lr" c U ( d S0 4$ [ U [ 5 ( a U R S5 n [ U [ 5 ( d S5 eSU ; a/ U R 5 R 5 R
S5 0 4$ [ U 5 tp0 nU H nUR S5 u pVnSU; a M [ U5 S: a7 US S :X a. US
S :X a% US S
R S S
5 R SS 5 nUS:X a& US S S:X d USS S :X a UR S
5 S
nUR
S5 X5R
S5 ' M UR
S5 U4$ )z`Parses a Content-Type header into a value in the following format: (content_type, {parameters}).r" latin-1z Value should be a string by nowr r *rm r r r r
z\\\r filenameru z:\N)
isinstancer% decodestrr r encoder partitionr replacesplit)valuectypesegmentsoptionssegmentkey_vals r parse_options_headerr s\ Ry % Y' eS ! !D#DD ! %
##%,,Y7<<"5)E"$G '',
#: s8q=SVs]s2w#~a)##FD199%EC * #a(e"3s2Aw&7H))D/"%C),I)>
9%& << "G ++r" c \ rS rSrSrSS.SS jjr\SS j5 rSS jrSS jr SS jr
SS
jr SS jr SS jr
\SS
j5 r\SS j5 r\SS j5 rSS jrSS jrSrg)Field a: A Field object represents a (parsed) form field. It represents a single
field with a corresponding name and value.
The name that a :class:`Field` will be instantiated with is the same name
that would be found in the following HTML::
This class defines two methods, :meth:`on_data` and :meth:`on_end`, that
will be called when data is written to the Field, and when the Field is
finalized, respectively.
Args:
name: The name of the form field.
content_type: The value of the Content-Type header for this field.
N content_typec @ Xl / U l X l [ U l g r )_name_value
_content_type_missing_cache)r namer s r __init__Field.__init__ s
#% ) r" c U " U5 nUc UR 5 OUR U5 UR 5 U$ )aT Create an instance of a :class:`Field`, and set the corresponding
value - either None or an actual value. This method will also
finalize the Field itself.
Args:
name: the name of the form field.
value: the value of the form field - either a bytestring or None.
Returns:
A new instance of a [`Field`][python_multipart.Field].
)set_nonewritefinalize)clsr r r s r
from_valueField.from_value s4
I =
JJL
GGEN
r" c $ U R U5 $ )zWrite some data into the form field.
Args:
data: The data to write to the field.
Returns:
The number of bytes written.
r< r r[ s r r Field.write s ||D!!r" c d U R R U5 [ U l [ U5 $ )zThis method is a callback that will be called whenever data is
written to the Field.
Args:
data: The data to write to the field.
Returns:
The number of bytes written.
)r r r r r r s r r<
Field.on_data s'
4 4yr" c l U R [ L a! SR U R 5 U l gg)6This method is called whenever the Field is finalized.r" Nr r joinr r s r r4 Field.on_end) s' ;;( " ((4;;/DK #r" c $ U R 5 g)zFinalize the form field.Nr4 r s r r Field.finalize. s
r" c n U R [ L a SR U R 5 U l U ?g)z=Close the Field object. This will free any underlying cache.r" Nr r s r close Field.close2 s) ;;( " ((4;;/DK Kr" c SU l g)aZ Some fields in a querystring can possibly have a value of None - for
example, the string "foo&bar=&baz=asdf" will have a field with the
name "foo" and value None, one with name "bar" and value "", and one
with name "baz" and value "asdf". Since the write() interface doesn't
support writing None, this function will set the field value to None.
N)r r s r r Field.set_none: s r" c U R $ )z,This property returns the name of the field.)r r s r r^ Field.field_nameC s zzr" c U R [ L a SR U R 5 U l [ U R [
5 ( d U R b eU R $ )z2This property returns the value of the form field.r" )r r r r r r% r s r r Field.valueH sN ;;( " ((4;;/DK$++u--1DDD{{r" c U R $ )z:This property returns the content_type value of the field.r r s r r Field.content_typeQ !!!r" c [ U[ 5 ( a9 U R UR :H =( a U R UR :H $ [ $ r )r r r^ r NotImplemented)r others r __eq__ Field.__eq__V s< eU # #??e&6&66T4::;T T! !r" c
U R b8 [ U R 5 S: a [ U R S S 5 S S S- nO[ U R 5 nU R R SU R
< SU S3$ )Nr r z...'z (field_name=z, value=))r r repr __class__r& r^ )r vs r __repr__Field.__repr__\ sw :: !c$**o&: TZZ_%cr*V3ATZZ A..))*,t6IRSQTTUVVr" )r r r r )r bytes | Noner
str | Noner$ None)r r% r r r$ r r[ r% r$ r# r$ r r$ r r$ r )r objectr$ rM r$ r )r& r' r( r) rn r classmethodr r r< r4 r r r propertyr^ r r r r r* r r" r r r s " JN * " 0
" "" Wr" r c \ rS rSrSrS0 4SS. SS jjjr\SS j5 r\SS j5 r\SS j5 r \SS j5 r
\SS
j5 r \SS j5 r \SS j5 r
S S
jrS S jrS S jrS S jrS S jrS S jrS S jrS S jrSrg) Fileig aO This class represents an uploaded file. It handles writing file data to
either an in-memory file or a temporary file on-disk, if the optional
threshold is passed.
There are some options that can be passed to the File to change behavior
of the class. Valid options are as follows:
| Name | Type | Default | Description |
|-----------------------|-------|---------|-------------|
| UPLOAD_DIR | `str` | None | The directory to store uploaded files in. If this is None, a temporary file will be created in the system's standard location. |
| UPLOAD_DELETE_TMP | `bool`| True | Delete automatically created TMP file |
| UPLOAD_KEEP_FILENAME | `bool`| False | Whether or not to keep the filename of the uploaded file. If True, then the filename will be converted to a safe representation (e.g. by removing any invalid path segments), and then saved with the same name). Otherwise, a temporary name will be used. |
| UPLOAD_KEEP_EXTENSIONS| `bool`| False | Whether or not to keep the uploaded file's extension. If False, the file will be saved with the default temporary extension (usually ".tmp"). Otherwise, the file's extension will be maintained. Note that this will properly combine with the UPLOAD_KEEP_FILENAME setting. |
| MAX_MEMORY_FILE_SIZE | `int` | 1 MiB | The maximum number of bytes of a File to keep in memory. By default, the contents of a File are kept into memory until a certain limit is reached, after which the contents of the File are written to a temporary file. This behavior can be disabled by setting this value to an appropriately large value (or, for example, infinity, such as `float('inf')`. |
Args:
file_name: The name of the file that this [`File`][python_multipart.File] represents.
field_name: The name of the form field that this file was uploaded with. This can be None, if, for example,
the file was uploaded with Content-Type application/octet-stream.
config: The configuration for this File. See above for valid configuration keys and their corresponding values.
content_type: The value of the Content-Type header.
Nr c Z [ R " [ 5 U l X0l SU l SU l [ 5 U l X l Xl
X@l S U l UbM [ R R U5 n[ R R! U5 u pgX`l Xpl g g )NTr )logging getLoggerr& logger_config
_in_memory_bytes_writtenr _fileobj _field_name
_file_namer _actual_file_nameospathbasenamesplitext
_file_base_ext)r file_namer^ configr r baseexts r r
File.__init__ s ''1 29)
&# ) 04 ww'' 2H((2ID "OI !r" c U R $ )zThe form field associated with this file. May be None if there isn't
one, for example when we have an application/octet-stream upload.
)r r s r r^ File.field_name s
r" c U R $ )z*The file name given in the upload request.)r r s r r File.file_name s r" c U R $ )z]The file name that this file is saved as. Will be None if it's not
currently saved on disk.
)r r s r actual_file_nameFile.actual_file_name s
%%%r" c U R $ )zThe file object that we're currently writing to. Note that this
will either be an instance of a :class:`io.BytesIO`, or a regular file
object.
)r r s r file_objectFile.file_object s }} r" c U R $ )zjThe total size of this file, counted as the number of bytes that
currently have been written to the file.
)r r s r size File.size s
"""r" c U R $ )zaA boolean representing whether or not this file object is currently
stored in-memory or on-disk.
)r
r s r in_memoryFile.in_memory s
r" c U R $ )z4The Content-Type value for this part, if it was set.r r s r r File.content_type r r" c ~ U R ( d U R R S5 gU R R S5 U R 5 n[ R " U R U5 UR U R 5 U R nXl SU l UR 5 g)a If the file is already on-disk, do nothing. Otherwise, copy from
the in-memory buffer to a disk file, and then reassign our internal
file object to this new disk file.
Note that if you attempt to flush a file that is already on-disk, a
warning will be logged to this module's logger.
z0Trying to flush to disk when we're not in memoryNr F)
r
r warningr seek_get_disk_fileshutil copyfileobjr r )r new_file old_fileobjs r
flush_to_diskFile.flush_to_disk s KK R S
1 &&( 4==(3
d))* mm
r" c U R R S5 U R R S5 nU R R SS5 nU R R SS5 nU R R SS5 nSnUb U( a U R R S U5 U( a U R U R
- O U R n[ R R X5 n U R R S
U5 [ US 5 nGO)U( a. U R
R [ R " 5 5 OSnUc Sn O<[! U[" 5 ( a% UR [ R " 5 5 n OUn U R R SXU S.5 [% [& [( R* " XU S95 nUc e[! UR, [. 5 ( a/ UR, R1 [ R " 5 5 nO[% [" UR, 5 nX`l U$ ! [ a, SnU R R S 5 [ S
U- 5 ef = f! [ a' U R R S5 [ S5 ef = f)zFThis function is responsible for getting a file object on-disk for us.zOpening a file on diskrL rO FrP rN TNzSaving with filename in: %rzOpening file: %rzw+bz Error opening temporary filez Error opening temporary file: %rz*Creating a temporary file with options: %r)suffixdeletedirz#Error creating named temporary file)r infor getr r r r r openOSError exceptionr
r sysgetfilesystemencodingr r% r r tempfileNamedTemporaryFiler r r r )
r file_dir
keep_filenamekeep_extensions
delete_tmptmp_filefnamer r; r= s
r r3 File._get_disk_file sG 12<<##L1 (()?G
,,**+CUK\\%%&94@
*. M KK :H E 4CDOOdii/E77<<0D
K !3T: e, GVTYY%%c&?&?&AB[_F He,, ooc&?&?&AB
KK <nq>r
G 0K0KSYru0vw
' ''(----
,,S-F-F-HI UHMM2!& I
K %%&DE BT IJJ
K0
G %%&KL EFF
Gs ?(I #J 6J1Kc $ U R U5 $ )z8Write some data to the File.
:param data: a bytestring
r r s r r
File.write+ s
||D!!r" c U R R U5 nU[ U5 :w a( U R R SU[ U5 5 U$ U =R
U-
sl U R R S5 nU R ( a> Ub; U R
U: a+ U R R S5 U R 5 U$ )zThis method is a callback that will be called whenever data is
written to the File.
Args:
data: The data to write to the file.
Returns:
The number of bytes written.
z bwritten != len(data) (%d != %d)rQ zFlushing to disk) r r r r r1 r r r? r
r> r8 )r r[ bwrittenmax_memory_file_sizes r r< File.on_data2 s ==&&t, s4y KK BHcRVi XO
x' $|| / /0F G ?? 3 ?TEXEX[oEo KK / 0 r" c 8 U R R 5 g)r N)r flushr s r r4 File.on_endO s
r" c $ U R 5 g)z~Finalize the form file. This will not close the underlying file,
but simply signal that we are finished writing to the File.
Nr r s r r
File.finalizeT s
r" c 8 U R R 5 g)zClose the File object. This will actually close the underlying
file object (whether it's a :class:`io.BytesIO` or an actual file
object).
N)r r r s r r
File.closeZ s
r" c l U R R SU R < SU R < S3$ )Nz (file_name=z
, field_name=r )r r& r r^ r s r r
File.__repr__a s4 ..))*+dnn5G}UYUdUdTgghiir" ) r r r r r r r r r r
r )
r r r^ r r rI r r r$ r r )r$ zBytesIO | BufferedRandom)r$ r# )r$ rM r r )r$ r r r )r& r' r( r) rn r r r^ r r# r& r) r, r r8 r3 r r< r4 r r r r* r r" r r r g s 4 $( $(
! !
@ & & # # " " D:x":
jr" r c l \ rS rSrSrS S jr S S
S jjrSS jrS S jrS S jr SS jr
S
r g)
BaseParserie a This class is the base class for all parsers. It contains the logic for
calling and adding callbacks.
A callback can be one of two different forms. "Notification callbacks" are
callbacks that are called when something happens - for example, when a new
part of a multipart message is encountered by the parser. "Data callbacks"
are called when we get some sort of data - for example, part of the body of
a multipart chunk. Notification callbacks are called with no parameters,
whereas data callbacks are called with three, as follows::
data_callback(data, start, end)
The "data" parameter is a bytestring (i.e. "foo" on Python 2, or b"foo" on
Python 3). "start" and "end" are integer indexes into the "data" string
that represent the data of interest. Thus, in a data callback, the slice
`data[start:end]` represents the data that the callback is "interested in".
The callback is not passed a copy of the data, since copying severely hurts
performance.
c P [ R " [ 5 U l 0 U l g r )r r
r& r callbacksr s r r BaseParser.__init__z s ''1 []r" Nc U R R SU- 5 nUc g[ SU5 nUb Ub X4:X a gU" X#U5 gU" 5 g)a This function calls a provided callback with some data. If the
callback is not set, will do nothing.
Args:
name: The name of the callback to call (as a string).
data: Data to pass to the callback. If None, then it is assumed that the callback is a notification
callback, and no parameters are given.
end: An integer that is passed to the data callback.
start: An integer that is passed to the data callback.
on_NzCallable[..., Any])r` r? r )r r r[ rZ r\ funcs r callbackBaseParser.callback~ sS ~~!!%$,/ < ($/ U\ c " Fr" c l Uc U R R SU- S5 gX R SU- ' g)aA Update the function for a callback. Removes from the callbacks dict
if new_func is None.
:param name: The name of the callback to call (as a string).
:param new_func: The new function for the callback. If None, then the
callback will be removed (with no error if it does not
exist).
Nrc )r` pop)r r new_funcs r set_callbackBaseParser.set_callback s2 NN ut|T 2+3NN54< (r" c g r r r s r r BaseParser.close r" c g r r r s r r BaseParser.finalize rn r" c 4 SU R R - $ Nz%s()r r& r s r r BaseParser.__repr__ ////r" )r` r r )NNN)
r ri r[ r rZ
int | Noner\ rv r$ r )r ri ri zCallable[..., Any] | Noner$ r r ) r& r' r( r) rn r re rj r r r r* r r" r r^ r^ e sU (^
jn (4DN\f
4
4
0r" r^ c b ^ \ rS rSrSr0 \" S5 4S U 4S jjjrS
S jrS S jrS S jr Sr
U =r $ )
OctetStreamParseri a This parser parses an octet-stream request body and calls callbacks when
incoming data is received. Callbacks are as follows:
| Callback Name | Parameters | Description |
|----------------|-----------------|-----------------------------------------------------|
| on_start | None | Called when the first data is parsed. |
| on_data | data, start, end| Called for each data chunk that is parsed. |
| on_end | None | Called when the parser is finished parsing all data.|
Args:
callbacks: A dictionary of callbacks. See the documentation for [`BaseParser`][python_multipart.BaseParser].
max_size: The maximum size of body to parse. Defaults to infinity - i.e. unbounded.
infc > [ TU ] 5 Xl SU l [ U[
5 ( a US: a [
SU- 5 eX l SU l g NFr
*max_size must be a positive number, not %rr ) superr r` _startedr r
ValueErrormax_size
_current_size)r r` r r s r r OctetStreamParser.__init__ sK
"
(F++x!| IH TU U%-
r" c U R ( d U R S5 SU l [ U5 nU R U- U R : aW [ U R U R -
5 nU R R SU R U R UU5 UnU =R U-
sl U R SUSU5 U$ )zWrite some data to the parser, which will perform size verification,
and then pass the data to the underlying callback.
Args:
data: The data to write to the parser.
Returns:
The number of bytes written.
rZ TDCurrent size is %d (max %d), so truncating data length from %d to %dr[ r )r~ re r r r r# r r1 )r r[ data_lennew_sizes r r OctetStreamParser.write s }} MM' " DM t9 )T]] :4==4+=+==>H KK V""
H
h&
fdAx0r" c & U R S5 g)zdFinalize this parser, which signals to that we are finished parsing,
and sends the on_end callback.
r\ N)re r s r r OctetStreamParser.finalize s
e r" c 4 SU R R - $ rr rs r s r r OctetStreamParser.__repr__ ru r" )r r~ r` r )r` r9 r rV r r r ) r& r' r( r) rn rV r r r r r*
__classcell__r s @r rx rx s3 : [ TU ] 5 [ R U l SU l Xl [ U[ 5 ( a US: a [ SU- 5 eX0l
SU l X l g r{ )
r} r rk ro r
_found_sepr` r r r r r strict_parsing)r r` r r r s r r QuerystringParser.__init__
sd %22
" (F++x!| IH TU U%-
-r" c [ U5 nU R U- U R : aW [ U R U R -
5 nU R R SU R U R UU5 UnSn U R
X5 nU =R U-
sl U$ ! U =R U-
sl f = f)a Write some data to the parser, which will perform size verification,
parse into either a field name or value, and then pass the
corresponding data to the underlying callback. If an error is
encountered while parsing, a QuerystringParseError will be raised. The
"offset" attribute of the raised exception will be set to the offset in
the input data chunk (NOT the overall stream) that caused the error.
Args:
data: The data to write to the parser.
Returns:
The number of bytes written.
r r r r r r# r r1 _internal_writer r[ r r ls r r QuerystringParser.write t9 )T]] :4==4+=+==>H KK V""
H
$$$T4A ! #
! # B+ +Cc U R nU R nU R nSnXb: GaA X nU[ R :X aq U[
:X a= U( a2 U( a
[
SU- US9eU R R SU5 GOSnGOU R S5 US- n[ R nSnGOU[ R :X a UR SXb5 nUS :w a UR S
Xh5 n OUR S
Xb5 n U S :w a' U R S XU 5 U n[ R nGO-U( dV US :w a: U R S XU5 U R S 5 US-
n[ R nOU R S XU5 UnOUS :w a [
S
U4- US9eU R S XU5 UnOU[ R :X ah UR SXb5 nUS :w a: U R SXU5 U R S 5 US-
n[ R nO@U R SXU5 UnO*SX64- n
U R R U
5 [
XS9eUS-
nXb: a GMA X0l XPl U$ )Nr z"Skipping duplicate ampersand at %doffsetTr] r
F &r =r^ r` z{When strict_parsing is True, we require an equals sign in all field chunks. Did not find one in the chunk that starts at %dr_ !Reached an unknown state %d at %d)r r r rk ro AMPERSANDr r debugre rp r rq r1 ) r r[ lengthr r found_sepr chsep_pos
equals_posmsgs r r !QuerystringParser._internal_writeC st
,,OO
jB (555 ? )"78\_`8`ij"k k KK - -.RTU V
%)
MM-0FA , 7 7E %I*555 ))D!4
b=!%4!> NN # #T%8%8$--
r" )r r r` r r r )r` r, r rM r rV r$ r r r[ r% r r# r$ r# r r )r& r' r( r) rn r6 rV r r r r r r* r r s @r r r sf * 135dijodp---DH-\a-
- -$"H~@
r" r c ^ \ rS rSrSr0 \" S5 4\\S. S U 4S jjjjrS S jr S
S jr
SS jr SS jr S
r
U =r$ )MultipartParseri a This class is a streaming multipart/form-data parser.
| Callback Name | Parameters | Description |
|--------------------|-----------------|-------------|
| on_part_begin | None | Called when a new part of the multipart message is encountered. |
| on_part_data | data, start, end| Called when a portion of a part's data is encountered. |
| on_part_end | None | Called when the end of a part is reached. |
| on_header_begin | None | Called when we've found a new header in a part of a multipart message |
| on_header_field | data, start, end| Called each time an additional portion of a header is read (i.e. the part of the header that is before the colon; the "Foo" in "Foo: Bar"). |
| on_header_value | data, start, end| Called when we get data for a header. |
| on_header_end | None | Called when the current header is finished - i.e. we've reached the newline at the end of the header. |
| on_headers_finished| None | Called when all headers are finished, and before the part data starts. |
| on_end | None | Called when the parser is finished parsing all data. |
Args:
boundary: The multipart boundary. This is required, and must match what is given in the HTTP request - usually in the Content-Type header.
callbacks: A dictionary of callbacks. See the documentation for [`BaseParser`][python_multipart.BaseParser].
max_size: The maximum size of body to parse. Defaults to infinity - i.e. unbounded.
max_header_count: The maximum number of headers allowed per part.
max_header_size: The maximum size of a single header line (excluding the trailing CRLF).
ry )max_header_countmax_header_sizec > [ TU ] 5 [ R U l S=U l U l X l [ U[ 5 ( a US: a [ SU- 5 eX0l SU l X@l
SU l XPl SU l 0 U l [ U[$ 5 ( a UR' S5 n[) U5 [* : a [- S[) U5 S[* 35 eSU- U l g )Nr r
r| r zBoundary length z exceeds maximum of s
--)r} r rs r r indexflagsr` r r r r r r _current_header_countr _current_header_sizemarksr r r MAX_BOUNDARY_LENGTHr boundary)r r r` r r r r s r r MultipartParser.__init__ s #))
"##
TZ"(F++x!| IH TU U
0 %&" . $%! &(
h $ $ y1H x=. .!$4S]OCWXkWl"mn n!H,
r" c [ U5 nU R U- U R : aW [ U R U R -
5 nU R R SU R U R UU5 UnSn U R
X5 nU =R U-
sl U$ ! U =R U-
sl f = f)a Write some data to the parser, which will perform size verification,
and then parse the data into the appropriate location (e.g. header,
data, etc.), and pass this on to the underlying callback. If an error
is encountered, a MultipartParseError will be raised. The "offset"
attribute on the raised exception will be set to the offset of the byte
in the input chunk that caused the error.
Args:
data: The data to write to the parser.
Returns:
The number of bytes written.
r r r r s r r MultipartParser.write r r c ^ ^^^^^^ T R m[ T5 mT R nT R nT R nT R
nT R mSmS#S$UUU 4S jjjnS%UU 4S jjnS&S'U 4S jjjn S&S(UUUUU 4S jjjn
TT: Ga TT n U[ R :X aK U [ :X d
U [ :X a TR ST5 mTS:X a TmGOgMR Sn[ R nTS- mGO>U[ R :X Ga UTS -
:X aW U [ :X a [ R nO5U [ :w a+ S
T4- n T R R! U 5 [# U TS 9eUS-
nGOUTS-
:X a^ U [ :w a+ S T4- n T R R! U 5 [# U TS 9eSnT R% S
5 SnSm[ R& nGObU TUS - :w a5 STUS - XS - 4- n T R R! U 5 [# U TS 9eUS-
nGOU[ R& :X ag SnU [ :w a! US-
nUT R( : a
[# STS 9eSmU" S5 U [ :w a T R% S5 [ R* nTS- mGOU[ R* :X Ga7 U [ :X a& US:X a U " S5 [ R, nTS-
mGMO TR STT5 n
U
S:w a U
OTnU" U
S:X a UT-
OUT-
S- 5 TTU nUR/ S [0 5 ( aR [3 S U 5 5 nTUR U5 - nSUU4- n T R R! U 5 [# U US 9eXNT-
-
nU
S:X a TmGOUS:X a+ ST4- n T R R! U 5 [# U TS 9eU
mU
" ST5 [ R4 nGOSU[ R4 :X a8 U [6 :X a U" 5 TS-
mGM U" S5 [ R8 nTS- mGOU[ R8 :X ab TR STT5 nUS:w a UOTnU" UT-
5 US:w a0 UmU
" ST5 T R% S5 Sm[ R: nGOTmGOU[ R: :X aH U [ :w a, SU < S3n T R R! U 5 [# U TS 9e[ R& nGO5U[ R, :X aY U [ :w a, SU < S3n T R R! U 5 [# U TS 9eT R% S 5 [ R< nGOU[ R< :X a U" S 5 [ R> nTS- mGOU[ R> :X Ga UnUS:X a{ TR TTT5 nUS: a TS-
nUT- S-
mTT n OOTRA TS S [C TTT-
S- 5 T5 nUS:w a TRE TUT 5 ( a TU-
nTmGM UT: a TU U :X a US-
nGOSnGOUT:X a0 US-
nU [ :X a
U[F - nOU [ :X a
U[H - nOSnOUTS- :X a U[F - ( am U [ :X aV U[F ) - nU
" S TU-
5 T R% S 5 T R% S
5 SnSmSn[ R& nTS-
mGMs SnU[F ) - nOYU[H - ( aK U [ :X a? U
" S TU-
5 T R% S 5 T R% S 5 [ RJ nOSnUS:X a
US: a SnTS- mOU[ R :X ae UTS-
:X a[ U [ :w a+ S T4- n T R R! U 5 [# U TS 9eUS-
nT R% S 5 [ RJ nOCU[ RJ :X a TmO:S!UT4- n T R R! U 5 [# U TS 9eTS-
mTT: a GM U
" STS"5 U
" STS"5 U
" S TU-
S"5 UT l UT l UT l UT l TT l T$ ))Nr r
c D > TU -
mTTR : a
[ STS9eg )Nz Maximum header size exceededr )r r )amountcurrent_header_sizer r s r advance_header_size.advance_header_sizeC s0 6 ) "T%9%99)*HQRSS :r" c $ > TTR U ' g r )r )r r r s r set_mark1MultipartParser._internal_write..set_markJ s DJJt r" c > > TR R U S 5 g r )r rh )r resetr s r delete_mark4MultipartParser._internal_write..delete_markN s JJNN4 &r" c Z > T
R R U 5 nUc g X:: a OUS: a T
R U TX15 OU* nUT:: a T
R U TSU5 O}T
R [ - ( a TS- nT
R XSU5 OLT
R [
- ( a TS- nT
R XSU5 OT
R R S5 US: a T
R U TSU5 U( a UT -
T
R U ' g T
R R U S 5 g )Nr s
s --
zLook-back buffer error) r r? re r FLAG_PART_BOUNDARYFLAG_LAST_BOUNDARYr r1 rh ) r end_i remaining marked_indexlookbehind_lenlookbackr boundary_lengthr[ r r s r
data_callback6MultipartParser._internal_write..data_callbackV s ::>>$/L# $ "
dD,> #/ !_4MM$!^DZZ"44 '' 1HMM$!^DZZ"44 ') 3HMM$!^DKK''(@A19MM$a7 #(6>
4
tT*r" -r rm z'Did not find CR at end of boundary (%d)r z'Did not find LF at end of boundary (%d)ra z2Expected boundary character %r, got %r at index %dz Maximum header count exceededre rd :c 3 < # U H o[ ; d M Uv M g 7fr )TOKEN_CHARS_SET).0bs r 2MultipartParser._internal_write.. s L%QO3Kqq%s
z*Found invalid character %r in header at %dzFound 0-length header at %drf
rg z2Did not find LF character at end of header (found r z)Did not find LF at end of headers (found rh rb rc r\ z&Did not find - at end of boundary (%d)r T)r
)r r# r$ r )r r r$ r )F)r r r rM r$ r )r ri r r# r rM r$ r )&r r r r r r r rs r CRLFr r HYPHENr r r1 r re r r r r translate TOKEN_CHARSnextr SPACEr r r r rfindmax
startswithr r r )r r[ r r r r current_header_countr r r r cr colonr\ fieldbadbad_icr
prev_indexi0kr r r r s ``` @@@@r r MultipartParser._internal_write3 s == h-
# 9 9 " 7 7
T T ! ! ' '% + % +P &jQA,,,7a2g $*ABw " '55Q.777 Oa //F{ . ; ;b G1$ N ++C0 1#a @@QJEo 11Bw G1$ N ++C0 1#a @@ E MM,/+,(*+' + = =E HUQY // RV^_dgh_hViklvwnwUx x ++C0 1#a @@ QJE.;;; 7(A-(+d.C.CC 12QZ[ \\*+' ( 7MM.1 '33Q.555 7uz / * > >EFA $62 ${e $u{C!Ga! L Qs ??455 L% LLC C 0 0EF#u UCKK'',-c%@@q B; A z ;qd B ++C0 1#a @@ A!.!4 + = =E.;;;:')FA ( '33Q.555 YYua0 "Hb&#C!G,8A!.!4MM,/*+' * C CE A.AAA7 NqeSTUCKK'',-c!<<
'99.<<< 7 EaU!LCKK'',-c!<<
01&66.888% '00Q.222 #
A: 8Q7BQw /! 3 01 4 G !JJx|SF_'J'J$*QJE # ?* !+
! o-QJE Bw !33 f !33
!" o 11 11 7 !&8%8 8E *+q5y A !MM* 5 MM, 734 023 / %&E$2$E$EE FA $ !" "4!44 !33 ; )+q5y A !MM* 5 MM% 0$2$6$6E %&E A:*q.!"J FA.555Oa //F{ F! M ++C0 1#a @@QJEMM%( * . .E.,,, :UAJF ##C()#a88
FAi
&j|
nfd3nfd3k6E>48
%9"$7!
r" c g)a Finalize this parser, which signals to that we are finished parsing.
Note: It does not currently, but in the future, it will verify that we
are in the final state of the parser (i.e. the end of the multipart
message is well-formed), and, if not, throw an error.
Nr r s r r MultipartParser.finalize s
r" c P U R R SU R < S3$ )Nz
(boundary=r )r r& r r s r r MultipartParser.__repr__ s% ..))**T]]4EQGGr" ) r r r r r` r r r r r r r ) r z bytes | strr` r> r rV r r# r r# r$ r r r r r )r& r' r( r) rn rV DEFAULT_MAX_HEADER_COUNTDEFAULT_MAX_HEADER_SIZEr r r r r r* r r s @r r r s 2 )+ , #- !9 6#- #- &#- #-
#- #-
#- #-J"Hvp
H Hr" r c
\ rS rSr% Sr\" S5 \\SSSSSSS. rS \ S
' SSS0 4 SS jjr
SS jr SS
jr SS jr
SS jrSrg)
FormParseri aj This class is the all-in-one form parser. Given all the information
necessary to parse a form, it will instantiate the correct parser, create
the proper :class:`Field` and :class:`File` classes to store the data that
is parsed, and call the two given callbacks with each field and file as
they become available.
Args:
content_type: The Content-Type of the incoming request. This is used to select the appropriate parser.
on_field: The callback to call when a field has been parsed and is ready for usage. See above for parameters.
on_file: The callback to call when a file has been parsed and is ready for usage. See above for parameters.
on_end: An optional callback to call when all fields and files in a request has been parsed. Can be None.
boundary: If the request is a multipart/form-data request, this should be the boundary of the request, as given
in the Content-Type header, as a bytestring.
file_name: If the request is of type application/octet-stream, then the body of the request will not contain any
information about the uploaded file. In such cases, you can provide the file name of the uploaded file
manually.
config: Configuration to use for this FormParser. The default values are taken from the DEFAULT_CONFIG value,
and then any keys present in this dictionary will overwrite the default values.
ry NTF) rW rX rY rQ rL rN rO rP rU rS DEFAULT_CONFIGc J ^ ^^^^^^^^^ ^ ^ ^ [ R " [ 5 T l UT l UT l ST l S T l TT l TT l UT l
T R R 5 T l
T R R U5 S nUS:X a: S mS"UUU 4S jjn S#U4S jjn
S"UUU 4S jjn [ XU S.T R S S9nGOCUS :X d US
:X aJ / m S mS"S jn S#U 4S jjn
S#UU 4S
jjnS"UU U4S jjnS"U 4S jjn [! U U
UUU S.T R S S9nOUS:X a Uc& T R R# S5 [% S5 e/ m/ m0 m S mS m Sm S"U 4S jjnS#U 4S jjnS"UU UU4S jjnS#U4S jjnS#U4S jjnS"UUU 4S jjnS"UU U U U 4S jjnS"U U 4S jjn [' UUUUUUUUU S .T R S T R S T R S S 9nO*T R R) S U5 [% S!U 35 eUT l g )$Nr zapplication/octet-streamc 0 > [ TS TR S9m g )N)r )r r )filer r s r r; %FormParser.__init__..on_start? s ItDKK@r" c 6 > Tc eTR XU 5 g r r )r[ rZ r\ r s r r< $FormParser.__init__..on_dataC s '''
4c?+r" c > T c eT R 5 T( a T" T 5 TR b TR 5 g g r r r4 )r on_filer s r _on_end$FormParser.__init__.._on_endH s> '''
DM ;;*KKM +r" )r; r< r4 rW )r` r z!application/x-www-form-urlencodedzapplication/x-url-encodedc g r r r r" r r/ +FormParser.__init__..on_field_starta s r" c , > TR XU 5 g r r )r[ rZ r\ name_buffers r r1 *FormParser.__init__..on_field_named ""4c?3r" c p > Tc [ SR T5 5 mTS S 2 TR XU 5 g Nr" )r r r )r[ rZ r\ r r s r r2 *FormParser.__init__..on_field_datag s2 9 chh{ 34A#A3(r" c > T c/ [ SR T5 5 m TS S 2 T R 5 T R 5 T( a T" T 5 S m g r )r r r r )r r on_fields r r3 )FormParser.__init__..on_field_endn sG 9 chh{ 34A#AJJL
QKr" c B > T R b T R 5 g g r r r s r r r } s ;;*KKM +r" )r/ r1 r2 r3 r4 zmultipart/form-datazNo boundary givenFc
> 0 m g r r )headerss r r@ *FormParser.__init__..on_part_begin s
r" c 6 > Tc eTR XU 5 g r r )r[ rZ r\ writers r rA )FormParser.__init__..on_part_data s ))) T_-r" c > T c eT R 5 T( a( T( a [ T [ 5 ( d eT" T 5 g g T( a [ T [ 5 ( d eT" T 5 g g r )r r r r )f_multiis_filer r
s r rB (FormParser.__init__..on_part_end sf *** " )'4 8 88 8 ( )'5 9 99 9 ) r" c , > TR XU 5 g r r )r[ rZ r\ header_names r rD ,FormParser.__init__..on_header_field r r" c , > TR XU 5 g r r )r[ rZ r\ rf s r rE ,FormParser.__init__..on_header_value s ##DsO4r" c | > SR T5 TSR T 5 R 5 ' T S S 2 TS S 2 g r )r r )r& rf r s r rF *FormParser.__init__..on_header_end s6 9<,9O-3356 N Or" c d > Sm
T R S5 n [ U 5 u pUR S5 nUR S5 nUc [ SU < S35 eT R S5 nUb UR S5 OS nUc
[ X6S 9mO[ XCT R US
9mS m
T R S S
5 R 5 nUS; a Tm g US:X a [ T5 m g US:X a [ T5 m g T R R SU5 T R S ( a [ SU< S35 eTm g )NFs content-dispositions names filenamez.Field name not found in Content-Disposition: "r s content-typer r )r r Ts content-transfer-encoding 7bit)s binarys 8bitr- s base64s quoted-printablez%Unknown Content-Transfer-Encoding: %rrU z#Unknown Content-Transfer-Encoding ") r? r r r r r r r r r r r1 )
content_dispdispr r^ r content_type_br transfer_encodingr" r r# r r s
r rG 0FormParser.__init__..on_headers_finished sG '{{+A B 4\ B
%[[ 1
#KK 4 %),Z[gZjjk*lmm ")_!=CQC]~ 4 4Y ?cg $ #J JG "9[g hG "G %,KK0Lg$V$\$\$^!$(EE $F&)3 *7 3F&*== 3G Tb TR 5 T R b T R 5 g g r r )r r s r r r s+ %OO%;;*KKM +r" )r@ rA rB rD rE rF rG r4 rX rY )r` r r r zUnknown Content-Type: %rzUnknown Content-Type: r )r[ r% rZ r# r\ r# r$ r )r r
r& r r r bytes_receivedparserr r
r4 r copyr updaterx r errorr r r1 ) r r r r
r4 r r r r5 r; r< r r/ r1 r2 r3 r@ rA rB rD rE rF rG r r" r r& rf r r# r r s ` `` ` @@@@@@@@@r r FormParser.__init__ sG ''1 )
!
)-(;(;(@(@(B 6"QU 5 5 $D
A
A
,
"
" ''/wW _5F
@
@LToDo')K "A
4
)
)
"
'&4%2%2$0 % _5 F 2
2 !!"56%&9::')K(*L*,G+/GSWFG
.
*
*
4
5
$
$
0
) 0
)d
"
" %%2$0#.'6'6%2+> % _5!%-?!@ $ ,= > F$
KK :L I!$:<."IJ J r" c U =R [ U5 -
sl U R c eU R R U5 $ )zWrite some data. The parser will forward this to the appropriate
underlying parser.
Args:
data: The data to write.
Returns:
The number of bytes processed.
)r4 r r5 r r s r r FormParser.write s>
s4y({{&&&{{ &&r" c U R b7 [ U R S5 ( a U R R 5 ggg)zFinalize the parser.Nr )r5 hasattrr r s r r FormParser.finalize s5 ;; "wt{{J'G'G KK " (H "r" c U R b7 [ U R S5 ( a U R R 5 ggg)zClose the parser.Nr )r5 r= r r s r r FormParser.close" s5 ;; "wt{{G'D'D KK (E "r" c l U R R SU R < SU R < S3$ )Nz(content_type=z , parser=r )r r& r r5 r s r r FormParser.__repr__' s6 ..))*.9J9J8MYW[WbWbVeefggr" ) r r4 r r r r4 r r
r5 )r r r Callable[[Field], None] | Noner
Callable[[File], None] | Noner4 zCallable[[], None] | Noner zbytes | str | Noner r r dict[Any, Any]r$ r r r r )r& r' r( r) rn rV r r r r6 r r r r r r* r r" r r r s . u 42 / ! %"'#( (N$ $ -1'+"&!#n n 1n / n
* n %
n n n
n `
' #
hr" r c
U R S5 nUc4 [ R " [ 5 R S5 [ S5 e[
U5 u pEUR S5 nUR S5 n[ XAX&US9nU$ )a1 This function is a helper function to aid in creating a FormParser
instances. Given a dictionary-like headers object, it will determine
the correct information needed, instantiate a FormParser with the
appropriate values and given callbacks, and then return the corresponding
parser.
Args:
headers: A dictionary-like object of HTTP headers. The only required header is Content-Type.
on_field: Callback to call with each parsed field.
on_file: Callback to call with each parsed file.
config: Configuration variables to pass to the FormParser.
z Content-Typez No Content-Type header givenz No Content-Type header given!s boundaryr )r r ) r? r r
r& r1 r r r r )r r r
r r paramsr form_parsers r create_form_parserrI + s $ (/{{>'BL(#++,JK899 0 =Lzz+&H &&y1L \WX^_K r" c US: a [ SU< 35 e[ XU5 nU R S5 nUb [ U5 nUS: a [ S5 eO [ S5 nSn [ [ Xg-
U5 5 nUR
U5 n UR U 5 U[ U 5 -
n[ U 5 U:w d Xv:X a OM^ UR 5 g)a This function is useful if you just want to parse a request body,
without too much work. Pass it a dictionary-like object of the request's
headers, and a file-like object for the input stream, along with two
callbacks that will get called whenever a field or file is parsed.
Args:
headers: A dictionary-like object of HTTP headers. The only required header is Content-Type.
input_stream: A file-like object that represents the request body. The read() method must return bytestrings.
on_field: Callback to call with each parsed field.
on_file: Callback to call with each parsed file.
chunk_size: The maximum size to read from the input stream and write to the parser at one time.
Defaults to 1 MiB.
r
z*chunk_size must be a positive number, not zContent-LengthNr z#Content-Length must be non-negativery )
r rI r? r# rV minr r r r )
r input_streamr r
chunk_sizer5 content_length
bytes_read max_readablebuffs
r
parse_formrR Q s ( A~Ej^TUU 7
;F 29=M1NN! ^, A BC C u J
3~ :JGH . Tc$i
t9 $
(D OOr" )r r r$ z list[str])r rK r$ z tuple[bytes, dict[bytes, bytes]])
r dict[str, bytes]r rC r
rD r rE r$ r )r ) r rS rL r r rC r
rD rM r# r$ r )H
__future__r r r r4 rC rE enumr ior r numbersr typingr r decodersr r
exceptionsr
r r r collections.abcr r r r r r r r, r9 r> rI rS ri r6 r r rk rs r r r r COLONr r r LOWER_ALOWER_ZNULLr frozensetr r r r r r r r r^ rx r r r rI rR r r" r ra s" "
& & ; ^ ^(CC/x /#y ##y #
#Ye #"Ye " : & L) & 8 w
W
.
K( C$ X :!,HDW DWN{j {j|I0 I0XA0
A0H[
[
|dHj dHNnh nhj #
#,# +#
#
#V 4
4 4 -4 + 4
4
4r"