B `K@sBddlmZddlZddlZddlZddlmZmZddlm Z ddl m Z ddl m Z ddlmZddlmZdd lmZmZmZdd lmZdd lmZdd lmZdd lmZdddZd ddZd!ddZ ddZ!e"Z#GdddZ$e$Z%e&dej'Z(Gddde$Z)eeGdddZ*Gddde*Z+e+Z,dS)")partialN) implementer providedBy) Components)get_csrf_token)reify) BeforeRender)HTTPBadRequest) IJSONAdapterIRendererFactory IRendererInfo)caller_package)_get_response_factory)get_current_registry) hide_attrsc Csjy |j}Wntk r"d}YnX|dkr2t}t|||d}t|d|j|d|d}WdQRX|S)aPUsing the renderer ``renderer_name`` (a template or a static renderer), render the value (or set of values) present in ``value``. Return the result of the renderer's ``__call__`` method (usually a string or Unicode). If the ``renderer_name`` refers to a file on disk, such as when the renderer is a template, it's usually best to supply the name as an :term:`asset specification` (e.g. ``packagename:path/to/template.pt``). You may supply a relative asset spec as ``renderer_name``. If the ``package`` argument is supplied, a relative renderer path will be converted to an absolute asset specification by combining the package ``package`` with the relative asset specification ``renderer_name``. If ``package`` is ``None`` (the default), the package name of the *caller* of this function will be used as the package. The ``value`` provided will be supplied as the input to the renderer. Usually, for template renderings, this should be a dictionary. For other renderers, this will need to be whatever sort of value the renderer expects. The 'system' values supplied to the renderer will include a basic set of top-level system names, such as ``request``, ``context``, ``renderer_name``, and ``view``. See :ref:`renderer_system_values` for the full list. If :term:`renderer globals` have been specified, these will also be used to augment the value. Supply a ``request`` parameter in order to provide the renderer with the most correct 'system' values (``request`` and ``context`` in particular). N)namepackageregistryresponse)request)rAttributeErrorr RendererHelperrrender) renderer_namevaluerrrhelperresultrY/home/kop/projects/devel/pgwui/test_venv/lib/python3.7/site-packages/pyramid/renderers.pyrs#    rc Csxy |j}Wntk r"d}YnX|dkr2t}t|||d}t|d$|dk rZ||_|j|d|d}WdQRX|S)asUsing the renderer ``renderer_name`` (a template or a static renderer), render the value (or set of values) using the result of the renderer's ``__call__`` method (usually a string or Unicode) as the response body. If the renderer name refers to a file on disk (such as when the renderer is a template), it's usually best to supply the name as a :term:`asset specification`. You may supply a relative asset spec as ``renderer_name``. If the ``package`` argument is supplied, a relative renderer name will be converted to an absolute asset specification by combining the package ``package`` with the relative asset specification ``renderer_name``. If you do not supply a ``package`` (or ``package`` is ``None``) the package name of the *caller* of this function will be used as the package. The ``value`` provided will be supplied as the input to the renderer. Usually, for template renderings, this should be a dictionary. For other renderers, this will need to be whatever sort of value the renderer expects. The 'system' values supplied to the renderer will include a basic set of top-level system names, such as ``request``, ``context``, ``renderer_name``, and ``view``. See :ref:`renderer_system_values` for the full list. If :term:`renderer globals` have been specified, these will also be used to argument the value. Supply a ``request`` parameter in order to provide the renderer with the most correct 'system' values (``request`` and ``context`` in particular). Keep in mind that any changes made to ``request.response`` prior to calling this function will not be reflected in the resulting response object. A new response object will be created for each call unless one is passed as the ``response`` argument. .. versionchanged:: 1.6 In previous versions, any changes made to ``request.response`` outside of this function call would affect the returned response. This is no longer the case. If you wish to send in a pre-initialized response then you may pass one in the ``response`` argument. N)rrrr)r)rrr rrrrender_to_response)rrrrrrrrrrrrHs-    rcCs"|dkrt}t|||d}|jS)aReturn the renderer object for the renderer ``renderer_name``. You may supply a relative asset spec as ``renderer_name``. If the ``package`` argument is supplied, a relative renderer name will be converted to an absolute asset specification by combining the package ``package`` with the relative asset specification ``renderer_name``. If ``package`` is ``None`` (the default), the package name of the *caller* of this function will be used as the package. You may directly supply an :term:`application registry` using the ``registry`` argument, and it will be used to look up the renderer. Otherwise, the current thread-local registry (obtained via :func:`~pyramid.threadlocal.get_current_registry`) will be used. N)rrr)r rrenderer)rrrrrrr get_renderers  r!cCs dd}|S)NcSsDt|tst|}|d}|dk r@|j}|j}||jkr@d|_|S)Nrz text/plain) isinstancestrgetr content_typedefault_content_type)rsystemrrctrrr_renders   z(string_renderer_factory.._renderr)infor)rrrstring_renderer_factorys r+c@s8eZdZdZejdfddZddZddZd d Z d S) JSONaRenderer that returns a JSON-encoded string. Configure a custom JSON renderer using the :meth:`~pyramid.config.Configurator.add_renderer` API at application startup time: .. code-block:: python from pyramid.config import Configurator config = Configurator() config.add_renderer('myjson', JSON(indent=4)) Once this renderer is registered as above, you can use ``myjson`` as the ``renderer=`` parameter to ``@view_config`` or :meth:`~pyramid.config.Configurator.add_view`: .. code-block:: python from pyramid.view import view_config @view_config(renderer='myjson') def myview(request): return {'greeting':'Hello world'} Custom objects can be serialized using the renderer by either implementing the ``__json__`` magic method, or by registering adapters with the renderer. See :ref:`json_serializing_custom_objects` for more information. .. note:: The default serializer uses ``json.JSONEncoder``. A different serializer can be specified via the ``serializer`` argument. Custom serializers should accept the object, a callback ``default``, and any extra ``kw`` keyword arguments passed during renderer construction. This feature isn't widely used but it can be used to replace the stock JSON serializer with, say, simplejson. If all you want to do, however, is serialize custom objects, you should use the method explained in :ref:`json_serializing_custom_objects` instead of replacing the serializer. .. versionadded:: 1.4 Prior to this version, there was no public API for supplying options to the underlying serializer without defining a custom renderer. rcKs6||_||_t|_x|D]\}}|||qWdS)zLAny keyword arguments will be passed to the ``serializer`` function.N) serializerkwr components add_adapter)selfr-adaptersr.typeadapterrrr__init__s z JSON.__init__cCs|j||ftdS)aWhen an object of the type (or interface) ``type_or_iface`` fails to automatically encode using the serializer, the renderer will use the adapter ``adapter`` to convert it into a JSON-serializable object. The adapter must accept two arguments: the object and the currently active request. .. code-block:: python class Foo: x = 5 def foo_adapter(obj, request): return obj.x renderer = JSON(indent=4) renderer.add_adapter(Foo, foo_adapter) When you've done this, the JSON renderer will be able to serialize instances of the ``Foo`` class when they're encountered in your view results.N)r/ZregisterAdapterr )r1Z type_or_ifacer4rrrr0szJSON.add_adaptercsfdd}|S)zReturns a plain JSON-encoded string with content-type ``application/json``. The content-type may be overridden by setting ``request.response.content_type``.csP|d}|dk r.|j}|j}||jkr.d|_|}j|fd|ijS)Nrzapplication/jsondefault)r$rr%r& _make_defaultr-r.)rr'rrr(r6)r1rrr) s   zJSON.__call__.._renderr)r1r*r)r)r1r__call__s z JSON.__call__csfdd}|S)NcsVt|dr|St|}jj}|j|fttd}|tkrLtd|f||S)N__json__)r6z%r is not JSON serializable) hasattrr9rr/r2lookupr _marker TypeError)objZ obj_ifacer2r)rr1rrr6s  z#JSON._make_default..defaultr)r1rr6r)rr1rr7s zJSON._make_defaultN) __name__ __module__ __qualname____doc__jsondumpsr5r0r8r7rrrrr,s . r,z^[$a-z_][$0-9a-z_\.\[\]]+[^.]$c@s"eZdZdZdddZddZdS) JSONPa`JSONP `_ renderer factory helper which implements a hybrid json/jsonp renderer. JSONP is useful for making cross-domain AJAX requests. Configure a JSONP renderer using the :meth:`pyramid.config.Configurator.add_renderer` API at application startup time: .. code-block:: python from pyramid.config import Configurator config = Configurator() config.add_renderer('jsonp', JSONP(param_name='callback')) The class' constructor also accepts arbitrary keyword arguments. All keyword arguments except ``param_name`` are passed to the ``json.dumps`` function as its keyword arguments. .. code-block:: python from pyramid.config import Configurator config = Configurator() config.add_renderer('jsonp', JSONP(param_name='callback', indent=4)) .. versionchanged:: 1.4 The ability of this class to accept a ``**kw`` in its constructor. The arguments passed to this class' constructor mean the same thing as the arguments passed to :class:`pyramid.renderers.JSON` (including ``serializer`` and ``adapters``). Once this renderer is registered via :meth:`~pyramid.config.Configurator.add_renderer` as above, you can use ``jsonp`` as the ``renderer=`` parameter to ``@view_config`` or :meth:`pyramid.config.Configurator.add_view``: .. code-block:: python from pyramid.view import view_config @view_config(renderer='jsonp') def myview(request): return {'greeting':'Hello world'} When a view is called that uses the JSONP renderer: - If there is a parameter in the request's HTTP query string that matches the ``param_name`` of the registered JSONP renderer (by default, ``callback``), the renderer will return a JSONP response. - If there is no callback parameter in the request's query string, the renderer will return a 'plain' JSON response. .. versionadded:: 1.1 .. seealso:: See also :ref:`jsonp_renderer`. callbackcKs||_tj|f|dS)N) param_namer,r5)r1rGr.rrrr5lszJSONP.__init__csfdd}|S)zReturns JSONP-encoded string with content-type ``application/javascript`` if query parameter matching ``self.param_name`` is present in request.GET; otherwise returns plain-JSON encoded string with content-type ``application/json``c s|d}|}j|fd|ij}d}|}|dk r|jj}|dk rtt|sdtdd}d ||}|j }|j |j kr||_ |S)Nrr6zapplication/jsonz%Invalid JSONP callback function name.zapplication/javascriptz /**/{}({});) r$r7r-r.GETrGJSONP_VALID_CALLBACKmatchr formatrr%r&) rr'rr6valr(bodyrFr)r1rrr)vs"     zJSONP.__call__.._renderr)r1r*r)r)r1rr8ps zJSONP.__call__N)rF)r?r@rArBr5r8rrrrrE-s= rEc@sdeZdZdddZeddZeddZdd Zd d Zdd d Z dddZ ddZ dddZ dS)rNcCsP|rd|krtj|d}n|p$d}|dkr4t}||_||_||_||_dS)N.)ospathsplitextrrrr3r)r1rrrZrtyperrrr5s zRendererHelper.__init__cCs|jj}|dkri}|S)N)rsettings)r1rTrrrrTszRendererHelper.settingscCs4|jjt|jd}|dkr,tdt|j||S)N)rzNo such renderer factory %s)rZ queryUtilityr r3 ValueErrorr#)r1factoryrrrr szRendererHelper.renderercCs|jS)N)r )r1rrrr!szRendererHelper.get_rendererc Cs,||j||||tt|d}|j|||dS)N)viewr renderer_infocontextrreqr)r)rrrr)r1rrrWrYr'rrr render_viewszRendererHelper.render_viewc CsZ|j}|dkr2d|j|t|dd||tt|d}t||}|j}|||||}|S)NrY)rWrrXrYrrZr)r rgetattrrrrrnotify)r1r system_valuesrr rrrrrrs    zRendererHelper.rendercCs|j|||d}|||S)N)r)r_make_response)r1rr^rrrrrrsz!RendererHelper.render_to_responsecCsrt|dd}|dkr*|j}t|}||}|dk rnt|trD||_n*t|trV||_nt|drh||_ n||_|S)Nr__iter__) r\rrr"r#textbytesrMr:Zapp_iter)r1rrrrZresponse_factoryrrrr_s    zRendererHelper._make_responsecCs:|dkr|j}|dkr|j}|dkr*|j}|j|||dS)N)rrr)rrr __class__)r1rrrrrrcloneszRendererHelper.clone)NNN)N)N)NNN) r?r@rAr5rrTr r!r[rrr_rdrrrrrs     rc@sLeZdZdZdddZeddZddZdd d Zdd d Z dd dZ dS)NullRendererHelperaJSpecial renderer helper that has render_* methods which simply return the value they are fed rather than converting them to response objects; useful for testing purposes and special case view configuration registrations that want to use the view configuration machinery but do not want actual rendering to happen .NcCsd|_d|_d|_d|_dS)NrP)rrr3r)r1rrrrrrr5szNullRendererHelper.__init__cCsiS)Nr)r1rrrrTszNullRendererHelper.settingscCs|S)Nr)r1rrrWrYrrrr[ szNullRendererHelper.render_viewcCs|S)Nr)r1rr^rrrrr szNullRendererHelper.rendercCs|S)Nr)r1rr^rrrrrsz%NullRendererHelper.render_to_responsecCs|S)Nr)r1rrrrrrrdszNullRendererHelper.clone)NNN)N)N)NNN) r?r@rArBr5propertyrTr[rrrdrrrrres   re)NN)NNN)NN)- functoolsrrCrQreZzope.interfacerrZzope.interface.registryrZ pyramid.csrfrZpyramid.decoratorrZpyramid.eventsrZpyramid.httpexceptionsr Zpyramid.interfacesr r r Z pyramid.pathr Zpyramid.responserZpyramid.threadlocalrZ pyramid.utilrrrr!r+objectr<r,Zjson_renderer_factorycompileIrIrErreZ null_rendererrrrrs4           4 > tbf!