marcgibbons · Mar 12, 2014 · Apr 30, 2014 · Apr 30, 2014 · Apr 30, 2014 · Apr 30, 2014
Showing with 31 additions and 16 deletions.

+1 −1 rest_framework_swagger/__init__.py

+19 −5 rest_framework_swagger/docgenerator.py

+9 −8 rest_framework_swagger/introspectors.py

+1 −1 rest_framework_swagger/tests.py

+1 −1 rest_framework_swagger/urlparser.py
diff --git a/rest_framework_swagger/__init__.py b/rest_framework_swagger/__init__.py
@@ -1,4 +1,4 @@
-VERSION = '0.1.14'
+VERSION = '0.1.14.3'
 
 DEFAULT_SWAGGER_SETTINGS = {
     'exclude_namespaces': [],

diff --git a/rest_framework_swagger/docgenerator.py b/rest_framework_swagger/docgenerator.py
@@ -7,6 +7,7 @@
 from .introspectors import APIViewIntrospector, \
     ViewSetIntrospector, BaseMethodIntrospector, IntrospectorHelper, \
     get_resolved_value, YAMLDocstringParser
+from . import SWAGGER_SETTINGS
 
 
 class DocumentationGenerator(object):
@@ -50,7 +51,8 @@ def get_operations(self, api):
 
         for method_introspector in introspector:
             if not isinstance(method_introspector, BaseMethodIntrospector) or \
-                    method_introspector.get_http_method() == "OPTIONS":
+                    method_introspector.get_http_method() == "OPTIONS" or \
+                    method_introspector.get_http_method().lower() not in SWAGGER_SETTINGS['enabled_methods']:
                 continue  # No one cares. I impose JSON.
 
             doc_parser = YAMLDocstringParser(
@@ -70,10 +72,6 @@ def get_operations(self, api):
                 'type': response_type,
             }
 
-            if doc_parser.yaml_error is not None:
-                operation['notes'] += "<pre>YAMLError:\n {err}</pre>".format(
-                    err=doc_parser.yaml_error)
-
             response_messages = doc_parser.get_response_messages()
             parameters = doc_parser.discover_parameters(
                 inspector=method_introspector)
@@ -84,6 +82,22 @@ def get_operations(self, api):
             if response_messages:
                 operation['responseMessages'] = response_messages
 
+            # override operation from callback's docstring
+            callback_doc_parser = YAMLDocstringParser(docstring=callback.__doc__)
+            method = method_introspector.method.lower()
+            if method in callback_doc_parser.object:
+                overrides = callback_doc_parser.object[method]
+                allowed_keys = {'method', 'summary', 'nickname', 'notes', 'type', 'parameters', 'responseMessages'}
+                if isinstance(overrides, dict):
+                    for key, value in overrides.items():
+                        if key in allowed_keys:
+                            operation[key] = value
+
+            for parser in [doc_parser, callback_doc_parser]:
+                if parser.yaml_error is not None:
+                    operation['notes'] += "<pre>YAMLError:\n {err}</pre>".format(
+                        err=parser.yaml_error)
+
             operations.append(operation)
 
         return operations

diff --git a/rest_framework_swagger/introspectors.py b/rest_framework_swagger/introspectors.py
@@ -2,6 +2,7 @@
 
 import inspect
 import re
+import itertools
 import yaml
 import importlib
 
@@ -304,14 +305,14 @@ def __iter__(self):
             yield ViewSetMethodIntrospector(self, methods[method], method)
 
     def _resolve_methods(self):
-        if not hasattr(self.pattern.callback, 'func_code') or \
-                not hasattr(self.pattern.callback, 'func_closure') or \
-                not hasattr(self.pattern.callback.func_code, 'co_freevars') or \
-                'actions' not in self.pattern.callback.func_code.co_freevars:
+        if not hasattr(self.pattern.callback, '__code__') or \
+                not hasattr(self.pattern.callback, '__closure__') or \
+                not hasattr(self.pattern.callback.__code__, 'co_freevars') or \
+                'actions' not in self.pattern.callback.__code__.co_freevars:
             raise RuntimeError('Unable to use callback invalid closure/function specified.')
 
-        idx = self.pattern.callback.func_code.co_freevars.index('actions')
-        return self.pattern.callback.func_closure[idx].cell_contents
+        idx = self.pattern.callback.__code__.co_freevars.index('actions')
+        return self.pattern.callback.__closure__[idx].cell_contents
 
 
 class ViewSetMethodIntrospector(BaseMethodIntrospector):
@@ -520,7 +521,7 @@ def load_obj_from_docstring(self, docstring):
         yaml_string = formatting.dedent(yaml_string)
         try:
             return yaml.load(yaml_string)
-        except yaml.YAMLError, e:
+        except yaml.YAMLError as e:
             self.yaml_error = e
             return None
 
@@ -754,7 +755,7 @@ def _merge_params(params1, params2, key):
         Merges parameters lists by key
         """
         merged = OrderedDict()
-        for item in params1 + params2:
+        for item in itertools.chain(params1, params2):
             merged[item[key]] = item
 
         return [val for (_, val) in merged.items()]

diff --git a/rest_framework_swagger/tests.py b/rest_framework_swagger/tests.py
@@ -1,4 +1,5 @@
 import datetime
+from importlib import import_module
 
 from django.core.urlresolvers import RegexURLResolver
 from django.conf import settings
@@ -7,7 +8,6 @@
 from django.contrib.admindocs.utils import trim_docstring
 from django.http import HttpRequest
 from django.test import TestCase
-from django.utils.importlib import import_module
 from django.views.generic import View
 
 from rest_framework.views import APIView

diff --git a/rest_framework_swagger/urlparser.py b/rest_framework_swagger/urlparser.py
@@ -1,7 +1,7 @@
 import os
+from importlib import import_module
 
 from django.conf import settings
-from django.utils.importlib import import_module
 from django.core.urlresolvers import RegexURLResolver, RegexURLPattern
 from django.contrib.admindocs.views import simplify_regex