py_tasks_melange: comparison app/soc/views/models/base.py

equal deleted inserted replaced

-:1cd81063a4c6
+:d22e4fe8e64b
 self._rights = dicts.merge(rights, new_rights)
 self._params = dicts.merge(params, new_params)
 def public(self, request, page_name=None, params=None, **kwargs):
-"""Displays the public page for the entity specified by **kwargs
+"""Displays the public page for the entity specified by **kwargs.
 Args:
 request: the standard Django HTTP request object
 page: a soc.logic.site.page.Page object which is abstraction
 that combines a Django view with sidebar menu info
 template = params['public_template']
 return helper.responses.respond(request, template, context)
 def create(self, request, page_name=None, params=None, **kwargs):
-"""Displays the create page for this entity type
+"""Displays the create page for this entity type.
 Args:
 request: the standard Django HTTP request object
 page: a soc.logic.site.page.Page object which is abstraction
 that combines a Django view with sidebar menu info
 return self.edit(request, page_name=page_name, params=params, **empty_kwargs)
 else:
 return self.edit(request, page_name=page_name, params=params, seed=kwargs, **empty_kwargs)
 def edit(self, request, page_name=None, params=None, seed=None, **kwargs):
-"""Displays the edit page for the entity specified by **kwargs
+"""Displays the edit page for the entity specified by **kwargs.
 Args:
 request: the standard Django HTTP request object
 page: a soc.logic.site.page.Page object which is abstraction
 that combines a Django view with sidebar menu info
 return self.editPost(request, entity, context, params)
 else:
 return self.editGet(request, entity, context, seed, params)
 def editPost(self, request, entity, context, params):
-"""Same as edit, but on POST
+"""Same as edit, but on POST.
 """
 params = dicts.merge(params, self._params)
 if entity:
 return helper.responses.redirectToChangedSuffix(
 request, old_suffix, suffix,
 params=page_params)
 def editGet(self, request, entity, context, seed, params):
-"""Same as edit, but on GET
+"""Same as edit, but on GET.
 """
 params = dicts.merge(params, self._params)
 suffix = self._logic.getKeySuffix(entity)
 form = params['create_form']()
 return self._constructResponse(request, entity, context, form, params)
 def list(self, request, page_name=None, params=None):
-"""Displays the list page for the entity type
+"""Displays the list page for the entity type.
 Args:
 request: the standard Django HTTP request object
 page: a soc.logic.site.page.Page object which is abstraction
 that combines a Django view with sidebar menu info
 template = params['list_template']
 return helper.responses.respond(request, template, context)
 def delete(self, request, page_name=None, params=None, **kwargs):
-"""Shows the delete page for the entity specified by kwargs
+"""Shows the delete page for the entity specified by **kwargs.
 Args:
 request: the standard Django HTTP request object
 page: a soc.logic.site.page.Page object which is abstraction
 that combines a Django view with sidebar menu info
 redirect = params['delete_redirect']
 return http.HttpResponseRedirect(redirect)
 def _editPost(self, request, entity, fields):
-"""Performs any required processing on the entity to post its edit page
+"""Performs any required processing on the entity to post its edit page.
 Args:
 request: the django request object
 entity:  the entity to create or update from POST contents
 fields: the new field values
 """
 pass
 def _public(self, request, entity, context):
-"""Performs any required processing to get an entities public page
+"""Performs any required processing to get an entities public page.
 Args:
 request: the django request object
 entity: the entity to make public
 context: the context object
 """
 pass
 def _editGet(self, request, entity, form):
-"""Performs any required processing on the form to get its edit page
+"""Performs any required processing on the form to get its edit page.
 Args:
 request: the django request object
 entity: the entity to get
 form: the django form that will be used for the page
 """
 pass
 def _editSeed(self, request, seed):
-"""Performs any required processing on the form to get its edit page
+"""Performs any required processing on the form to get its edit page.
 Args:
 request: the django request object
 seed: the fields to seed the create page with
 """
 pass
 def checkUnspecified(self, access_type, request):
-"""Checks whether an unspecified access_type should be allowed
+"""Checks whether an unspecified access_type should be allowed.
 Args:
 access_type: the access type (such as 'list' or 'edit') that was
 not present in the _rights dictionary when checking.
 """
 pass
 def _constructResponse(self, request, entity, context, form, params):
-"""Updates the context and returns a response for the specified arguments
+"""Updates the context and returns a response for the specified arguments.
 Args:
 request: the django request object
 entity: the entity that is used
 context: the context to be used
 for check in self._rights[access_type]:
 check(request)
 def collectCleanedFields(self, form):
-"""Collects all cleaned fields and returns them with the key_name
+"""Collects all cleaned fields and returns them with the key_name.
 Args:
 form: The form from which the cleaned fields should be collected
 """
 result = '/'.join(patterns)
 return result
 def _getSidebarItems(self, params):
-"""Retrieves a list of sidebar entries for this view from self._params
+"""Retrieves a list of sidebar entries for this view from self._params.
 If params['sidebar'] is None default entries will be constructed
 """
 # Return the found result
 result.append(item)
 return result
 def getSidebarLinks(self, params=None):
-"""Returns an dictionary with one sidebar entry
+"""Returns an dictionary with one sidebar entry.
 Args:
 params: see __init__
 """
 res['items'] = items
 return res
 def getDjangoURLPatterns(self, params=None):
-"""Retrieves a list of sidebar entries for this view from self._params
+"""Retrieves a list of sidebar entries for this view from self._params.
-If self._params['django_patterns'] is None default entries will be constructed
+If self._params['django_patterns'] is None default entries will be constructed.
 """
 params = dicts.merge(params, self._params)
 # Return the found result

changeset 499	d22e4fe8e64b
parent 497	73666a7cd718
child 500	44ea4620c5c0