a few style fixes and docstrings

pyweb/mumble/forms.py

@@ -22,9 +22,7 @@ from models			import *
 
 
 class MumbleAdminForm( ModelForm ):
-	"""
-	A Mumble Server admin form intended to be used by the server hoster.
-	"""
+	""" A Mumble Server admin form intended to be used by the server hoster. """
 	class Meta:
 		model   = Mumble;
 		exclude = ( 'sslcrt', 'sslkey' );
@@ -44,7 +42,7 @@ class MumbleForm( ModelForm ):
 
 
 class MumbleUserForm( ModelForm ):
-	"""The user registration form used to register an account."""
+	""" The user registration form used to register an account. """
 	
 	def clean_name( self ):
 		name = self.cleaned_data['name'];
@@ -64,7 +62,7 @@ class MumbleUserForm( ModelForm ):
 
 
 class MumbleUserPasswordForm( MumbleUserForm ):
-	"""The user registration form used to register an account on a private server in protected mode."""
+	""" The user registration form used to register an account on a private server in protected mode. """
 	
 	serverpw = forms.CharField(
 		label=_('Server Password'),
@@ -87,7 +85,7 @@ class MumbleUserPasswordForm( MumbleUserForm ):
 		return self.cleaned_data;
 
 class MumbleTextureForm( Form ):
-	"""The form used to upload a new image to be set as texture."""
+	""" The form used to upload a new image to be set as texture. """
 	texturefile = forms.ImageField();
 
 

pyweb/mumble/mctl.py

@@ -18,9 +18,9 @@
 import re
 
 class MumbleCtlBase (object):
-	cache = {};
+	""" This class defines the base interface that the Mumble model expects. """
 	
-	''' abstract Ctrol Object '''
+	cache = {};
 	
 	def getAllConf(self, srvid):
 		raise NotImplementedError( "mctl::getAllConf" );
@@ -93,6 +93,8 @@ class MumbleCtlBase (object):
 	
 	@staticmethod
 	def newInstance( connstring ):
+		""" Create a new CTL object for the given connstring. """
+		
 		# check cache
 		if connstring in MumbleCtlBase.cache:
 			return MumbleCtlBase.cache[connstring];

pyweb/mumble/mmobjects.py

@@ -74,12 +74,18 @@ class mmChannel( object ):
 	
 	playerCount = property(
 		lambda self: len( self.players ) + sum( [ chan.playerCount for chan in self.subchans ] ),
-		None
+		doc="The number of players in this channel."
 		);
 	
-	id   = property( lambda self: "channel_%d"%self.chanid, None );
+	id   = property(
+		lambda self: "channel_%d"%self.chanid,
+		doc="A string ready to be used in an id property of an HTML tag."
+		);
 	
-	show = property( lambda self: self.parent is None or self.parent.chanid == 0 or self.playerCount > 0, None );
+	show = property(
+		lambda self: self.parent is None or self.parent.chanid == 0 or self.playerCount > 0,
+		doc="True if this channel needs to be shown because it is root, a child of root, or has players."
+		);
 	
 	def __str__( self ):
 		return '<Channel "%s" (%d)>' % ( self.name, self.chanid );
@@ -122,13 +128,17 @@ class mmChannel( object ):
 		
 		return "mumble://%s%s/%s" % ( userstr, self.server.addr, chanpath );
 	
-	connecturl = property( getURL, None );
+	connecturl = property( getURL, doc="A convenience wrapper for getURL." );
 	
 	def setDefault( self ):
+		"Make this the server's default channel."
 		self.server.defchan = self.chanid;
 		self.server.save();
 	
-	is_default = property( lambda self: self.server.defchan == self.chanid, None );
+	is_default = property(
+		lambda self: self.server.defchan == self.chanid,
+		doc="True if this channel is the server's default channel."
+		);
 
 
 
@@ -156,7 +166,7 @@ class mmPlayer( object ):
 		self.channel = playerChan;
 		self.channel.players.append( self );
 		
-		if self.isAuthed():
+		if self.isAuthed:
 			from models import Mumble, MumbleUser
 			try:
 				self.mumbleuser = MumbleUser.objects.get( mumbleid=self.dbaseid, server=srvInstance );
@@ -168,12 +178,14 @@ class mmPlayer( object ):
 	def __str__( self ):
 		return '<Player "%s" (%d, %d)>' % ( self.name, self.userid, self.dbaseid );
 	
-	def isAuthed( self ):
-		return self.dbaseid != -1;
+	isAuthed = property(
+		lambda self: self.dbaseid != -1,
+		doc="True if this player is authenticated (+A)."
+		);
 	
 	isAdmin = property(
 		lambda self: self.mumbleuser and self.mumbleuser.getAdmin(),
-		None
+		doc="True if this player is in the Admin group in the ACL."
 		);
 	
 	is_server  = False;
@@ -181,10 +193,15 @@ class mmPlayer( object ):
 	is_player  = True;
 	
 	# kept for compatibility to mmChannel (useful for traversal funcs)
-	playerCount = property( lambda self: -1, None );
-	id = property( lambda self: "player_%d"%self.userid, None );
+	playerCount = property( lambda self: -1, doc="Exists only for compatibility to mmChannel." );
+	
+	id = property(
+		lambda self: "player_%d"%self.userid,
+		doc="A string ready to be used in an id property of an HTML tag."
+		);
 	
 	def visit( self, callback, lvl = 0 ):
+		""" Call callback on myself. """
 		callback( self, lvl );
 
 
@@ -214,7 +231,7 @@ class mmACL:
 		self.inherit = inherit;
 	
 	def pack( self ):
-		"""Packs the information in this ACL up in a way that it can be passed to DBus."""
+		""" Pack the information in this ACL up in a way that it can be passed to DBus. """
 		return (
 			self.channelId,
 			[( acl['applyHere'], acl['applySubs'], acl['inherited'], acl['playerid'], acl['group'], acl['allow'], acl['deny'] ) for acl in self.acls ],

pyweb/mumble/views.py

@@ -34,10 +34,11 @@ from mmobjects				import *
 
 
 def redir( request ):
+	""" Redirect to the servers list. """
 	return HttpResponseRedirect( reverse( mumbles ) );
 
 def mumbles( request ):
-	"""Display a list of all configured Mumble servers, or redirects if only one configured."""
+	""" Display a list of all configured Mumble servers, or redirect if only one configured. """
 	mumbles = get_list_or_404( Mumble );
 	
 	if len(mumbles) == 1:
@@ -165,7 +166,11 @@ def show( request, server ):
 
 
 def showTexture( request, server, userid = None ):
-	"""Pack the currently logged in user's texture (if any) into an HttpResponse."""
+	""" Pack the given user's texture into an HttpResponse.
+	
+	    If userid is none, use the currently logged in User.
+	"""
+	
 	srv  = get_object_or_404( Mumble, id=int(server) );
 	
 	if userid is None:
@@ -188,6 +193,11 @@ def showTexture( request, server, userid = None ):
 
 @login_required
 def users( request, server ):
+	""" Create a list of MumbleUsers for a given server serialized as a JSON object.
+	
+	    If the request has a "data" field, evaluate that and update the user records.
+	"""
+	
 	srv = get_object_or_404( Mumble, id=int(server) );
 	
 	if not srv.isUserAdmin( request.user ):
@@ -240,7 +250,8 @@ def users( request, server ):
 
 @login_required
 def djangousers( request ):
-	"Return a list of all Django users' names and IDs."
+	""" Return a list of all Django users' names and IDs. """
+	
 	users = [ { 'uid': '', 'uname': '------' } ];
 	for du in User.objects.all().order_by( 'username' ):
 		users.append( {