ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added docstrings

Browse Source
This commit is contained in:
Oskar Hahn 2017-01-24 15:16:17 +01:00
parent fccde8de11
commit 44474049c3
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
openslides/utils/collection.py
View File

@ -117,6 +117,9 @@ class CollectionElement:
""" """
Returns a dict that can be sent through the autoupdate system for a site Returns a dict that can be sent through the autoupdate system for a site
user. user.
The argument `user` can be anything, that is allowd as argument for
utils.auth.has_perm().
""" """
return self.as_autoupdate( return self.as_autoupdate(
'get_restricted_data', 'get_restricted_data',
@ -133,6 +136,9 @@ class CollectionElement:
def as_dict_for_user(self, user): def as_dict_for_user(self, user):
""" """
Returns a dict with the data for a user. Can be used for the rest api. Returns a dict with the data for a user. Can be used for the rest api.
The argument `user` can be anything, that is allowd as argument for
utils.auth.has_perm().
""" """
return self.get_access_permissions().get_restricted_data( return self.get_access_permissions().get_restricted_data(
self.get_full_data(), self.get_full_data(),
@ -259,6 +265,9 @@ class CollectionElementList(list):
def as_autoupdate_for_user(self, user): def as_autoupdate_for_user(self, user):
""" """
Returns a list of dicts, that can be send though the websocket to a user. Returns a list of dicts, that can be send though the websocket to a user.
The argument `user` can be anything, that is allowd as argument for
utils.auth.has_perm().
""" """
result = [] result = []
for element in self: for element in self:
@ -355,6 +364,9 @@ class Collection:
def as_autoupdate_for_user(self, user): def as_autoupdate_for_user(self, user):
""" """
Returns a list of dicts, that can be send though the websocket to a user. Returns a list of dicts, that can be send though the websocket to a user.
The argument `user` can be anything, that is allowd as argument for
utils.auth.has_perm().
""" """
output = [] output = []
for collection_element in self.element_generator(): for collection_element in self.element_generator():
@ -367,6 +379,9 @@ class Collection:
""" """
Returns a list of dictonaries to send them to a user, for example over Returns a list of dictonaries to send them to a user, for example over
the rest api. the rest api.
The argument `user` can be anything, that is allowd as argument for
utils.auth.has_perm().
""" """
output = [] output = []
for collection_element in self.element_generator(): for collection_element in self.element_generator():