Dashboard
PHP:
8.3.33
OS:
Linux
User:
letter7
/
/
usr
/
libexec
/
oracle-cloud-agent
/
plugins
/
osms
/
falcon
📤 Upload
📝 New File
📁 New Folder
Close
Editing: request.pyc
a [��fA � @ s. d Z ddlmZ zddlZejZW n eyB ddlZejZY n0 ddlm Z ddl m Z ddl Z ddl Z ddlmZ ddlmZ ddlmZ dd lmZ dd lmZ dd lmZ dd lmZ dd lmZ ddlm Z ddl m Z m Z ej Z dZ!dZ"dZ#dZ$ej%Z%ej&Z&G dd� de'�Z(G dd� de'�Z)dS )zRequest class.� )�datetimeN)�UUID)� InputWrapper)� http_cookies)�DEFAULT_MEDIA_TYPE)�errors)�request_helpers)�util)�_parse_forwarded_header)� Forwarded)�Handlers)�json)� parse_host�parse_query_stringz5{0:%Y-%m-%d %H:%M:%S} [FALCON] [ERROR] {1} {2}{3} => )�true�True�yes�1�on)�false�False�no�0�off)� CONTENT_TYPE�CONTENT_LENGTHc @ s� e Zd ZdZdZeZdZdZdndd�Z dd� Z e � d �Z e � d �Ze � d �Ze � d �Ze � d �Ze � d�Ze � d�Zedd� �Zedd� �Zedd� �Zedd� �Zedd� �Zedd� �Zed d � �Zed d � �Z ed d!� �Z ed"d#� �Z ed$d%� �Z ed&d'� �Z ed(d)� �Z!ed*d+� �Z"ed,d-� �Z#e"Z$ed.d/� �Z%e%Z&ed0d1� �Z'ed2d3� �Z(ed4d5� �Z)ed6d7� �Z*ed8d9� �Z+ed:d;� �Z,ed<d=� �Z-ed>d?� �Z.ed@dA� �Z/edBdC� �Z0edDdE� �Z1edFdG� �Z2edHdI� �Z3edJdK� �Z4edLdM� �Z5dNdO� Z6dPdQ� Z7dodRdS�Z8dpdTdU�Z9dqdVdW�Z:drdXdY�Z;dsdZd[�Z<dtd\d]�Z=dud^d_�Z>dvdadb�Z?dwddde�Z@dxdfdg�ZAeAZBdhdi� ZCdjdk� ZDdldm� ZEdS )y�Requesta�; Represents a client's HTTP request. Note: `Request` is not meant to be instantiated directly by responders. Args: env (dict): A WSGI environment dict passed in from the server. See also PEP-3333. Keyword Arguments: options (dict): Set of global options passed from the API handler. Attributes: env (dict): Reference to the WSGI environ ``dict`` passed in from the server. (See also PEP-3333.) context (dict): Dictionary to hold any data about the request which is specific to your app (e.g. session object). Falcon itself will not interact with this attribute after it has been initialized. context_type (class): Class variable that determines the factory or type to use for initializing the `context` attribute. By default, the framework will instantiate standard ``dict`` objects. However, you may override this behavior by creating a custom child class of ``falcon.Request``, and then passing that new class to `falcon.API()` by way of the latter's `request_type` parameter. Note: When overriding `context_type` with a factory function (as opposed to a class), the function is called like a method of the current Request instance. Therefore the first argument is the Request instance itself (self). scheme (str): URL scheme used for the request. Either 'http' or 'https'. Note: If the request was proxied, the scheme may not match what was originally requested by the client. :py:attr:`forwarded_scheme` can be used, instead, to handle such cases. forwarded_scheme (str): Original URL scheme requested by the user agent, if the request was proxied. Typical values are 'http' or 'https'. The following request headers are checked, in order of preference, to determine the forwarded scheme: - ``Forwarded`` - ``X-Forwarded-For`` If none of these headers are available, or if the Forwarded header is available but does not contain a "proto" parameter in the first hop, the value of :attr:`scheme` is returned instead. (See also: RFC 7239, Section 1) protocol (str): Deprecated alias for `scheme`. Will be removed in a future release. method (str): HTTP method requested (e.g., 'GET', 'POST', etc.) host (str): Host request header field forwarded_host (str): Original host request header as received by the first proxy in front of the application server. The following request headers are checked, in order of preference, to determine the forwarded scheme: - ``Forwarded`` - ``X-Forwarded-Host`` If none of the above headers are available, or if the Forwarded header is available but the "host" parameter is not included in the first hop, the value of :attr:`host` is returned instead. Note: Reverse proxies are often configured to set the Host header directly to the one that was originally requested by the user agent; in that case, using :attr:`host` is sufficient. (See also: RFC 7239, Section 4) port (int): Port used for the request. If the request URI does not specify a port, the default one for the given schema is returned (80 for HTTP and 443 for HTTPS). netloc (str): Returns the 'host:port' portion of the request URL. The port may be ommitted if it is the default one for the URL's schema (80 for HTTP and 443 for HTTPS). subdomain (str): Leftmost (i.e., most specific) subdomain from the hostname. If only a single domain name is given, `subdomain` will be ``None``. Note: If the hostname in the request is an IP address, the value for `subdomain` is undefined. app (str): The initial portion of the request URI's path that corresponds to the application object, so that the application knows its virtual "location". This may be an empty string, if the application corresponds to the "root" of the server. (Corresponds to the "SCRIPT_NAME" environ variable defined by PEP-3333.) uri (str): The fully-qualified URI for the request. url (str): Alias for `uri`. forwarded_uri (str): Original URI for proxied requests. Uses :attr:`forwarded_scheme` and :attr:`forwarded_host` in order to reconstruct the original URI requested by the user agent. relative_uri (str): The path and query string portion of the request URI, omitting the scheme and host. prefix (str): The prefix of the request URI, including scheme, host, and WSGI app (if any). forwarded_prefix (str): The prefix of the original URI for proxied requests. Uses :attr:`forwarded_scheme` and :attr:`forwarded_host` in order to reconstruct the original URI. path (str): Path portion of the request URI (not including query string). Note: `req.path` may be set to a new value by a `process_request()` middleware method in order to influence routing. query_string (str): Query string portion of the request URI, without the preceding '?' character. uri_template (str): The template for the route that was matched for this request. May be ``None`` if the request has not yet been routed, as would be the case for `process_request()` middleware methods. May also be ``None`` if your app uses a custom routing engine and the engine does not provide the URI template when resolving a route. remote_addr(str): IP address of the closest client or proxy to the WSGI server. This property is determined by the value of ``REMOTE_ADDR`` in the WSGI environment dict. Since this address is not derived from an HTTP header, clients and proxies can not forge it. Note: If your application is behind one or more reverse proxies, you can use :py:attr:`~.access_route` to retrieve the real IP address of the client. access_route(list): IP address of the original client, as well as any known addresses of proxies fronting the WSGI server. The following request headers are checked, in order of preference, to determine the addresses: - ``Forwarded`` - ``X-Forwarded-For`` - ``X-Real-IP`` If none of these headers are available, the value of :py:attr:`~.remote_addr` is used instead. Note: Per `RFC 7239`_, the access route may contain "unknown" and obfuscated identifiers, in addition to IPv4 and IPv6 addresses .. _RFC 7239: https://tools.ietf.org/html/rfc7239 Warning: Headers can be forged by any client or proxy. Use this property with caution and validate all values before using them. Do not rely on the access route to authorize requests. forwarded (list): Value of the Forwarded header, as a parsed list of :class:`falcon.Forwarded` objects, or ``None`` if the header is missing. If the header value is malformed, Falcon will make a best effort to parse what it can. (See also: RFC 7239, Section 4) date (datetime): Value of the Date header, converted to a ``datetime`` instance. The header value is assumed to conform to RFC 1123. auth (str): Value of the Authorization header, or ``None`` if the header is missing. user_agent (str): Value of the User-Agent header, or ``None`` if the header is missing. referer (str): Value of the Referer header, or ``None`` if the header is missing. accept (str): Value of the Accept header, or '*/*' if the header is missing. client_accepts_json (bool): ``True`` if the Accept header indicates that the client is willing to receive JSON, otherwise ``False``. client_accepts_msgpack (bool): ``True`` if the Accept header indicates that the client is willing to receive MessagePack, otherwise ``False``. client_accepts_xml (bool): ``True`` if the Accept header indicates that the client is willing to receive XML, otherwise ``False``. cookies (dict): A dict of name/value cookie pairs. (See also: :ref:`Getting Cookies <getting-cookies>`) content_type (str): Value of the Content-Type header, or ``None`` if the header is missing. content_length (int): Value of the Content-Length header converted to an ``int``, or ``None`` if the header is missing. stream: File-like input object for reading the body of the request, if any. This object provides direct access to the server's data stream and is non-seekable. In order to avoid unintended side effects, and to provide maximum flexibility to the application, Falcon itself does not buffer or spool the data in any way. Since this object is provided by the WSGI server itself, rather than by Falcon, it may behave differently depending on how you host your app. For example, attempting to read more bytes than are expected (as determined by the Content-Length header) may or may not block indefinitely. It's a good idea to test your WSGI server to find out how it behaves. This can be particulary problematic when a request body is expected, but none is given. In this case, the following call blocks under certain WSGI servers:: # Blocks if Content-Length is 0 data = req.stream.read() The workaround is fairly straightforward, if verbose:: # If Content-Length happens to be 0, or the header is # missing altogether, this will not block. data = req.stream.read(req.content_length or 0) Alternatively, when passing the stream directly to a consumer, it may be necessary to branch off the value of the Content-Length header:: if req.content_length: doc = json.load(req.stream) For a slight performance cost, you may instead wish to use :py:attr:`bounded_stream`, which wraps the native WSGI input object to normalize its behavior. Note: If an HTML form is POSTed to the API using the *application/x-www-form-urlencoded* media type, and the :py:attr:`~.RequestOptions.auto_parse_form_urlencoded` option is set, the framework will consume `stream` in order to parse the parameters and merge them into the query string parameters. In this case, the stream will be left at EOF. bounded_stream: File-like wrapper around `stream` to normalize certain differences between the native input objects employed by different WSGI servers. In particular, `bounded_stream` is aware of the expected Content-Length of the body, and will never block on out-of-bounds reads, assuming the client does not stall while transmitting the data to the server. For example, the following will not block when Content-Length is 0 or the header is missing altogether:: data = req.bounded_stream.read() This is also safe:: doc = json.load(req.bounded_stream) expect (str): Value of the Expect header, or ``None`` if the header is missing. media (object): Returns a deserialized form of the request stream. When called, it will attempt to deserialize the request stream using the Content-Type header as well as the media-type handlers configured via :class:`falcon.RequestOptions`. See :ref:`media` for more information regarding media handling. Warning: This operation will consume the request stream the first time it's called and cache the results. Follow-up calls will just retrieve a cached version of the object. range (tuple of int): A 2-member ``tuple`` parsed from the value of the Range header. The two members correspond to the first and last byte positions of the requested resource, inclusive. Negative indices indicate offset from the end of the resource, where -1 is the last byte, -2 is the second-to-last byte, and so forth. Only continous ranges are supported (e.g., "bytes=0-0,-1" would result in an HTTPBadRequest exception when the attribute is accessed.) range_unit (str): Unit of the range parsed from the value of the Range header, or ``None`` if the header is missing if_match (str): Value of the If-Match header, or ``None`` if the header is missing. if_none_match (str): Value of the If-None-Match header, or ``None`` if the header is missing. if_modified_since (datetime): Value of the If-Modified-Since header, or ``None`` if the header is missing. if_unmodified_since (datetime): Value of the If-Unmodified-Since header, or ``None`` if the header is missing. if_range (str): Value of the If-Range header, or ``None`` if the header is missing. headers (dict): Raw HTTP headers from the request with canonical dash-separated names. Parsing all the headers to create this dict is done the first time this attribute is accessed. This parsing can be costly, so unless you need all the headers in this format, you should use the `get_header` method or one of the convenience attributes instead, to get a value for a specific header. params (dict): The mapping of request query parameter names to their values. Where the parameter appears multiple times in the query string, the value mapped to that parameter key will be a list of all the values in the order seen. options (dict): Set of global options passed from the API handler. )�__dict__�_bounded_stream�_cached_access_route�_cached_forwarded�_cached_forwarded_prefix�_cached_forwarded_uri�_cached_headers�_cached_prefix�_cached_relative_uri� _cached_uri�_cookies�_params� _wsgierrors� content_type�context�env�method�options�path� query_string�stream� uri_template�_mediaFNc C s� || _ |r|nt� | _|d | _|d | _d | _d | _|d p@d}tjrZ|� d�� dd�}| jj r�t |�dkr�|� d�r�|d d � | _n|| _z|d | _W n ty� d | _i | _Y n*0 | jr�t| j| jj| jjd �| _ni | _d | _d | _d | _d | _d | _d | _d | _d | _ d | _ z| j d | _ W n t�yD d | _ Y n0 | j �sht |d t!t"f�t#_$dt#_ | j$�r�| �%� | _&| j&| _'n|d | _&d | _'| jj(�r�| j d u�r�d| j v �r�| jdv�r�| �)� | �*� | _+d S )Nz wsgi.errors�REQUEST_METHOD� PATH_INFO�/�latin1�utf-8�replace� ���� QUERY_STRING� ��keep_blank_qs_values� parse_qs_csvr � wsgi.inputTz!application/x-www-form-urlencoded)�GET�HEAD),r, �RequestOptionsr. r) r- r2 r3 �six�PY3�encode�decode� strip_url_path_trailing_slash�len�endswithr/ r0 �KeyErrorr( r r? �auto_parse_qs_csvr' r r r! r" r# r$ r% r& r* �_wsgi_input_type_known� isinstance� NativeStreamr r �_always_wrap_wsgi_input�_get_wrapped_wsgi_inputr1 r �auto_parse_form_urlencoded�_parse_form_urlencoded� context_typer+ )�selfr, r. r/ � rW �r/sparta/input/_build_configuration/image_build+validate/lib/bmcenv/lib64/python3.9/site-packages/falcon/request.py�__init__� s| �� � � ��� � zRequest.__init__c C s d| j j| j| jf S )Nz <%s: %s %r>)� __class__�__name__r- �url�rV rW rW rX �__repr__ s zRequest.__repr__�HTTP_USER_AGENT�HTTP_AUTHORIZATION� HTTP_EXPECT� HTTP_IF_MATCH�HTTP_IF_NONE_MATCH� HTTP_IF_RANGE� HTTP_REFERERc C s> | j d u r8z| jd }W n ty, Y d S 0 t|�| _ | j S )N�HTTP_FORWARDED)r r, rL r )rV � forwardedrW rW rX rg s zRequest.forwardedc C s | � d�S )Nzapplication/json��client_acceptsr] rW rW rX �client_accepts_json/ s zRequest.client_accepts_jsonc C s | � d�p| � d�S )Nzapplication/x-msgpackzapplication/msgpackrh r] rW rW rX �client_accepts_msgpack3 s �z Request.client_accepts_msgpackc C s | � d�S )Nzapplication/xmlrh r] rW rW rX �client_accepts_xml8 s zRequest.client_accepts_xmlc C s* z| j d pdW S ty$ Y dS 0 d S )N� HTTP_ACCEPT�*/*�r, rL r] rW rW rX �accept< s zRequest.acceptc C sx z| j d }W n ty" Y d S 0 |s,d S z t|�}W n" tyZ d}t�|d��Y n0 |dk rtd}t�|d��|S )Nr z)The value of the header must be a number.zContent-Lengthr z2The value of the header must be a positive number.)r, rL �int� ValueErrorr �HTTPInvalidHeader)rV �value� value_as_int�msgrW rW rX �content_lengthE s zRequest.content_lengthc C s | j d u r| �� | _ | j S �N)r rR r] rW rW rX �bounded_streama s zRequest.bounded_streamc C s | � d�S )N�Date��get_header_as_datetimer] rW rW rX �dateh s z Request.datec C s | � d�S )NzIf-Modified-Sincer{ r] rW rW rX �if_modified_sincel s zRequest.if_modified_sincec C s | � d�S )NzIf-Unmodified-Sincer{ r] rW rW rX �if_unmodified_sincep s zRequest.if_unmodified_sincec C s� z8| j d }d|v r&|�d�\}}}nd}t�|d��W n tyL Y d S 0 d|v rfd}t�|d��z\|�d�\}}}|s�t� �|r�t|�t|p�d�fW S |r�t|� dfW S d }t�|d��W n0 ty� d }d } d }tj|d|| d ��Y n0 d S )N� HTTP_RANGE�=�;The value must be prefixed with a range unit, e.g. 'bytes='�Range�,z%The value must be a continuous range.�-r; z The range offsets are missing.zhttp://goo.gl/zZ6EyzHTTP/1.1 Range Requestsz3It must be a range formatted according to RFC 7233.)�href� href_text)r, � partitionr rs rL rr rq ) rV rt �unit�sep� req_rangerv �first�lastr� r� rW rW rX �ranget s8 �z Request.rangec C sV z<| j d }d|v r*|�d�\}}}|W S d}t�|d��W n tyP Y d S 0 d S )Nr� r� r� r� )r, r� r rs rL )rV rt r� r� r� rv rW rW rX � range_unit� s zRequest.range_unitc C s& z | j d W S ty Y dS 0 d S )N� SCRIPT_NAMEr= ro r] rW rW rX �app� s z Request.appc C s | j d S )N�wsgi.url_scheme)r, r] rW rW rX �scheme� s zRequest.schemec C sV d| j v r"| jd }|jp | j}n0z| j d �� }W n tyP | j d }Y n0 |S )Nrf r �HTTP_X_FORWARDED_PROTOr� )r, rg r� �lowerrL )rV � first_hopr� rW rW rX �forwarded_scheme� s zRequest.forwarded_schemec C s4 | j d u r.| jd }|d | j | j }|| _ | j S �Nr� �://)r& r, �netloc� relative_uri)rV r� rt rW rW rX �uri� s ��z Request.uric C s, | j d u r&| jd | j | j }|| _ | j S �Nr� )r" r� �forwarded_hostr� )rV rt rW rW rX � forwarded_uri� s ��zRequest.forwarded_uric C s> | j d u r8| jr*| j| j d | j | _ n| j| j | _ | j S )N�?)r% r0 r� r/ r] rW rW rX r� � s �zRequest.relative_uric C s, | j d u r&| jd d | j | j | _ | j S r� )r$ r, r� r� r] rW rW rX �prefix� s ���zRequest.prefixc C s( | j d u r"| jd | j | j | _ | j S r� )r! r� r� r� r] rW rW rX �forwarded_prefix s ���zRequest.forwarded_prefixc C s< z| j d }t|�\}}W n ty6 | j d }Y n0 |S )N� HTTP_HOST� SERVER_NAME)r, r rL )rV � host_header�host�portrW rW rX r� s z Request.hostc C sN d| j v r"| jd }|jp | j}n(z| j d }W n tyH | j}Y n0 |S )Nrf r �HTTP_X_FORWARDED_HOST)r, rg r� rL )rV r� r� rW rW rX r� s zRequest.forwarded_hostc C s | j �d�\}}}|r|S d S )N�.)r� r� )rV � subdomainr� � remainderrW rW rX r� 6 s zRequest.subdomainc C sr | j d u rhi }| _ | j}|�� D ]D\}}|�d�rN|||dd � �dd�< q"|tv r"|||�dd�< q"| j �� S )N�HTTP_� �_r� )r# r, �items� startswithr9 �WSGI_CONTENT_HEADERS�copy)rV �headersr, �namert rW rW rX r� < s zRequest.headersc C s | j S rx )r( r] rW rW rX �paramsP s zRequest.paramsc C s� | j d u rv| jddd�}t� }|�d�D ](}z|�|� W q( tjyN Y q(0 q(i }|�� D ]}|j||j < q^|| _ | j � � S )N�Cookier= )�defaultz; ) r' � get_header� SimpleCookie�split�loadr � CookieError�valuesrt �keyr� )rV � cookie_header�parser� cookie_part�cookies�morselrW rW rX r� T s zRequest.cookiesc C s� | j d u r�d| jv rLg | _ | jD ](}|jd ur t|j�\}}| j �|� q nfd| jv rx| jd �d�}dd� |D �| _ n:d| jv r�| jd g| _ n d| jv r�| jd g| _ ng | _ | j S )Nrf �HTTP_X_FORWARDED_FORr� c S s g | ] }|� � �qS rW )�strip)�.0�iprW rW rX � <listcomp> � z(Request.access_route.<locals>.<listcomp>�HTTP_X_REAL_IP� REMOTE_ADDR)r r, rg �srcr �appendr� )rV �hopr� �__� addressesrW rW rX � access_routei s zRequest.access_routec C s | j �d�S )Nr� )r, �getr] rW rW rX � remote_addr� s zRequest.remote_addrc C sZ z4| j d }| j d dkr dnd}t||d�\}}W n tyT t| j d �}Y n0 |S )Nr� r� �http�P i� )� default_port� SERVER_PORT)r, r rL rq )rV r� r� r� r� rW rW rX r� � s z Request.portc C st | j }|d }z |d }W nT tyn |d }|d }|dkrV|dkrj|d| 7 }n|dkrj|d| 7 }Y n0 |S ) Nr� r� r� r� �https�443�:�80ro )rV r, �protocol� netloc_valuer� rW rW rX r� � s zRequest.netlocc C s> | j r | j S | jj�| j| jj�}| j�� }|�|�| _ | j S rx ) r3 r. �media_handlers�find_by_media_typer* �default_media_typery �read� deserialize)rV �handler�rawrW rW rX �media� s � z Request.mediac C sF | j }||ks|dkrdS zt�||�dkW S ty@ Y dS 0 dS )aT Determine whether or not the client accepts a given media type. Args: media_type (str): An Internet media type to check. Returns: bool: ``True`` if the client has indicated in the Accept header that it accepts the specified media type. Otherwise, returns ``False``. rn Tg FN)rp � mimeparse�qualityrr )rV � media_typerp rW rW rX ri � s zRequest.client_acceptsc C s6 zt �|| j�}W n ty( d}Y n0 |r2|S dS )a� Return the client's preferred media type, given several choices. Args: media_types (iterable of str): One or more Internet media types from which to choose the client's preferred type. This value **must** be an iterable collection of strings. Returns: str: The client's preferred media type, based on the Accept header. Returns ``None`` if the client does not accept any of the given types. r= N)r� � best_matchrp rr )rV � media_types�preferred_typerW rW rX �client_prefers� s zRequest.client_prefersc C sz |� � �dd�}z| jd| W S tyt |tv rZz| j| W Y S tyX Y n0 |sf| Y S t�|��Y n0 dS )a Retrieve the raw string value for the given header. Args: name (str): Header name, case-insensitive (e.g., 'Content-Type') Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning gracefully when the header is not found (default ``False``). default (any): Value to return if the header is not found (default ``None``). Returns: str: The value of the specified header if it exists, or the default value if the header is not found and is not required. Raises: HTTPBadRequest: The header was not found in the request, but it was required. r� r� r� N)�upperr9 r, rL r� r �HTTPMissingHeader)rV r� �requiredr� � wsgi_namerW rW rX r� � s zRequest.get_headerc C sX z | j ||d�}tj||d�W S ty2 Y dS tyR d}t�||��Y n0 dS )a| Return an HTTP header with HTTP-Date values as a datetime. Args: name (str): Header name, case-insensitive (e.g., 'Date') Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning gracefully when the header is not found (default ``False``). obs_date (bool): Support obs-date formats according to RFC 7231, e.g.: "Sunday, 06-Nov-94 08:49:37 GMT" (default ``False``). Returns: datetime: The value of the specified header if it exists, or ``None`` if the header is not found and is not required. Raises: HTTPBadRequest: The header was not found in the request, but it was required. HttpInvalidHeader: The header contained a malformed/invalid value. �r� )�obs_dateNz;It must be formatted according to RFC 7231, Section 7.1.1.1)r� r �http_date_to_dt� TypeErrorrr r rs )rV �headerr� r� � http_daterv rW rW rX r| - s z Request.get_header_as_datetimec C sR | j }||v r<|| }t|t�r(|d }|dur8|||< |S |sD|S t�|��dS )ak Return the raw value of a query string parameter as a string. Note: If an HTML form is POSTed to the API using the *application/x-www-form-urlencoded* media type, Falcon can automatically parse the parameters from the request body and merge them into the query string parameters. To enable this functionality, set :py:attr:`~.RequestOptions.auto_parse_form_urlencoded` to ``True`` via :any:`API.req_options`. Note: Similar to the way multiple keys in form data is handled, if a query parameter is assigned a comma-separated list of values (e.g., ``foo=a,b,c``), only one of those values will be returned, and it is undefined which one. Use :meth:`~.get_param_as_list` to retrieve all the values. Args: name (str): Parameter name, case-sensitive (e.g., 'sort'). Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is present. default (any): If the param is not found returns the given value instead of None Returns: str: The value of the param as a string, or ``None`` if param is not found and is not required. Raises: HTTPBadRequest: A required param is missing from the request. r; N)r( rO �listr �HTTPMissingParam)rV r� r� �storer� r� �paramrW rW rX � get_paramP s ( zRequest.get_paramc C s� | j }||v r�|| }t|t�r(|d }z t|�}W n" tyV d}t�||��Y n0 |dur�||k r�dt|� }t�||��|dur�||k r�dt|� }t�||��|dur�|||< |S |s�dS t�|��dS )a Return the value of a query string parameter as an int. Args: name (str): Parameter name, case-sensitive (e.g., 'limit'). Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found or is not an integer (default ``False``). min (int): Set to the minimum value allowed for this param. If the param is found and it is less than min, an ``HTTPError`` is raised. max (int): Set to the maximum value allowed for this param. If the param is found and its value is greater than max, an ``HTTPError`` is raised. store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: int: The value of the param if it is found and can be converted to an ``int``. If the param is not found, returns ``None``, unless `required` is ``True``. Raises HTTPBadRequest: The param was not found in the request, even though it was required to be there, or it was found but could not be converted to an ``int``. Also raised if the param's value falls outside the given interval, i.e., the value must be in the interval: min <= value <= max to avoid triggering an error. r; z The value must be an integer.NzThe value must be at least zThe value may not exceed ) r( rO r� rq rr r �HTTPInvalidParam�strr� ) rV r� r� �min�maxr� r� �valrv rW rW rX �get_param_as_int� s, $ zRequest.get_param_as_intc C s� | j }||v rl|| }t|t�r(|d }z t|�}W n" tyV d}t�||��Y n0 |durh|||< |S |stdS t�|��dS )ag Return the value of a query string parameter as an UUID. The value to convert must conform to the standard UUID string representation per RFC 4122. For example, the following strings are all valid:: # Lowercase '64be949b-3433-4d36-a4a8-9f19d352fee8' # Uppercase 'BE71ECAA-F719-4D42-87FD-32613C2EEB60' # Mixed '81c8155C-D6de-443B-9495-39Fa8FB239b5' Args: name (str): Parameter name, case-sensitive (e.g., 'id'). Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found or is not a UUID (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: UUID: The value of the param if it is found and can be converted to a ``UUID``. If the param is not found, returns ``None``, unless `required` is ``True``. Raises HTTPBadRequest: The param was not found in the request, even though it was required to be there, or it was found but could not be converted to a ``UUID``. r; z The value must be a UUID string.N)r( rO r� r rr r r� r� )rV r� r� r� r� r rv rW rW rX �get_param_as_uuid� s ' zRequest.get_param_as_uuidc C s� | j }||v rv|| }t|t�r(|d }|tv r6d}n,|tv rDd}n |rR|sRd}nd}t�||��|durr|||< |S |s~dS t�|��dS )a4 Return the value of a query string parameter as a boolean The following boolean strings are supported:: TRUE_STRINGS = ('true', 'True', 'yes', '1', 'on') FALSE_STRINGS = ('false', 'False', 'no', '0', 'off') Args: name (str): Parameter name, case-sensitive (e.g., 'detailed'). Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found or is not a recognized boolean string (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). blank_as_true (bool): If ``True``, an empty string value will be treated as ``True`` (default ``False``). Normally empty strings are ignored; if you would like to recognize such parameters, you must set the `keep_blank_qs_values` request option to ``True``. Request options are set globally for each instance of ``falcon.API`` through the `req_options` attribute. Returns: bool: The value of the param if it is found and can be converted to a ``bool``. If the param is not found, returns ``None`` unless required is ``True``. Raises: HTTPBadRequest: A required param is missing from the request, or can not be converted to a ``bool``. r; TFz5The value of the parameter must be "true" or "false".N)r( rO r� � TRUE_STRINGS� FALSE_STRINGSr r� r� )rV r� r� r� � blank_as_truer� r rv rW rW rX �get_param_as_bool s& & zRequest.get_param_as_boolc s� | j }||v r||| }t|t�s&|g}� durhz� fdd�|D �}W n" tyf d}t�||��Y n0 |durx|||< |S |s�dS t�|��dS )a' Return the value of a query string parameter as a list. List items must be comma-separated or must be provided as multiple instances of the same param in the query string ala *application/x-www-form-urlencoded*. Args: name (str): Parameter name, case-sensitive (e.g., 'ids'). Keyword Args: transform (callable): An optional transform function that takes as input each element in the list as a ``str`` and outputs a transformed element for inclusion in the list that will be returned. For example, passing ``int`` will transform list items into numbers. required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: list: The value of the param if it is found. Otherwise, returns ``None`` unless required is True. Empty list elements will be discarded. For example, the following query strings would both result in `['1', '3']`:: things=1,,3 things=1&things=&things=3 Raises: HTTPBadRequest: A required param is missing from the request, or a transform function raised an instance of ``ValueError``. Nc s g | ] }� |��qS rW rW )r� �i�� transformrW rX r� � r� z-Request.get_param_as_list.<locals>.<listcomp>z%The value is not formatted correctly.)r( rO r� rr r r� r� )rV r� r r� r� r� r� rv rW r rX �get_param_as_listV s" ' zRequest.get_param_as_list�%Y-%m-%dT%H:%M:%SZc C s` | j ||d�}|du rdS zt||�}W n" tyJ d}t�||��Y n0 |dur\|||< |S )a� Return the value of a query string parameter as a datetime. Args: name (str): Parameter name, case-sensitive (e.g., 'ids'). Keyword Args: format_string (str): String used to parse the param value into a ``datetime``. Any format recognized by strptime() is supported (default ``'%Y-%m-%dT%H:%M:%SZ'``). required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: datetime.datetime: The value of the param if it is found and can be converted to a ``datetime`` according to the supplied format string. If the param is not found, returns ``None`` unless required is ``True``. Raises: HTTPBadRequest: A required param is missing from the request, or the value could not be converted to a ``datetime``. r� Nz2The date value does not match the required format.)r� �strptimerr r r� )rV r� � format_stringr� r� � param_value� date_timerv rW rW rX �get_param_as_datetime� s z Request.get_param_as_datetime�%Y-%m-%dc C s4 | � |||�}|r |�� }ndS |dur0|||< |S )a} Return the value of a query string parameter as a date. Args: name (str): Parameter name, case-sensitive (e.g., 'ids'). Keyword Args: format_string (str): String used to parse the param value into a date. Any format recognized by strptime() is supported (default ``"%Y-%m-%d"``). required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: datetime.date: The value of the param if it is found and can be converted to a ``date`` according to the supplied format string. If the param is not found, returns ``None`` unless required is ``True``. Raises: HTTPBadRequest: A required param is missing from the request, or the value could not be converted to a ``date``. N)r r} )rV r� r r� r� r r} rW rW rX �get_param_as_date� s zRequest.get_param_as_datec C s` | j ||d�}|du rdS zt�|�}W n" tyJ d}t�||��Y n0 |dur\|||< |S )a� Return the decoded JSON value of a query string parameter. Given a JSON value, decode it to an appropriate Python type, (e.g., ``dict``, ``list``, ``str``, ``int``, ``bool``, etc.) Args: name (str): Parameter name, case-sensitive (e.g., 'payload'). Keyword Args: required (bool): Set to ``True`` to raise ``HTTPBadRequest`` instead of returning ``None`` when the parameter is not found (default ``False``). store (dict): A ``dict``-like object in which to place the value of the param, but only if the param is found (default ``None``). Returns: dict: The value of the param if it is found. Otherwise, returns ``None`` unless required is ``True``. Raises: HTTPBadRequest: A required param is missing from the request, or the value could not be parsed as JSON. r� Nz It could not be parsed as JSON.)r� r �loadsrr r r� )rV r� r� r� r r rv rW rW rX �get_param_as_json� s zRequest.get_param_as_jsonc C s� | j rd| j }nd}t�t� | j| j|�}tjrH| j� || d � n6t |t �r\|� d�}| j� |� d�� | j� |d � dS )ae Write an error message to the server's log. Prepends timestamp and request info to message, and writes the result out to the WSGI server's error stream (`wsgi.error`). Args: message (str or unicode): Description of the problem. On Python 2, instances of ``unicode`` will be converted to UTF-8. r� r= � r8 N) r0 �DEFAULT_ERROR_LOG_FORMAT�format�nowr- r/ rE rF r) �writerO �unicoderG )rV �message�query_string_formatted�log_linerW rW rX � log_error$ s �� zRequest.log_errorc C s: z| j p d}W n tjy& d}Y n0 t�| jd |�S )Nr rA )rw r rs �helpers� BoundedStreamr, )rV rw rW rW rX rR G s z Request._get_wrapped_wsgi_inputc C st | j }|sd S | j�|�}z|�d�}W n tyH d }| �d� Y n0 |rpt|| jj| jj d�}| j � |� d S )N�asciizuNon-ASCII characters found in form body with Content-Type of application/x-www-form-urlencoded. Body will be ignored.r> ) rw r1 r� rH �UnicodeDecodeErrorr r r. r? rM r( �update)rV rw �body� extra_paramsrW rW rX rT T s �z Request._parse_form_urlencoded)N)FN)FF)FNN)FNNN)FN)FNF)NFN)r FN)r FN)FN)Fr[ � __module__� __qualname__�__doc__� __slots__�dictrU rN rQ rY r^ r �header_property� user_agent�auth�expect�if_match� if_none_match�if_range�referer�propertyrg rj rk rl rp rw ry r} r~ r r� r� r� r� r� r� r� r\ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� ri r� r� r| r� r r r r r r r �get_param_as_dictr rR rT rW rW rW rX r ? s� C d $ 1 # ? � E @ � D � I � , � ' *# r c @ s e Zd ZdZdZdd� ZdS )rD a� Defines a set of configurable request options. An instance of this class is exposed via :any:`API.req_options` for configuring certain :py:class:`~.Request` behaviors. Attributes: keep_blank_qs_values (bool): Set to ``True`` to keep query string fields even if they do not have a value (default ``False``). For comma-separated values, this option also determines whether or not empty elements in the parsed list are retained. auto_parse_form_urlencoded: Set to ``True`` in order to automatically consume the request stream and merge the results into the request's query string params when the request's content type is *application/x-www-form-urlencoded* (default ``False``). Enabling this option makes the form parameters accessible via :attr:`~.params`, :meth:`~.get_param`, etc. Warning: When this option is enabled, the request's body stream will be left at EOF. The original data is not retained by the framework. Note: The character encoding for fields, before percent-encoding non-ASCII bytes, is assumed to be UTF-8. The special `_charset_` field is ignored if present. Falcon expects form-encoded request bodies to be encoded according to the standard W3C algorithm (see also http://goo.gl/6rlcux). auto_parse_qs_csv: Set to ``False`` to treat commas in a query string value as literal characters, rather than as a comma- separated list (default ``True``). When this option is enabled, the value will be split on any non-percent-encoded commas. Disable this option when encoding lists as multiple occurrences of the same parameter, and when values may be encoded in alternative formats in which the comma character is significant. strip_url_path_trailing_slash: Set to ``False`` in order to retain a trailing slash, if present, at the end of the URL path (default ``True``). When this option is enabled, the URL path is normalized by stripping the trailing slash character. This lets the application define a single route to a resource for a path that may or may not end in a forward slash. However, this behavior can be problematic in certain cases, such as when working with authentication schemes that employ URL-based signatures. default_media_type (str): The default media-type to use when deserializing a response. This value is normally set to the media type provided when a :class:`falcon.API` is initialized; however, if created independently, this will default to the ``DEFAULT_MEDIA_TYPE`` specified by Falcon. media_handlers (Handlers): A dict-like object that allows you to configure the media-types that you would like to handle. By default, a handler is provided for the ``application/json`` media type. )r? rS rM rI r� r� c C s* d| _ d| _d| _d| _t| _t� | _d S )NFT)r? rS rM rI r r� r r� r] rW rW rX rY � s zRequestOptions.__init__N)r[ r& r' r( r) rY rW rW rW rX rD r s B rD )*r( r �socket� _fileobjectrP �AttributeError�io�BufferedReader�uuidr �wsgiref.validater r� rE � six.movesr �falconr r r r r �falcon.forwardedr r � falcon.mediar � falcon.utilr �falcon.util.urir r r� r r r r� r r �objectr rD rW rW rW rX �<module> sT ?
Save
Cancel