coding standards

This commit is contained in:
Yann Leboulanger 2008-09-02 20:31:05 +00:00
parent a530b92290
commit cf0b44d7fc
1 changed files with 20 additions and 22 deletions

View File

@ -95,7 +95,7 @@ C_PADLOCK_PIXBUF, # use for account row only
class RosterWindow: class RosterWindow:
'''Class for main window of the GTK+ interface''' '''Class for main window of the GTK+ interface'''
def _get_account_iter(self, name, model = None): def _get_account_iter(self, name, model=None):
''' '''
Return the gtk.TreeIter of the given account or None Return the gtk.TreeIter of the given account or None
if not found. if not found.
@ -119,8 +119,7 @@ class RosterWindow:
return account_iter return account_iter
def _get_group_iter(self, name, account, account_iter = None, def _get_group_iter(self, name, account, account_iter=None, model=None):
model = None):
''' '''
Return the gtk.TreeIter of the given group or None if not found. Return the gtk.TreeIter of the given group or None if not found.
@ -145,7 +144,7 @@ class RosterWindow:
return group_iter return group_iter
def _get_self_contact_iter(self, jid, account, model = None): def _get_self_contact_iter(self, jid, account, model=None):
''' Return the gtk.TreeIter of SelfContact or None if not found. ''' Return the gtk.TreeIter of SelfContact or None if not found.
Keyword arguments: Keyword arguments:
@ -249,7 +248,7 @@ class RosterWindow:
return False return False
def _iter_contact_rows(self, model = None): def _iter_contact_rows(self, model=None):
'''Iterate over all contact rows in given model. '''Iterate over all contact rows in given model.
Keyword argument Keyword argument
@ -411,7 +410,7 @@ class RosterWindow:
"Iters invalidated for %s" % contact.jid "Iters invalidated for %s" % contact.jid
return added_iters return added_iters
def _remove_entity(self, contact, account, groups = None): def _remove_entity(self, contact, account, groups=None):
'''Remove the given contact from roster data model. '''Remove the given contact from roster data model.
Empty groups after contact removal are removed too. Empty groups after contact removal are removed too.
@ -776,7 +775,7 @@ class RosterWindow:
return True return True
def add_groupchat(self, jid, account, status = ''): def add_groupchat(self, jid, account, status=''):
'''Add groupchat to roster and draw it. '''Add groupchat to roster and draw it.
Return the added contact instance. Return the added contact instance.
''' '''
@ -837,7 +836,7 @@ class RosterWindow:
self.remove_contact(jid, account, force=True, backend=True) self.remove_contact(jid, account, force=True, backend=True)
return True return True
def add_contact_to_groups(self, jid, account, groups, update = True): def add_contact_to_groups(self, jid, account, groups, update=True):
'''Add contact to given groups and redraw them. '''Add contact to given groups and redraw them.
Contact on server is updated too. When the contact has a family, Contact on server is updated too. When the contact has a family,
@ -916,7 +915,7 @@ class RosterWindow:
self.draw_contact(jid, account) self.draw_contact(jid, account)
#FIXME: integrate into add_contact() #FIXME: integrate into add_contact()
def add_to_not_in_the_roster(self, account, jid, nick = '', resource = ''): def add_to_not_in_the_roster(self, account, jid, nick='', resource=''):
keyID = '' keyID = ''
attached_keys = gajim.config.get_per('accounts', account, attached_keys = gajim.config.get_per('accounts', account,
'attached_gpg_keys').split() 'attached_gpg_keys').split()
@ -1047,7 +1046,7 @@ class RosterWindow:
self.draw_contact(parent_jid, parent_account) self.draw_contact(parent_jid, parent_account)
return False return False
def draw_contact(self, jid, account, selected = False, focus = False): def draw_contact(self, jid, account, selected=False, focus=False):
'''draw the correct state image, name BUT not avatar''' '''draw the correct state image, name BUT not avatar'''
# focus is about if the roster window has toplevel-focus or not # focus is about if the roster window has toplevel-focus or not
# FIXME: We really need a custom cell_renderer # FIXME: We really need a custom cell_renderer
@ -1502,7 +1501,7 @@ class RosterWindow:
gajim.config.get('showoffline')) gajim.config.get('showoffline'))
return True return True
def _compareIters(self, model, iter1, iter2, data = None): def _compareIters(self, model, iter1, iter2, data=None):
'''Compare two iters to sort them''' '''Compare two iters to sort them'''
name1 = model[iter1][C_NAME] name1 = model[iter1][C_NAME]
name2 = model[iter2][C_NAME] name2 = model[iter2][C_NAME]
@ -1849,8 +1848,8 @@ class RosterWindow:
dialogs.InformationDialog(_('Authorization has been sent'), dialogs.InformationDialog(_('Authorization has been sent'),
_('Now "%s" will know your status.') %jid) _('Now "%s" will know your status.') %jid)
def req_sub(self, widget, jid, txt, account, groups = [], nickname = None, def req_sub(self, widget, jid, txt, account, groups=[], nickname=None,
auto_auth = False): auto_auth=False):
'''Request subscription to a contact''' '''Request subscription to a contact'''
gajim.connections[account].request_subscription(jid, txt, nickname, gajim.connections[account].request_subscription(jid, txt, nickname,
groups, auto_auth, gajim.nicks[account]) groups, auto_auth, gajim.nicks[account])
@ -2158,7 +2157,7 @@ class RosterWindow:
else: else:
w.window.destroy() w.window.destroy()
def close_all(self, account, force = False): def close_all(self, account, force=False):
'''close all the windows from an account '''close all the windows from an account
if force is True, do not ask confirmation before closing chat/gc windows if force is True, do not ask confirmation before closing chat/gc windows
''' '''
@ -2832,7 +2831,7 @@ class RosterWindow:
def on_add_special_notification_menuitem_activate(self, widget, jid): def on_add_special_notification_menuitem_activate(self, widget, jid):
dialogs.AddSpecialNotificationDialog(jid) dialogs.AddSpecialNotificationDialog(jid)
def on_invite_to_new_room(self, widget, list_, resource = None): def on_invite_to_new_room(self, widget, list_, resource=None):
''' resource parameter MUST NOT be used if more than one contact in ''' resource parameter MUST NOT be used if more than one contact in
list ''' list '''
account_list = [] account_list = []
@ -3467,7 +3466,7 @@ class RosterWindow:
gajim.interface.on_open_chat_window(None, contact, account, \ gajim.interface.on_open_chat_window(None, contact, account, \
resource=resource, session=session) resource=resource, session=session)
def on_roster_treeview_row_activated(self, widget, path, col = 0): def on_roster_treeview_row_activated(self, widget, path, col=0):
'''When an iter is double clicked: open the first event window''' '''When an iter is double clicked: open the first event window'''
if not gajim.single_click: if not gajim.single_click:
self.on_row_activated(widget, path) self.on_row_activated(widget, path)
@ -3999,8 +3998,7 @@ class RosterWindow:
### Cleanup assigned to Jim++ :-) ### Cleanup assigned to Jim++ :-)
################################################################################ ################################################################################
def get_appropriate_state_images(self, jid, size = '16', def get_appropriate_state_images(self, jid, size='16', icon_name='online'):
icon_name = 'online'):
'''check jid and return the appropriate state images dict for '''check jid and return the appropriate state images dict for
the demanded size. icon_name is taken into account when jid is from the demanded size. icon_name is taken into account when jid is from
transport: transport iconset doesn't contain all icons, so we fall back transport: transport iconset doesn't contain all icons, so we fall back
@ -4137,7 +4135,7 @@ class RosterWindow:
self.draw_contact(contact[C_JID].decode('utf-8'), self.draw_contact(contact[C_JID].decode('utf-8'),
contact[C_ACCOUNT].decode('utf-8')) contact[C_ACCOUNT].decode('utf-8'))
def set_renderer_color(self, renderer, style, set_background = True): def set_renderer_color(self, renderer, style, set_background=True):
'''set style for treeview cell, using PRELIGHT system color''' '''set style for treeview cell, using PRELIGHT system color'''
if set_background: if set_background:
bgcolor = self.tree.style.bg[style] bgcolor = self.tree.style.bg[style]
@ -4146,7 +4144,7 @@ class RosterWindow:
fgcolor = self.tree.style.fg[style] fgcolor = self.tree.style.fg[style]
renderer.set_property('foreground-gdk', fgcolor) renderer.set_property('foreground-gdk', fgcolor)
def _iconCellDataFunc(self, column, renderer, model, titer, data = None): def _iconCellDataFunc(self, column, renderer, model, titer, data=None):
'''When a row is added, set properties for icon renderer''' '''When a row is added, set properties for icon renderer'''
theme = gajim.config.get('roster_theme') theme = gajim.config.get('roster_theme')
type_ = model[titer][C_TYPE] type_ = model[titer][C_TYPE]
@ -4189,7 +4187,7 @@ class RosterWindow:
renderer.set_property('xalign', 0.4) renderer.set_property('xalign', 0.4)
renderer.set_property('width', 26) renderer.set_property('width', 26)
def _nameCellDataFunc(self, column, renderer, model, titer, data = None): def _nameCellDataFunc(self, column, renderer, model, titer, data=None):
'''When a row is added, set properties for name renderer''' '''When a row is added, set properties for name renderer'''
theme = gajim.config.get('roster_theme') theme = gajim.config.get('roster_theme')
type_ = model[titer][C_TYPE] type_ = model[titer][C_TYPE]
@ -4474,7 +4472,7 @@ class RosterWindow:
### FIXME: We really need to make it simpler! 1465 lines are a few to much.... ### FIXME: We really need to make it simpler! 1465 lines are a few to much....
################################################################################ ################################################################################
def make_menu(self, force = False): def make_menu(self, force=False):
'''create the main window\'s menus''' '''create the main window\'s menus'''
if not force and not self.actions_menu_needs_rebuild: if not force and not self.actions_menu_needs_rebuild:
return return