Briq
/
drf-yasg
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Promote deprecation warning to exception

master
Cristi Vijdea 2019-01-29 08:49:44 +02:00
parent 69a1e62ed3
commit 7c5a0b7176
1 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/drf_yasg/inspectors/view.py
View File

@ -22,22 +22,17 @@ class SwaggerAutoSchema(ViewInspector):
super(SwaggerAutoSchema, self).__init__(view, path, method, components, request, overrides) super(SwaggerAutoSchema, self).__init__(view, path, method, components, request, overrides)
self._sch = AutoSchema() self._sch = AutoSchema()
self._sch.view = view self._sch.view = view
self._summary_and_description_compat()
def _summary_and_description_compat(self): def _summary_and_description_compat(self):
# TODO: remove in 1.13 # TODO: remove in 1.14
base_methods = (SwaggerAutoSchema.get_summary, SwaggerAutoSchema.get_description) base_methods = (SwaggerAutoSchema.get_summary, SwaggerAutoSchema.get_description)
self_methods = (type(self).get_summary, type(self).get_description) self_methods = (type(self).get_summary, type(self).get_description)
if self_methods != base_methods: if self_methods != base_methods:
warnings.warn( raise NotImplementedError(
"`SwaggerAutoSchema` methods `get_summary` and `get_description` are deprecated and " "`SwaggerAutoSchema` methods `get_summary` and `get_description` were removed in "
"will be removed in drf-yasg 1.13. Override `get_summary_and_description` instead.", "drf-yasg 1.13 and will have no effect. Override `get_summary_and_description` instead."
DeprecationWarning, stacklevel=2
) )
# if get_summary or get_description are overriden by a child class,
# we must call them for backwards compatibility
return self.get_summary(), self.get_description()
return self.get_summary_and_description()
def get_operation(self, operation_keys): def get_operation(self, operation_keys):
consumes = self.get_consumes() consumes = self.get_consumes()
@ -50,7 +45,7 @@ class SwaggerAutoSchema(ViewInspector):
parameters = self.add_manual_parameters(parameters) parameters = self.add_manual_parameters(parameters)
operation_id = self.get_operation_id(operation_keys) operation_id = self.get_operation_id(operation_keys)
summary, description = self._summary_and_description_compat() summary, description = self.get_summary_and_description()
security = self.get_security() security = self.get_security()
assert security is None or isinstance(security, list), "security must be a list of security requirement objects" assert security is None or isinstance(security, list), "security must be a list of security requirement objects"
deprecated = self.is_deprecated() deprecated = self.is_deprecated()
@ -363,7 +358,7 @@ class SwaggerAutoSchema(ViewInspector):
description = description.strip().replace('\r', '') description = description.strip().replace('\r', '')
if description and (summary is None): if description and (summary is None):
# description from docstring ... do summary magic # description from docstring... do summary magic
summary, description = self.split_summary_from_description(description) summary, description = self.split_summary_from_description(description)
return summary, description return summary, description