Coverage for marshall_webapp/models/transients_comments/element/models_transients_comments_element_get.py : 28%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1#!/usr/bin/env python
2# encoding: utf-8
3"""
4*The data model module for the `transients_comments_element_get` resource*
6:Author:
7 David Young
8"""
9from builtins import object
10import sys
11import os
12import khufu
15class models_transients_comments_element_get(object):
16 """
17 *The worker class for the models_transients_comments_element_get module*
19 **Key Arguments**
21 - ``log`` -- logger
22 - ``request`` -- the pyramid request
23 - ``elementId`` -- the specific element id requests (or False)
24 - ``search`` -- is this a search request (boolean)
27 **Usage**
30 ```python
31 usage code
32 ```
35 ```eval_rst
36 .. todo::
38 - add usage info
39 - create a sublime snippet for usage
40 - add a tutorial about ``models_transients_comments_element_get`` to documentation
41 - create a blog post about what ``models_transients_comments_element_get`` does
42 ```
43 """
44 # Initialisation
46 def __init__(
47 self,
48 log,
49 request,
50 elementId=False,
51 search=False
52 ):
53 self.log = log
54 self.request = request
55 self.elementId = elementId
56 self.search = search
57 self.qs = dict(request.params) # the query string
58 # the query string defaults
59 self.defaultQs = {}
60 # xt-self-arg-tmpx
62 log.debug(
63 "instansiating a new 'models_transients_comments_element_get' object")
65 # Variable Data Atrributes
67 # Initial Actions
68 self._set_default_parameters()
70 return None
72 # Method Attributes
73 def get(self):
74 """
75 *execute the get method on the models_transients_comments_element_get object*
77 **Return**
79 - ``responseContent`` -- the reponse to send to the browser
81 """
82 self.log.debug('starting the ``get`` method')
84 elementId = self.elementId
86 responseContent = "Response from <code>" + __name__ + "</code><BR><BR>"
87 if elementId:
88 responseContent = "%(responseContent)sThe element selected was </code>%(elementId)s</code>" % locals(
89 )
90 else:
91 responseContent = "%(responseContent)sResource Context selected (no element)" % locals(
92 )
94 self.log.debug('completed the ``get`` method')
95 return responseContent
97 def _set_default_parameters(
98 self):
99 """
100 *set default parameters*
102 **Key Arguments**
104 -
107 **Return**
109 - None
111 """
112 self.log.debug('starting the ``_set_default_parameters`` method')
114 for k, v in list(self.defaultQs.items()):
115 if k not in self.qs:
116 self.qs[k] = v
118 self.log.debug('completed the ``_set_default_parameters`` method')
119 return None
121 # xt-class-method