encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-04 12:30:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Manual fields suggestions (#2)

Browse Source 
* Use OrderedDict in inspectors

* Move empty check to 'update_fields()'

* Make 'update_fields()' an AutoSchema staticmethod

* Add 'AutoSchema.get_manual_fields()'

* Conform '.get_manual_fields()' to other methods
This commit is contained in:
Ryan P Kilby 2017-12-01 04:10:36 -05:00 committed by Carlton Gibson
parent 633d4eae8b
commit 322cf8ebc9
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
rest_framework/schemas/inspectors.py
View File

@ -105,25 +105,6 @@ def get_pk_description(model, model_field):
) )
def update_fields(fields, update_with):
"""
Update list of coreapi.Field instances, overwriting on `Field.name`.
Utility function to handle replacing coreapi.Field fields
from a list by name. Used to handle `manual_fields`.
Parameters:
* `fields`: list of `coreapi.Field` instances to update
* `update_with: list of `coreapi.Field` instances to add or replace.
"""
by_name = {f.name: f for f in fields}
for f in update_with:
by_name[f.name] = f
fields = list(by_name.values())
return fields
class ViewInspector(object): class ViewInspector(object):
""" """
Descriptor class on APIView. Descriptor class on APIView.
@ -200,7 +181,8 @@ class AutoSchema(ViewInspector):
fields += self.get_pagination_fields(path, method) fields += self.get_pagination_fields(path, method)
fields += self.get_filter_fields(path, method) fields += self.get_filter_fields(path, method)
fields = self.update_manual_fields(fields) manual_fields = self.get_manual_fields(path, method)
fields = self.update_fields(fields, manual_fields)
if fields and any([field.location in ('form', 'body') for field in fields]): if fields and any([field.location in ('form', 'body') for field in fields]):
encoding = self.get_encoding(path, method) encoding = self.get_encoding(path, method)
@ -394,12 +376,29 @@ class AutoSchema(ViewInspector):
fields += filter_backend().get_schema_fields(self.view) fields += filter_backend().get_schema_fields(self.view)
return fields return fields
def update_manual_fields(self, fields): def get_manual_fields(self, path, method):
return self._manual_fields
@staticmethod
def update_fields(fields, update_with):
""" """
Adjust `fields` with `manual_fields` Update list of coreapi.Field instances, overwriting on `Field.name`.
Utility function to handle replacing coreapi.Field fields
from a list by name. Used to handle `manual_fields`.
Parameters:
* `fields`: list of `coreapi.Field` instances to update
* `update_with: list of `coreapi.Field` instances to add or replace.
""" """
if self._manual_fields is not None: if not update_with:
fields = update_fields(fields, self._manual_fields) return fields
by_name = OrderedDict((f.name, f) for f in fields)
for f in update_with:
by_name[f.name] = f
fields = list(by_name.values())
return fields return fields
def get_encoding(self, path, method): def get_encoding(self, path, method):