[Checkins] SVN: z3c.securitytool/trunk/src/z3c/securitytool/ added
some docstrings
Daniel Blackburn
blackburnd at gmail.com
Sat Jan 26 10:05:04 EST 2008
Log message for revision 83248:
added some docstrings
Changed:
U z3c.securitytool/trunk/src/z3c/securitytool/browser/views.py
U z3c.securitytool/trunk/src/z3c/securitytool/securitytool.py
-=-
Modified: z3c.securitytool/trunk/src/z3c/securitytool/browser/views.py
===================================================================
--- z3c.securitytool/trunk/src/z3c/securitytool/browser/views.py 2008-01-26 14:42:59 UTC (rev 83247)
+++ z3c.securitytool/trunk/src/z3c/securitytool/browser/views.py 2008-01-26 15:05:04 UTC (rev 83248)
@@ -17,6 +17,10 @@
SESSION_KEY = 'securitytool'
class ViewPrincipalMatrix(BrowserView):
+ """ This is the view used to populate the vum.html
+ (securitytool main page)
+ """
+
pageTemplateFile = "viewprincipalmatrix.pt"
evenOddClasses = ('even','odd')
@@ -55,6 +59,7 @@
def cssclass(self):
+ """ determiner what background color to use for lists """
if self.evenodd != 1:
self.evenodd = 1
else:
@@ -70,6 +75,7 @@
@property
def skinTypes(self):
+ """ gets all the available skins on the system """
skinNames = {}
for name, util in zapi.getUtilitiesFor(IBrowserSkinType, self.context):
skinNames[name] = False
@@ -80,6 +86,7 @@
@property
def urlEncodedViewName(self):
+ """ properly formats variables for use in urls """
urlNames = {}
for key in self.views.keys():
urlNames[key] = urllib.quote(key)
@@ -87,6 +94,7 @@
def getPermissionList(self):
+ """ returns sorted permission list"""
return sorted(self.permissions)
def render(self):
@@ -97,6 +105,7 @@
return self.render()
class PrincipalDetails(BrowserView):
+ """ view class for ud.html (User Details)"""
pageTemplateFile = "principalinfo.pt"
def update(self):
@@ -119,6 +128,8 @@
return self.render()
class PermissionDetails(BrowserView):
+ """ view class for pd.html (Permission Details)"""
+
pageTemplateFile = "permdetails.pt"
def update(self):
Modified: z3c.securitytool/trunk/src/z3c/securitytool/securitytool.py
===================================================================
--- z3c.securitytool/trunk/src/z3c/securitytool/securitytool.py 2008-01-26 14:42:59 UTC (rev 83247)
+++ z3c.securitytool/trunk/src/z3c/securitytool/securitytool.py 2008-01-26 15:05:04 UTC (rev 83248)
@@ -25,6 +25,7 @@
from z3c.securitytool import interfaces
class SecurityChecker(object):
+ """ Workhorse of the security tool package"""
implements(interfaces.ISecurityChecker)
adapts(Interface)
@@ -47,6 +48,7 @@
def getPermissionSettingsForAllViews(self,interfaces,skin=IBrowserRequest,
selectedPermission=None):
+ """ retrieves permission settings for all views"""
request = TestRequest()
self.skin = skin
self.selectedPermission = selectedPermission
@@ -64,6 +66,7 @@
def populateMatrix(self,viewInstance,view_reg):
+ """ populates the matrix used for display on all the views"""
info = getViewInfoDictionary(view_reg)
read_perm = info['read_perm']
@@ -153,6 +156,7 @@
# TODO: Rename
def policyPermissions(self, principal, settings):
+ """ this method populates the principal permissions dict """
prinPermSettings = {'permissions': [],
'roles': {},
'groups': {}}
More information about the Checkins
mailing list