adding docstring and minor fixes

[findit] / src / findit.py

diff --git a/src/findit.py b/src/findit.py
index 4b63bfa..99eaecb 100755 (executable)
--- a/src/findit.py
+++ b/src/findit.py
@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*-coding: utf-8 -*-
 # vim: sw=4 ts=4 expandtab ai
+# pylint: disable-msg=C0301
 
 import gtk
 import gobject
@@ -35,6 +36,9 @@ except IOError:
 
 # Функция которая возвращает строку из числа и единиц для столбца "Размер"("Size")
 def size_convert(size):
+    """This function return string with file size in
+    b or Kb or Mb or Gb or Tb
+    """
     for i, unit in enumerate(['%d b', '%.1f Kb', '%.2f Mb', '%.3f Gb', '%.4f Tb']):
         if size < 1024**(i+1):
             return unit % (size/1024.**i)
@@ -42,6 +46,9 @@ def size_convert(size):
 
 # Функция поставляющая размер файла и путь к нему
 def filegetter(startdir, obj):
+    """This function-generator return size 
+    and path for all files in start directory
+    """
     # Список игнорируемых каталогов:
     ignore_dirs = ['/dev', '/proc', '/sys', '/mnt']
     # Проходим по всем папкам вглубь от заданного пути
@@ -65,13 +72,15 @@ def filegetter(startdir, obj):
                 raise StopIteration
             # Проверяем можем ли мы определить размер файла - иначе пропускаем его
             try:
+                flsize = getsize(flpath)
                 # Возвращаем размер и полный путь файла
-                yield getsize(flpath), flpath
+                yield flsize, flpath
             except OSError:
                 continue
 
 # Fullscreen
 def toggle_fullscreen(obj):
+    """This function switch and unswitch to fullscreen"""
     if obj.fullscreen:
         obj.window.unfullscreen()
     else: 
@@ -80,13 +89,16 @@ def toggle_fullscreen(obj):
 
 # Нажатие на кнопку клавиатуры
 def on_key_press(obj, event):
+    """This function start then FullScreen button on N8xx pressed"""
     if hildonFound and event.keyval == gtk.keysyms.F6:
         toggle_fullscreen(obj)
 
 ### Properties dialog ##########################################################
 
 class PropertiesDialog(gtk.Dialog):
+    """This class describe property window"""
     def __init__(self, path, size, bytesize):
+        """Creating new object of PropertiesDialog class"""
         gtk.Dialog.__init__(self)
         self.set_title( _('File properties') )
         self.set_transient_for(app)
@@ -139,9 +151,11 @@ class PropertiesDialog(gtk.Dialog):
 ### Main window ################################################################
 
 class MainWindow(gtk.Window):
+    """This class describe main window of FindIT"""
 
     # Окно сообщения заданного типа с заданным текстом
     def mess_window(self, mestype, content):
+        """This function show popup message window"""
         dialog = gtk.MessageDialog(parent=self, flags=gtk.DIALOG_MODAL,
                                    type=mestype, buttons=gtk.BUTTONS_OK,
                                    message_format=content)
@@ -152,6 +166,9 @@ class MainWindow(gtk.Window):
 
     # Функция выполняющаяся при нажатии на кнопку "Показать"
     def start_print(self, widget):
+        """This function start then "Go" button pressed.
+        Starting file search.               
+        """
         self.start_path = self.srch_p_entr.get_text()
         # Проверяем правильное ли значение введено
         if isdir(self.start_path):
@@ -186,10 +203,14 @@ class MainWindow(gtk.Window):
 
     # Функция выполняющаяся при нажатии на кнопку "Стоп"
     def stop_print(self, widget):
+        """This function start then "Stop" button pressed.
+        Stoping file search.
+        """
         self.stopit = True
 
     # Функция выполняющаяся при нажатии на кнопку "Свойства файла"
     def show_properties_dialog(self, *args):
+        """This function show property window"""
         selection = self.treeview.get_selection()
         (model, it) = selection.get_selected()
         try:
@@ -204,6 +225,7 @@ class MainWindow(gtk.Window):
     ### Window initialization ##################################################
 
     def __init__(self, win_width, win_height, st_path):
+        """Creating new object of MainWindow class"""
         # Создаем новое окно
         gtk.Window.__init__(self)
         self.set_default_size(win_width, win_height)
@@ -324,6 +346,7 @@ class MainWindow(gtk.Window):
         self.add(main_Vbox)
 
     def run(self):
+        """This function show main window of FindIT"""
         self.show_all()
         gtk.main()