Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
doctorondemand / djangorestframework python
Repository URL to install this package:
|
Version:
3.6.4 ▾
|
«¬Yf` ã
@ sA d d l Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m
Z
d d l m Z d d l
m Z d d l m Z d d
l m Z m Z d d l m Z d d l m Z m Z m Z d d
l m Z m Z m Z m Z m Z m! Z! d d l" m# Z# d d l$ m% Z% d d l& m' Z' d d l( m) Z) d d l* m+ Z+ d d l, m- Z- e j. d Z/ d d Z0 d d Z1 d d Z2 d d Z3 d d Z4 d d Z5 d! d" Z6 d# d$ Z7 d% d& Z8 Gd' d( d( e9 Z: Gd) d* d* e9 Z; Gd+ d, d, e- Z< d d d d d d- d e; d. d/ Z= d S)0é N)Ú OrderedDict)Ú
import_module)Úsettings)Úsimplify_regex)ÚPermissionDenied)Úmodels)ÚHttp404)Úsix)Ú
force_textÚ
smart_text)Ú
ugettext_lazy)Ú
exceptionsÚ renderersÚ serializers)ÚRegexURLPatternÚRegexURLResolverÚcoreapiÚ
coreschemaÚ uritemplateÚurlparse)Ú
clone_request)ÚResponse)Ú api_settings)Ú
formatting)Ú_get_pk)ÚAPIViewz^[a-zA-Z][0-9A-Za-z_]*:c C sy | j r t | j n d } | j r6 t | j n d } t | t j t j f r t | j } t j
d | d | d | St | t j rÌ t j d t
d d | j j D d | d | St | t j r t j
d t j d | d | St | t j r(t j d | d | St | t j rqt j
d t j d t | j j d | d | St | t j r®t j d t | j j d | d | St | t j rÖt j d | d | St | t j t j f rt j d | d | St | t j r/t j d | d | S| j j! d d
k rct j d | d | d d St j d | d | S)
NÚ ÚitemsÚtitleÚ descriptionÚ
propertiesc S s( g | ] \ } } | t | f q S© )Úfield_to_schema)Ú.0ÚkeyÚvaluer! r! úU/Users/carlton/Documents/Django-Stack/django-rest-framework/rest_framework/schemas.pyú
<listcomp>+ s z#field_to_schema.<locals>.<listcomp>ÚenumÚ
base_templatez
textarea.htmlÚformatÚtextarea)"Úlabelr
Ú help_textÚ
isinstancer ÚListSerializerÚ ListFieldr" Úchildr ÚArrayÚ
SerializerÚObjectr Úfieldsr ÚManyRelatedFieldÚStringÚ RelatedFieldÚMultipleChoiceFieldÚEnumÚlistÚchoicesÚkeysÚ ChoiceFieldÚ BooleanFieldÚBooleanÚ DecimalFieldÚ
FloatFieldÚNumberÚ IntegerFieldÚIntegerÚstyleÚget)Úfieldr r Ú child_schemar! r! r& r" sX ! r" c C s d d | D } t | } t | } | } x; t | D]- \ } } | | | k r> | d |
} Pq> Wd d j | S)Nc S s( g | ] } | j d j d q S)ú/)ÚstripÚsplit)r# Úpathr! r! r& r' W s z common_path.<locals>.<listcomp>rJ )ÚminÚmaxÚ enumerateÚjoin)ÚpathsÚ split_pathsÚs1Ús2ÚcommonÚiÚcr! r! r& Ú common_pathV s rY c C s | j j j } t | j S)N)Ú_metaÚconcrete_modelr Úname)ÚmodelÚmetar! r! r& Ú get_pk_nameb s r_ c C s+ t | d d } | d k o* t | t S)zT
Return `True` if the given view callback is a REST framework view/viewset.
ÚclsN)ÚgetattrÚ
issubclassr )Úcallbackr` r! r! r& Ú is_api_viewg s rd c C sM x8 | d d
D]& } | | k r- i | | <| | } q W| | | d <d S)z
Nested dictionary insertion.
>>> example = {}
>>> insert_into(example, ['a', 'b', 'c'], 123)
>>> example
{'a': {'b': {'c': 123}}}
Né éÿÿÿÿrf r! )Útargetr= r% r$ r! r! r& Ú insert_intoo s
rh c C s" | t d d d d d d g k S)NÚretriever; ÚcreateÚupdateÚpartial_updateÚdestroy)Úset)Úactionr! r! r& Úis_custom_action s rp c C sh t | d r | j d k S| j d k r2 d S| j d j d } | rd d | d k rd d Sd S)
zP
Return True if the given path/method appears to represent a list view.
ro r; rG FrJ Ú{re Trf )Úhasattrro ÚlowerrK rL )rM ÚmethodÚviewZpath_componentsr! r! r& Ú is_list_view
s
rv c
C sI | \ } } } d d d d d d d d d d
i j | d } | | f S) NÚGETr ÚPOSTre ÚPUTé ÚPATCHé ÚDELETEé é )rG )ÚendpointrM rt rc Zmethod_priorityr! r! r& Úendpoint_ordering s r c C sp t | t j r! t d } n- t | t j rB t d } n t d } t d j d | d | j j S)Nzunique integer valuez UUID stringz unique valuez'A {value_type} identifying this {name}.Ú
value_typer\ )r. r Ú AutoFieldÚ_Ú UUIDFieldr* rZ Ú verbose_name)r] Ú model_fieldr r! r! r& Úget_pk_description¡ s r c @ s^ e Z d Z d Z d d d d Z d d d d Z d d Z d
d Z d d
Z d S)ÚEndpointInspectorzR
A class to determine the available API endpoints that a project exposes.
Nc C s^ | d k rQ | d k r! t j } t | t j rB t | } n | } | j } | | _ d S)N)r Ú ROOT_URLCONFr. r Ú string_typesr Ú urlpatternsÚpatterns)Úselfr ÚurlconfÚurlsr! r! r& Ú__init__³ s zEndpointInspector.__init__r c C sû | d k r | j } g } xÇ | D]¿ } | | j j } t | t rª | j | } | j } | j | | rá xm | j | D]" } | | | f } | j | q Wq" t | t
r" | j d | j d | }
| j
|
q" Wt | d t } | S)zZ
Return a list of all available API endpoints by inspecting the URL conf.
Nr Úprefixr$ )r ÚregexÚpatternr. r Úget_path_from_regexrc Úshould_include_endpointÚget_allowed_methodsÚappendr Úget_api_endpointsÚ url_patternsÚextendÚsortedr ) r r r Z
api_endpointsr Ú
path_regexrM rc rt r Znested_endpointsr! r! r& r  s&
z#EndpointInspector.get_api_endpointsc C s. t | } | j d d j d d } | S)zG
Given a URL conf regex, return a URI template string.
ú<rq ú>Ú})r Úreplace)r r rM r! r! r& r à s z%EndpointInspector.get_path_from_regexc C s6 t | s d S| j d s. | j d r2 d Sd S)zI
Return `True` if the given endpoint should be included.
Fz .{format}z
.{format}/T)rd Úendswith)r rM rc r! r! r& r è s
z)EndpointInspector.should_include_endpointc C se t | d rK t | j j } t | j j } d d | | @D Sd d | j j D S)zL
Return a list of the valid HTTP methods for this endpoint.
Úactionsc S s g | ] } | j q Sr! )Úupper)r# rt r! r! r& r' û s z9EndpointInspector.get_allowed_methods.<locals>.<listcomp>c S s" g | ] } | d k r | q S)ÚOPTIONSÚHEAD)zOPTIONSzHEADr! )r# rt r! r! r& r' þ s )rr rn r£ r= r` Úhttp_method_namesÚallowed_methods)r rc r£ r§ r! r! r& r ô s z%EndpointInspector.get_allowed_methods) Ú__name__Ú
__module__Ú __qualname__Ú__doc__r r r r r r! r! r! r& r ¯ s r c @ s e Z d Z d d d d d d d d d d
i Z e Z d Z d Z d d d d d d d
Z d d d d Z d d d Z
d d Z d d d Z d d Z
d d Z d d Z d d Z d d Z d! d" Z d# d$ Z d% d& Z d' d( Z d) d* Z d S)+ÚSchemaGeneratorrG ri Úpostrj Úputrk Úpatchrl Údeleterm Nc C s t s t d t s$ t d | rD | j d rD | d 7} t j | _ t j | _ | | _ | | _
| | _ | | _ | | _
d | _ d S)Nz/`coreapi` must be installed for schema support.z2`coreschema` must be installed for schema support.rJ )r ÚAssertionErrorr r¢ r ÚSCHEMA_COERCE_METHOD_NAMESÚcoerce_method_namesÚSCHEMA_COERCE_PATH_PKÚcoerce_path_pkr r r r ÚurlÚ endpoints)r r r· r r r r! r! r& r s
zSchemaGenerator.__init__Fc C s« | j d k r6 | j | j | j } | j | _ | j | rH d n | } | s[ d S| j } | r | d k r | j } t j d | j
d | j d | d | S)zL
Generate a `coreapi.Document` representing the API schema.
Nr r r· Úcontent) r¸ Úendpoint_inspector_clsr r r Ú get_linksr· Úbuild_absolute_urir ÚDocumentr r )r ÚrequestÚpublicZ inspectorÚlinksr· r! r! r& Ú
get_schema) s zSchemaGenerator.get_schemac
C s3 t } g } g } x| | j D]q \ } } } | j | | | } t | d d rX q | j | | | } | j | | j | | | f q W| s d S| j | } x | D]w \ } } } | j | | | sÛ q´ | j | | | }
| t | d
} | j
| | | } t | | |
q´ W| S)zq
Return a dictionary containing all the links that should be
included in the API schema.
Úexclude_from_schemaFN) r r¸ Ú create_viewra Ú coerce_pathr Údetermine_path_prefixÚhas_view_permissionsÚget_linkÚlenÚget_keysrh )
r r¾ rÀ rR Zview_endpointsrM rt rc ru r ÚlinkÚsubpathr= r! r! r& r» > s*
zSchemaGenerator.get_linksc C s¢ g } x | D] } | j d j d } g } x( | D] } d | k rK P| j | q8 Wd j | d d
} | s d S| j d | d q
Wt | S)a
Given a list of all paths, return the common prefix which should be
discounted when generating a schema structure.
This will be the longest common string that does not include that last
component of the URL, or the last component before a path parameter.
For example:
/api/v1/users/
/api/v1/users/{pk}/
The path prefix is '/api/v1/'
rJ rq Nre rf )rK rL r rQ rY )r rR ÚprefixesrM Ú
componentsZinitial_componentsÚ componentr r! r! r& rÅ ` s
z%SchemaGenerator.determine_path_prefixc C sî | j } x6 t | d i j D] \ } } t | | | q% Wf | _ i | _ d | _ d | _ t | d d | _ t | d d } | d k rÌ | d k r´ d | _ n | j
| j | _ | d k rê t | | | _ | S)zC
Given a callback, return an actual view instance.
Ú
initkwargsNr£ r¥ Úmetadata)
r` ra r ÚsetattrÚargsÚkwargsÚ format_kwargr¾ Ú
action_mapro rG rs r )r rc rt r¾ ru ÚattrÚvalr£ r! r! r& rà s % zSchemaGenerator.create_viewc
C sP | j d k r d Sy | j | j Wn" t j t t f k
rK d SYn Xd S)zY
Return `True` if the incoming request has the correct view permissions.
NTF)r¾ Úcheck_permissionsr
Ú APIExceptionr r )r rM rt ru r! r! r& rÆ s z$SchemaGenerator.has_view_permissionsc C sg | j s d | k r | St t | d d d d } | rM t | } n d } | j d d | S)zâ
Coerce {pk} path arguments into the name of the model field,
where possible. This is cleaner for an external representation.
(Ie. "this is an identifier", not "this is a database primary key")
z{pk}ÚquerysetNr] Úidz{%s})r¶ ra r_ r¡ )r rM rt ru r] Ú
field_namer! r! r& rÄ ¥ s zSchemaGenerator.coerce_pathc C s | j | | | } | | j | | | 7} | | j | | | 7} | | j | | | 7} | r t d d | D r | j | | | } n d } | j | | | } | j rÚ | j d rÚ | d d
} t j
d t j | j | d | j
d | d | d
| S) zJ
Return a `coreapi.Link` instance for the given endpoint.
c S s g | ] } | j d k q S)ÚformÚbody)zformzbody)Úlocation)r# rH r! r! r& r' ¿ s z,SchemaGenerator.get_link.<locals>.<listcomp>NrJ re r· ro Úencodingr5 r )Úget_path_fieldsÚget_serializer_fieldsÚget_pagination_fieldsÚget_filter_fieldsÚanyÚ get_encodingÚget_descriptionr· Ú
startswithr ÚLinkr Úurljoinrs )r rM rt ru r5 rà r r! r! r& rÇ ¶ s zSchemaGenerator.get_linkc C sQ t | d | j } t | | d j } | rF t j t | S| j } d d | j D } d } d d i } xZ | D]R }
t j |
rÄ |
j
d \ } } } | j | | <q | | d |
7<q Wt | d | j }
|
| k r | |
j S|
| j k rC| j |
| k rC| | j |
j S| d j S)z
Determine a link description.
This will be based on the method docstring if one exists,
or else the class docstring.
ro Nc S s g | ] } | j q Sr! )rK )r# Úliner! r! r& r' ß s z3SchemaGenerator.get_description.<locals>.<listcomp>r ú:Ú
)
ra rs r¬ r Údedentr Úget_view_descriptionÚ
splitlinesÚ header_regexÚmatchÚ partitionrK r´ )r rM rt ru Ú method_nameZmethod_docstringr ÚlinesZcurrent_sectionÚsectionsrë Z seperatorÚleadÚheaderr! r! r& rç Ñ s(
z SchemaGenerator.get_descriptionc C se t d } t | d g } x@ | D]8 } t | d d } | | k rM | S| d k r% d Sq% Wd S)
zN
Return the 'encoding' parameter to use for a given endpoint.
úapplication/jsonú!application/x-www-form-urlencodedúmultipart/form-dataÚparser_classesÚ
media_typeNz*/*zapplication/octet-stream)rù rú rû )rn ra )r rM rt ru Zsupported_media_typesrü Ú parser_classrý r! r! r& ræ ò s
z SchemaGenerator.get_encodingc
C s t t | d d d d } g } x`t j | D]O} d } d } t j } i }
| d k r@y | j j | } Wn d } Yn X| d k r¬ | j r¬ t | j } | d k rÓ | j rÓ t | j } n$ | d k r÷ | j
r÷ t | | } t | d r%| j
| k r%| j |
d <n t | t j r@t j } t j d | d d d
d d | d
| d | |
} | j | q4 W| S)zs
Return a list of `coreapi.Field` instances corresponding to any
templated path variables.
rÚ Nr] r Úlookup_value_regexr r\ rß rM ÚrequiredTÚschemar r )ra r Ú variablesr r7 rZ Ú get_fieldr r
r- Ú primary_keyr rr Ú lookup_fieldrÿ r. r r rE r ÚFieldr )
r rM rt ru r] r5 Úvariabler r Ú
schema_clsrÓ r rH r! r! r& rá s: z SchemaGenerator.get_path_fieldsc C s | d
k r g St | d s# g S| j } t | t j rl t j d d d d d d
d t j g St | t j s g Sg } x | j
j D]s } | j s t | t j
r¼ q | j oÎ | d k } t j d | j d d d | d t | } | j | q W| S)z
Return a list of `coreapi.Field` instances corresponding to any
request body input, as determined by the serializer class.
ry r{ rx Úget_serializerr\ Údatarß rÞ r Tr rÝ )zPUTzPATCHzPOST)rr r r. r r/ r r r r2 r3 r5 ÚvaluesÚ read_onlyÚ HiddenFieldr rÜ r" r )r rM rt ru Ú
serializerr5 rH r r! r! r& râ 2 s2 z%SchemaGenerator.get_serializer_fieldsc C sK t | | | s g St | d d } | s2 g S| j } | j | S)NÚpagination_class)rv ra r Úget_schema_fields)r rM rt ru Z
paginationÚ paginatorr! r! r& rã \ s z%SchemaGenerator.get_pagination_fieldsc C s` t | | | s g St | d d s, g Sg } x' | j D] } | | j | 7} q< W| S)NÚfilter_backends)rv ra r r )r rM rt ru r5 Zfilter_backendr! r! r& rä g s z!SchemaGenerator.get_filter_fieldsc C s t | d r | j } n. t | | | r6 d } n | j | j } d d | j d j d D } t | rÞ t | j d k rÉ | j | j } | | j
k r¾ | j
| } | | g S| d d
| g S| | j
k rú | j
| } | | g S) a
Return a list of keys that should be used to layout a link within
the schema document.
/users/ ("users", "list"), ("users", "create")
/users/{pk}/ ("users", "read"), ("users", "update"), ("users", "delete")
/users/enabled/ ("users", "enabled") # custom viewset list action
/users/{pk}/star/ ("users", "star") # custom viewset detail action
/users/{pk}/groups/ ("users", "groups", "list"), ("users", "groups", "create")
/users/{pk}/groups/{pk}/ ("users", "groups", "read"), ("users", "groups", "update"), ("users", "groups", "delete")
ro r; c S s" g | ] } d | k r | q S)rq r! )r# rÎ r! r! r& r' s z,SchemaGenerator.get_keys.<locals>.<listcomp>rJ re Nrf ) rr ro rv Údefault_mappingrs rK rL rp rÈ rÕ r´ )r rË rt ru ro Znamed_path_componentsr! r! r& rÉ u s"
zSchemaGenerator.get_keys)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! r& r s. "
! + * r c sL e Z d Z d Z d Z d Z d Z d Z f d d Z d d Z S)Ú
SchemaViewTNFc se t t | j | | | j d k ra t j t j k rR t j t j g | _ n t j g | _ d S)N) Úsuperr r Úrenderer_classesr ÚBrowsableAPIRendererr ÚDEFAULT_RENDERER_CLASSESÚCoreJSONRenderer)r rÒ rÓ )Ú __class__r! r& r © s zSchemaView.__init__c O s: | j j | | j } | d k r0 t j t | S)N)Úschema_generatorrÁ r¿ r
r r )r r¾ rÒ rÓ r r! r! r& rG ´ s zSchemaView.get)
r© rª r« Ú_ignore_model_permissionsr r r r¿ r rG r! r! )r r& r ¢ s r Fc C sC | d | d | d | d | d | } t j d | d | d | S) z
Return a schema view.
r r· r r r r r r¿ )r Úas_view) r r· r r r r¿ r Zgenerator_classÚ generatorr! r! r& Úget_schema_view» s r )>ÚreÚ collectionsr Ú importlibr Ú django.confr Z django.contrib.admindocs.viewsr Údjango.core.exceptionsr Ú django.dbr Ú django.httpr Ú django.utilsr Údjango.utils.encodingr
r Údjango.utils.translationr r Úrest_frameworkr
r r Úrest_framework.compatr r r r r r Úrest_framework.requestr Úrest_framework.responser Úrest_framework.settingsr Zrest_framework.utilsr Z rest_framework.utils.model_metar Úrest_framework.viewsr Úcompilerñ r" rY r_ rd rh rp rv r r Úobjectr r r r r! r! r! r& Ú<module> sD . 9 Tÿ