-

cool-RR · cool-RR · commit 79bf5ea386be · 2013-09-06T04:15:53.000+03:00
diff --git a/python_toolbox/binary_search/functions.py b/python_toolbox/binary_search/functions.py
@@ -45,7 +45,7 @@ def _binary_search_both(sequence, function, value):
     `sequence`.
     
     Note: This function uses `None` to express its inability to find any
-    matches; therefore, you better not use it on sequences in which None is a
+    matches; therefore, you better not use it on sequences in which `None` is a
     possible item.
     '''
     # todo: i think this should be changed to return tuples
diff --git a/python_toolbox/cute_profile/cute_profile.py b/python_toolbox/cute_profile/cute_profile.py
@@ -18,6 +18,7 @@
 
 
 def profile(statement, globals_, locals_):
+    '''Profile a statement and return the `Profile`.'''
     profile_ = base_profile.Profile()
     result = None
     try:
@@ -29,13 +30,13 @@ def profile(statement, globals_, locals_):
 
 
 def profile_expression(expression, globals_, locals_):
+    '''Profile an expression, and return a tuple of `(result, profile)`.'''
     profile_ = profile('result = %s' % expression, globals_, locals_)
     return (locals_['result'], profile_)
 
 
 def profile_ready(condition=None, off_after=True, profile_handler=None):
     '''
-    blocktododoc
     Decorator for setting a function to be ready for profiling.
     
     For example:
@@ -50,6 +51,8 @@ def f(x, y):
      
      2. You can set the function to be profiled *when* you want, on the fly.
      
+     3. You can have the profile results handled in various useful ways.
+     
     How can you set the function to be profiled? There are a few ways:
     
     You can set `f.profiling_on=True` for the function to be profiled on the
@@ -65,7 +68,18 @@ def f(x, y):
     turned off afterwards as well. (Unless, again, `f.off_after` is set to
     `False`.)
     
-    `sort` is an `int` specifying which column the results will be sorted by.
+    Using `profile_handler` you can say what will be done with profile results.
+    If `profile_handler` is an `int`, the profile results will be printed, with
+    the sort order determined by `profile_handler`. If `profile_handler` is a
+    directory path, profiles will be saved to files in that directory. If
+    `profile_handler` is details on how to send email, the profile will be sent
+    as an attached file via email, on a separate thread.
+    
+    To send email, supply a `profile_handler` like so, with values separated by
+    newlines:
+    
+       'ram@rachum.com\nsmtp.gmail.com\nsmtp_username\nsmtppassword'
+       
     '''
     
     
diff --git a/python_toolbox/cute_profile/profile_handling.py b/python_toolbox/cute_profile/profile_handling.py
@@ -17,6 +17,7 @@
 
 
 class BaseProfileHandler(object):
+    '''Profile handler which saves the profiling result in some way.'''
     __metaclass__ = abc.ABCMeta
     
     def __call__(self, profile):
@@ -34,7 +35,7 @@ def handle(self):
     
 
 class AuxiliaryThreadProfileHandler(BaseProfileHandler):
-    
+    '''Profile handler that does its action on a separate thread.'''
     thread = None
     
     def handle(self):
@@ -47,6 +48,7 @@ def thread_job(self):
     
 
 class EmailProfileHandler(AuxiliaryThreadProfileHandler):
+    '''Profile handler that sends the profile via email on separate thread.'''
     def __init__(self, email_address, smtp_server, smtp_user, smtp_password,
                  use_tls=True):
         
@@ -76,6 +78,7 @@ def thread_job(self):
 
 
 class FolderProfileHandler(AuxiliaryThreadProfileHandler):
+    '''Profile handler that saves the profile to disk on separate thread.'''
     
     def __init__(self, folder_path):
         self.folder_path = folder_path
@@ -88,7 +91,7 @@ def thread_job(self):
 
 
 class PrintProfileHandler(BaseProfileHandler):
-    
+    '''Profile handler that prints profile data to standard output.'''
     def __init__(self, sort_order):
         self.sort_order = sort_order
         
@@ -99,6 +102,7 @@ def handle(self):
 
 
 def get_profile_handler(profile_handler_string):
+    '''Parse `profile_handler_string` into a `ProfileHandler` class.'''
     if not profile_handler_string or profile_handler_string in \
                                                         map(str, range(-1, 5)):
         try:
