Catch errors for fields

Author: Emmanouil Konstantinidis

rest_framework_docs/api_endpoint.py

@@ -11,6 +11,7 @@ def __init__(self, pattern, parent_pattern=None):
         self.path = self.__get_path__(parent_pattern)
         self.allowed_methods = self.__get_allowed_methods__()
         # self.view_name = pattern.callback.__name__
+        self.errors = None
         self.fields = self.__get_serializer_fields__()
 
     def __get_path__(self, parent_pattern):
@@ -27,11 +28,15 @@ def __get_serializer_fields__(self):
         if hasattr(self.callback.cls, 'serializer_class') and hasattr(self.callback.cls.serializer_class, 'get_fields'):
             serializer = self.callback.cls.serializer_class
             if hasattr(serializer, 'get_fields'):
-                fields = [{
-                    "name": key,
-                    "type": str(field.__class__.__name__),
-                    "required": field.required
-                } for key, field in serializer().get_fields().items()]
+                try:
+                    fields = [{
+                        "name": key,
+                        "type": str(field.__class__.__name__),
+                        "required": field.required
+                    } for key, field in serializer().get_fields().items()]
+                except KeyError as e:
+                    self.errors = e
+                    fields = []
 
                 # FIXME:
                 # Show more attibutes of `field`?

rest_framework_docs/static/less/style.less

@@ -86,6 +86,11 @@ body {
 
   .panel-body {
     padding: 0;
+
+    .alert {
+      padding: 5px 10px;
+      margin-top: 10px;
+    }
   }
 
   > .panel-heading +.panel-collapse > .panel-body { border: 0; }

rest_framework_docs/templates/rest_framework_docs/home.html

@@ -48,14 +48,18 @@ <h4 class="panel-title title">
 
         <div id="{{ endpoint.path|slugify }}" class="panel-collapse collapse" role="tabpanel">
           <div class="panel-body">
+            {% if endpoint.errors %}
+            <div class="alert alert-danger" role="alert">Oops! There was something wrong with {{ endpoint.errors }}. Please check your code.</div>
+            {% endif %}
+
             {% if endpoint.fields %}
             <p>Fields:</p>
               <ul class="list fields">
               {% for field in endpoint.fields %}
                 <li class="field">{{ field.name }}: {{ field.type }} {% if field.required %}<span class="label label-primary label-required" title="Required">R</span>{% endif %}</li>
               {% endfor %}
               </ul>
-            {% else %}
+            {% elif not endpoint.errors %}
             <p>No fields.</p>
             {% endif %}
           </div>

runtests.py

@@ -44,7 +44,7 @@ def run_tests_coverage():
         cov.stop()
         cov.save()
         cov.report()
-        # cov.html_report(directory='covhtml')
+        cov.html_report(directory='covhtml')
 
 exit_on_failure(flake8_main(FLAKE8_ARGS))
 exit_on_failure(run_tests_coverage())