Changeset 729 for trunk/src/utility.py

Timestamp:

03/12/10 01:26:31 (2 years ago)

Author:

pierre

Message:

Add a nice progress bar to all the new connectors in connectors2.py. Now, a verbose flag allows to display or not a progress bar indicating the percentage of connections established. Can be useful to know how long connections will take. Some minors ameliorations. Everything is now OK, some informal tests shows numbers of synapses are ok for all the connectors. The last point to test is to make sure distances are correct. Should be the case, but should be sure....

Files:

• trunk/src/utility.py (modified) (1 diff)

trunk/src/utility.py

@@ -182 +182 @@
             return "%d %s" % (int(val), units) + (val>1 and 's' or '')
         return ', '.join([add_units(T[part], part) for part in ('year', 'day', 'hour', 'minute', 'second') if T[part]>0])
+
+
+class ProgressBar:
+    def __init__(self, min_value = 0, max_value = 100, width=77,**kwargs):
+        self.char = kwargs.get('char', '#')
+        self.mode = kwargs.get('mode', 'dynamic') # fixed or dynamic
+        if not self.mode in ['fixed', 'dynamic']:
+            self.mode = 'fixed'
+ 
+        self.bar = ''
+        self.min = min_value
+        self.max = max_value
+        self.span = max_value - min_value
+        self.width = width
+        self.amount = 0       # When amount == max, we are 100% done 
+        self.update_amount(0) 
+ 
+ 
+    def increment_amount(self, add_amount = 1):
+        """
+        Increment self.amount by 'add_ammount' or default to incrementing
+        by 1, and then rebuild the bar string. 
+        """
+        new_amount = self.amount + add_amount
+        if new_amount < self.min: new_amount = self.min
+        if new_amount > self.max: new_amount = self.max
+        self.amount = new_amount
+        self.build_bar()
+ 
+ 
+    def update_amount(self, new_amount = None):
+        """
+        Update self.amount with 'new_amount', and then rebuild the bar 
+        string.
+        """
+        if not new_amount: new_amount = self.amount
+        if new_amount < self.min: new_amount = self.min
+        if new_amount > self.max: new_amount = self.max
+        self.amount = new_amount
+        self.build_bar()
+ 
+ 
+    def build_bar(self):
+        """
+        Figure new percent complete, and rebuild the bar string base on 
+        self.amount.
+        """
+        diff = float(self.amount - self.min)
+        percent_done = int(round((diff / float(self.span)) * 100.0))
+ 
+        # figure the proper number of 'character' make up the bar 
+        all_full = self.width - 2
+        num_hashes = int(round((percent_done * all_full) / 100))
+ 
+        if self.mode == 'dynamic':
+            # build a progress bar with self.char (to create a dynamic bar
+            # where the percent string moves along with the bar progress.
+            self.bar = self.char * num_hashes
+        else:
+            # build a progress bar with self.char and spaces (to create a 
+            # fixe bar (the percent string doesn't move)
+            self.bar = self.char * num_hashes + ' ' * (all_full-num_hashes)
+ 
+        percent_str = str(percent_done) + "%"
+        self.bar = '[ ' + self.bar + ' ] ' + percent_str
+ 
+ 
+    def __str__(self):
+        return str(self.bar)
+