Skipping the module looks better in the docs, so move it

twisted · Aug 1, 2016 · 8a473e1 · 8a473e1
1 parent 6674b3d
commit 8a473e1
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/docs/introduction/codeexamples/html.py b/docs/introduction/codeexamples/html.py
@@ -1,13 +1,12 @@
-from klein.plating import Plating, CONTENT
 from twisted.web.template import tags, slot
-from klein import Klein
+from klein import Klein, Plating
 app = Klein()
 
 style = Plating(
     tags=tags.html(
         tags.head(tags.title(slot("title"))),
         tags.body(tags.h1(slot("title"), Class="title"),
-                  tags.div(slot(CONTENT)))
+                  tags.div(slot(Plating.CONTENT)))
     )
 )
 

diff --git a/src/klein/__init__.py b/src/klein/__init__.py
@@ -1,6 +1,7 @@
 from __future__ import absolute_import, division
 
 from klein.app import Klein, run, route, resource
+from klein._plating import Plating
 
 
 __version__ = "15.3.1"
@@ -11,6 +12,7 @@
 
 __all__ = [
     'Klein',
+    'Plating',
     '__author__',
     '__copyright__',
     '__license__',

diff --git a/src/klein/plating.py → src/klein/_plating.py b/src/klein/plating.py → src/klein/_plating.py
@@ -12,9 +12,6 @@
 from twisted.web.template import TagLoader, Element
 from twisted.web.error import MissingRenderMethod
 
-CONTENT = "klein:plating:content"
-
-
 def _should_return_json(request):
     """
     Should the given request result in a JSON entity-body?
@@ -85,6 +82,8 @@ class Plating(object):
     Its name is derived both from tem-I{plating} and I{chrome plating}.
     """
 
+    CONTENT = "klein:plating:content"
+
     def __init__(self, defaults=None, tags=None):
         """
         
@@ -107,14 +106,14 @@ def mymethod(request, *args, **kw):
                 data = method(request, *args, **kw)
                 if _should_return_json(request):
                     json_data = self._defaults.copy()
-                    if CONTENT in json_data:
-                        del json_data[CONTENT]
+                    if self.CONTENT in json_data:
+                        del json_data[self.CONTENT]
                     json_data.update(data)
                     request.setHeader(b'content-type',
                                       b'text/json; charset=utf-8')
                     return json_serialize(json_data)
                 else:
-                    data[CONTENT] = loader.load()
+                    data[self.CONTENT] = loader.load()
                     return self._elementify(data)
             return method
         return mydecorator

diff --git a/src/klein/test/test_plating.py b/src/klein/test/test_plating.py
@@ -8,7 +8,7 @@
 
 import json
 
-from klein.plating import Plating, CONTENT
+from klein import Plating
 from twisted.web.template import tags, slot
 
 from klein.test.test_resource import requestMock, _render
@@ -18,13 +18,13 @@
 page = Plating(
     defaults={
         "title": "default title unchanged",
-        CONTENT: "NEVER MIND THE CONTENT",
+        Plating.CONTENT: "NEVER MIND THE CONTENT",
     },
     tags=tags.html(
         tags.head(tags.title(slot("title"))),
         tags.body(
             tags.h1(slot("title")),
-            tags.div(slot(CONTENT),
+            tags.div(slot(Plating.CONTENT),
                      Class="content")
         )
     ),