U d? @s$ddlZzddlmZWn ek r8ddlmZYnXddlmZddlmZm Z ddl m Z m Z ddl mZddlmZmZdd lmZdd lmZdd lmZGd d d eZddddddddZdddddddZededededddiZ d Z!Gd!d"d"e"Z#Gd#d$d$e"Z$d%d&Z%dS)'N)Hashable)deepcopy) current_apprequest) MultiDict FileStorage) exceptions)abort SpecsError)marshal)Model) HTTPStatusc@s eZdZdZddZddZdS) ParseResultz9 The default result container as an Object dict. cCs,z ||WStk r&t|YnXdSN)KeyErrorAttributeError)selfnamer8/tmp/pip-unpacked-wheel-dt_sn2ih/flask_restx/reqparse.py __getattr__s zParseResult.__getattr__cCs |||<dSrr)rrvaluerrr __setattr__szParseResult.__setattr__N)__name__ __module__ __qualname____doc__rrrrrrrsrz the JSON bodyz the post bodyzthe query stringz!the post body or the query stringzthe HTTP headerszthe request's cookieszan uploaded file)jsonformargsvaluesheaderscookiesfilesqueryformDataheaderbody)r rr"rr!r$integerstringbooleannumbervoid,c@sdeZdZdZddddedddddddddfd d Zd d Zd dZddZdddZ e ddZ dS)Argumenta: :param name: Either a name or a list of option strings, e.g. foo or -f, --foo. :param default: The value produced if the argument is absent from the request. :param dest: The name of the attribute to be added to the object returned by :meth:`~reqparse.RequestParser.parse_args()`. :param bool required: Whether or not the argument may be omitted (optionals only). :param string action: The basic type of action to be taken when this argument is encountered in the request. Valid options are "store" and "append". :param bool ignore: Whether to ignore cases where the argument fails type conversion :param type: The type to which the request argument should be converted. If a type raises an exception, the message in the error will be returned in the response. Defaults to :class:`str`. :param location: The attributes of the :class:`flask.Request` object to source the arguments from (ex: headers, args, etc.), can be an iterator. The last item listed takes precedence in the result set. :param choices: A container of the allowable values for the argument. :param help: A brief description of the argument, returned in the response when the argument is invalid. May optionally contain an "{error_msg}" interpolation token, which will be replaced with the text of the error raised by the type converter. :param bool case_sensitive: Whether argument values in the request are case sensitive or not (this will convert all values to lowercase) :param bool store_missing: Whether the arguments default value should be stored if the argument is missing from the request. :param bool trim: If enabled, trims whitespace around the argument. :param bool nullable: If enabled, allows null value in argument. NF)rr!rstore)=TcCs^||_||_||_||_||_||_||_||_| |_| |_ | |_ | |_ | |_ ||_ ||_dSr)rdefaultdestrequiredignorelocationtypechoicesactionhelpcase_sensitive operators store_missingtrimnullable)rrr2r3r4r5r7r6r8r9r:r<r;r=r>r?rrr__init___szArgument.__init__cCst|jtrP|jdkr$|jdd}nt||jt}t|rB|}|dk r|SnXt}|jD]F}|dkrv|jdd}n t||d}t|r|}|dk r\||q\|StS)z Pulls values off the request in the provided location :param request: The flask request object to parse arguments from >rget_jsonT)ZsilentN) isinstancer6strrAgetattrrcallableupdate)rrrr!lrrrsources&     zArgument.sourcec Cs|dkr|jstddSt|jtrsz"Argument.parse..splitcsg|]}|qSr)rO)r_voperatorrrrrasNz0The value '{0}' is not a valid choice for '{1}'.cSsg|]}t||qSr)_friendly_locationget)r_locrrrra sz or z!Missing required parameter in {0}appendr0r)"rconfigrgrHr<rreplacehasattrr[r>r\r;r]r8r9rb SPLIT_CHARrO Exceptionr5rYformatunparsed_argumentspoprir4rBr6rCrfrTrEr2len)rrrWrHresultsZ _not_foundZ_foundrr!rrVmsgr6 locationsrXrrdrparsesj          *          zArgument.parsecCs|jdkrdS|jt|jdd}t|||jrrW)rrrr>rWrrrr@Ns zRequestParser.__init__cOslt|dkr.t|d|jr.|j|dn|j|j|||jrh|jtkrh|d|j|jd_|S)a Adds an argument to be parsed. Accepts either a single instance of Argument or arguments to be passed into :class:`Argument`'s constructor. See :class:`Argument`'s constructor for documentation on the available options. r rr>)rrrBrr rir>r/rg)rr kwargsrrr add_argument[s zRequestParser.add_argumentNc Cs|dkr t}|}|r,t|d|ni|_i}|jD]H}|||j\}}t |t rj| |d}|st|j r<|||j p|j<q<|rttjd|d|r|jrd|j}d|} t| |S)aN Parse all arguments from the provided request and return the results as a ParseResult :param bool strict: if req includes args not in parser, throw 400 BadRequest exception :return: the parsed results as :class:`ParseResult` (or any class defined as :attr:`result_class`) :rtype: ParseResult NrZrQrRz, zUnknown arguments: {0})rrrJrrHrpr rvrWrBrIrFr=r3rr rrUrTkeysrorZ BadRequest) rreqstrictresultrSargrfound argumentsrtrrr parse_argsqs0       zRequestParser.parse_argscCs0||j|j}t|j|_|j|_|j|_|S)zCCreates a copy of this RequestParser with the same set of arguments) __class__rrrr r>rW)rZ parser_copyrrrcopys  zRequestParser.copycOsV|j|f||}t|jddD],\}}|j|jkr$|j|=|j|qRq$|S)z@Replace the argument matching the given name with a new version.N)r enumerater rri)rrr rZnew_argindexrrrrreplace_arguments  zRequestParser.replace_argumentcCs6t|jddD]\}}||jkr|j|=q2q|S)z,Remove the argument matching the given name.N)rr r)rrrrrrrremove_arguments  zRequestParser.remove_argumentcCsTg}t}|jD]&}|j}|r||||dqd|krPd|krPtd|S)Nrxr(r&z,Can't use formData and body at the same time)setr rriaddr )rparamsrurrrrrrs  zRequestParser.__schema__)NF)rrrrr/rr@rrrrrrrrrrrr<s  & rcCst|jtr&|jtkr&t|j|d<n^t|jdrL|jjd|d<d|d<n8t|jdrh||jjn|jdkr|d|d<nd |d<dS) Nr7 __apidoc__rr(rxrr$filer*) rBr7rPY_TYPESrlrrFrr6)rrrrrrs     r)&rLcollections.abcr ImportError collectionsrrZflaskrrZwerkzeug.datastructuresrrZwerkzeugrrSr r Z marshallingr modelr Z_httprrJrrfrintrCboolfloatrrmobjectr/rrrrrrsZ       {