ruạṛ
a [��f1# � @ s� d Z ddlm mZ zddlmZ W n ey< eZY n0 ddl m Z m Z G dd� de �Z G dd� de�ZG d d � d e�ZdS ) zHTTPError exception class.� N)� OrderedDict)�json�uric @ sN e Zd ZdZdZddd�Zdd� Zedd � �Ze fd d �Z d d � Z dd� Z dS )� HTTPErrora� Represents a generic HTTP error. Raise an instance or subclass of ``HTTPError`` to have Falcon return a formatted error response and an appropriate HTTP status code to the client when something goes wrong. JSON and XML media types are supported by default. To customize the error presentation, implement a custom error serializer and set it on the :class:`~.API` instance via :meth:`~.API.set_error_serializer`. To customize what data is passed to the serializer, subclass ``HTTPError`` and override the ``to_dict()`` method (``to_json()`` is implemented via ``to_dict()``). To also support XML, override the ``to_xml()`` method. Attributes: status (str): HTTP status line, e.g. '748 Confounded by Ponies'. has_representation (bool): Read-only property that determines whether error details will be serialized when composing the HTTP response. In ``HTTPError`` this property always returns ``True``, but child classes may override it in order to return ``False`` when an empty HTTP body is desired. (See also: :class:`falcon.http_error.NoRepresentation`) title (str): Error title to send to the client. description (str): Description of the error to send to the client. headers (dict): Extra headers to add to the response. link (str): An href that the client can provide to the user for getting help. code (int): An internal application code that a user can reference when requesting support for the error. Args: status (str): HTTP status code and text, such as "400 Bad Request" Keyword Args: title (str): Human-friendly error title. If not provided, defaults to the HTTP status line as determined by the ``status`` argument. description (str): Human-friendly description of the error, along with a helpful suggestion or two (default ``None``). headers (dict or list): A ``dict`` of header names and values to set, or a ``list`` of (*name*, *value*) tuples. Both *name* and *value* must be of type ``str`` or ``StringType``, and only character values 0x00 through 0xFF may be used on platforms that use wide characters. Note: The Content-Type header, if present, will be overridden. If you wish to return custom error messages, you can create your own HTTP error class, and install an error handler to convert it into an appropriate HTTP response for the client Note: Falcon can process a list of ``tuple`` slightly faster than a ``dict``. href (str): A URL someone can visit to find out more information (default ``None``). Unicode characters are percent-encoded. href_text (str): If href is given, use this as the friendly title/description for the link (default 'API documentation for this error'). code (int): An internal code that customers can reference in their support request or to help them when searching for knowledge base articles related to this error (default ``None``). )�status�title� description�headers�link�codeNc C s` || _ |p || _|| _|| _|| _|rVt� }| _|p8d|d< t�|�|d< d|d< nd | _d S )Nz#Documentation related to this error�text�href�help�rel) r r r r r r r r �encode) �selfr r r r r � href_textr r � r �u/sparta/input/_build_configuration/image_build+validate/lib/bmcenv/lib64/python3.9/site-packages/falcon/http_error.py�__init__j s zHTTPError.__init__c C s d| j j| jf S )Nz<%s: %s>)� __class__�__name__r �r r r r �__repr__� s zHTTPError.__repr__c C s dS )NTr r r r r �has_representation� s z HTTPError.has_representationc C sP |� }| j |d< | jdur$| j|d< | jdur8| j|d< | jdurL| j|d< |S )a� Return a basic dictionary representing the error. This method can be useful when serializing the error to hash-like media types, such as YAML, JSON, and MessagePack. Args: obj_type: A dict-like type that will be used to store the error information (default ``dict``). Returns: dict: A dictionary populated with the error's title, description, etc. r Nr r r )r r r r )r �obj_type�objr r r �to_dict� s zHTTPError.to_dictc C s | � t�}tj|dd�S )z�Return a pretty-printed JSON representation of the error. Returns: str: A JSON document for the error. F)� ensure_ascii)r r r �dumps)r r r r r �to_json� s zHTTPError.to_jsonc C s� t �d�}| jt �|d�_| jdur4| jt �|d�_| jdurRt| j�t �|d�_| jdur�t �|d�}dD ]}| j| t �||�_qldt j |d d � S ) z~Return an XML-encoded representation of the error. Returns: str: An XML document for the error. �errorr Nr r r )r r r s& <?xml version="1.0" encoding="UTF-8"?>zutf-8)�encoding) �et�Elementr � SubElementr r r �strr �tostring)r � error_element� link_element�keyr r r �to_xml� s �zHTTPError.to_xml)NNNNNN) r � __module__� __qualname__�__doc__� __slots__r r �propertyr �dictr r r+ r r r r r s E � r c @ s e Zd ZdZedd� �ZdS )�NoRepresentationa� Mixin for ``HTTPError`` child classes that have no representation. This class can be mixed in when inheriting from ``HTTPError``, in order to override the `has_representation` property such that it always returns ``False``. This, in turn, will cause Falcon to return an empty response body to the client. You can use this mixin when defining errors that either should not have a body (as dictated by HTTP standards or common practice), or in the case that a detailed error response may leak information to an attacker. Note: This mixin class must appear before ``HTTPError`` in the base class list when defining the child; otherwise, it will not override the `has_representation` property as expected. c C s dS )NFr r r r r r � s z#NoRepresentation.has_representationN)r r, r- r. r0 r r r r r r2 � s r2 c s$ e Zd ZdZe� fdd��Z� ZS )�OptionalRepresentationa� Mixin for ``HTTPError`` child classes that may have a representation. This class can be mixed in when inheriting from ``HTTPError`` in order to override the `has_representation` property, such that it will return ``False`` when the error instance has no description (i.e., the `description` kwarg was not set). You can use this mixin when defining errors that do not include a body in the HTTP response by default, serializing details only when the web developer provides a description of the error. Note: This mixin class must appear before ``HTTPError`` in the base class list when defining the child; otherwise, it will not override the `has_representation` property as expected. c s t t| �jd uS )N)�superr3 r r �r r r r � s z)OptionalRepresentation.has_representation)r r, r- r. r0 r � __classcell__r r r5 r r3 � s r3 )r. �xml.etree.ElementTree�etree� ElementTreer# � collectionsr � ImportErrorr1 � falcon.utilr r � Exceptionr �objectr2 r3 r r r r �<module> s 3
cải xoăn