Skip to content

progress_bar

MultiStepProgressBar

Source code in src/antakia/gui/progress_bar.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
class MultiStepProgressBar:
    def __init__(self, widget, steps=1, active_color='blue', unactive_color='grey', reset_at_end=True):
        """
        generic progress bar update

        Parameters
        ----------
        widget : widget element
        steps
        active_color
        unactive_color
        reset_at_end : should we reset widget when 100% is reached
        """
        self.steps = steps
        self.widget = widget
        self.active_color = active_color
        self.unactive_color = unactive_color
        self.widget.v_model = 0
        self.reset_at_end = reset_at_end

    def get_update(self, step):
        """
        returns the progress updater for the provided step
        Parameters
        ----------
        step

        Returns
        -------

        """
        if step == 0 or step > self.steps:
            raise ValueError('step should be between 1 and self.steps')

        def update_ac_progress_bar(progress: float, duration: float):
            """
            Called by the AutoCluster to update the progress bar
            """
            self.widget.color = self.active_color
            progress = round(((step - 1) * 100 + progress) / self.steps)
            self.set_progress(progress)

        return update_ac_progress_bar

    def set_progress(self, progress):
        """
        force progress value
        Parameters
        ----------
        progress

        Returns
        -------

        """
        self.widget.v_model = progress
        if progress >= 100 and self.reset_at_end:
            self.reset_progress_bar()

    def reset_progress_bar(self):
        self.progress = 0
        self.widget.color = self.unactive_color

__init__(widget, steps=1, active_color='blue', unactive_color='grey', reset_at_end=True)

generic progress bar update

Parameters

widget : widget element steps active_color unactive_color reset_at_end : should we reset widget when 100% is reached

Source code in src/antakia/gui/progress_bar.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def __init__(self, widget, steps=1, active_color='blue', unactive_color='grey', reset_at_end=True):
    """
    generic progress bar update

    Parameters
    ----------
    widget : widget element
    steps
    active_color
    unactive_color
    reset_at_end : should we reset widget when 100% is reached
    """
    self.steps = steps
    self.widget = widget
    self.active_color = active_color
    self.unactive_color = unactive_color
    self.widget.v_model = 0
    self.reset_at_end = reset_at_end

get_update(step)

returns the progress updater for the provided step Parameters

step

Returns
Source code in src/antakia/gui/progress_bar.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def get_update(self, step):
    """
    returns the progress updater for the provided step
    Parameters
    ----------
    step

    Returns
    -------

    """
    if step == 0 or step > self.steps:
        raise ValueError('step should be between 1 and self.steps')

    def update_ac_progress_bar(progress: float, duration: float):
        """
        Called by the AutoCluster to update the progress bar
        """
        self.widget.color = self.active_color
        progress = round(((step - 1) * 100 + progress) / self.steps)
        self.set_progress(progress)

    return update_ac_progress_bar

set_progress(progress)

force progress value Parameters

progress

Returns
Source code in src/antakia/gui/progress_bar.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def set_progress(self, progress):
    """
    force progress value
    Parameters
    ----------
    progress

    Returns
    -------

    """
    self.widget.v_model = progress
    if progress >= 100 and self.reset_at_end:
        self.reset_progress_bar()

ProgressBar

Source code in src/antakia/gui/progress_bar.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class ProgressBar:
    def __init__(self, widget, indeterminate: bool = False, active_color='blue', unactive_color='grey',
                 reset_at_end=True):
        """
        generic progress bar update
        Parameters
        ----------
        widget : widget element
        indeterminate : whether the progress is indeterminate or finegrained
        active_color
        unactive_color
        reset_at_end : should we reset widget when 100% is reached
        """
        self.active_color = active_color
        self.unactive_color = unactive_color
        assert isinstance(widget, (v.ProgressLinear, v.ProgressCircular))
        self.widget = widget
        self.indeterminate = indeterminate
        self.progress = 0
        self.reset_at_end = reset_at_end

    def update(self, progress: float, time_elapsed):
        """

        Parameters
        ----------
        progress: progress value between 0 and 100
        time_elapsed : duration since start

        Returns
        -------

        """
        self.progress = progress
        self.widget.color = self.active_color
        self.widget.indeterminate = self.indeterminate


        if math.ceil(progress) >= 100 and self.reset_at_end:
            self.reset_progress_bar()

    def reset_progress_bar(self):
        self.progress = 100
        self.widget.indeterminate = False
        self.widget.color = self.unactive_color

    def __call__(self, *args, **kwargs):
        return self.update(*args, **kwargs)

    @property
    def progress(self):
        return self.widget.v_model

    @progress.setter
    def progress(self, value):
        if value is None or pd.isna(value):
            self.widget.indeterminate = True
        else:
            if self.indeterminate and value <= 99:
                self.widget.indeterminate = True
            else:
                self.widget.indeterminate = False
            self.widget.v_model = value

__init__(widget, indeterminate=False, active_color='blue', unactive_color='grey', reset_at_end=True)

generic progress bar update Parameters

widget : widget element indeterminate : whether the progress is indeterminate or finegrained active_color unactive_color reset_at_end : should we reset widget when 100% is reached

Source code in src/antakia/gui/progress_bar.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def __init__(self, widget, indeterminate: bool = False, active_color='blue', unactive_color='grey',
             reset_at_end=True):
    """
    generic progress bar update
    Parameters
    ----------
    widget : widget element
    indeterminate : whether the progress is indeterminate or finegrained
    active_color
    unactive_color
    reset_at_end : should we reset widget when 100% is reached
    """
    self.active_color = active_color
    self.unactive_color = unactive_color
    assert isinstance(widget, (v.ProgressLinear, v.ProgressCircular))
    self.widget = widget
    self.indeterminate = indeterminate
    self.progress = 0
    self.reset_at_end = reset_at_end

update(progress, time_elapsed)

Parameters

progress: progress value between 0 and 100 time_elapsed : duration since start

Returns
Source code in src/antakia/gui/progress_bar.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def update(self, progress: float, time_elapsed):
    """

    Parameters
    ----------
    progress: progress value between 0 and 100
    time_elapsed : duration since start

    Returns
    -------

    """
    self.progress = progress
    self.widget.color = self.active_color
    self.widget.indeterminate = self.indeterminate


    if math.ceil(progress) >= 100 and self.reset_at_end:
        self.reset_progress_bar()