@@ -129,60 +129,60 @@ Alternatively, the progress can be tracked via the equivalent generator function
129
129
* `ProgBar(iterations, track_time=True, width=30, bar_char='#',
130
130
stream=2, title='', monitor=False, update_interval=None, email=False))`*
131
131
132
- - iterations : ` int `
132
+ - iterations : ` int `
133
133
Number of iterations for the iterative computation.
134
- - track_time : ` bool ` (default: ` True ` )
134
+ - track_time : ` bool ` (default: ` True ` )
135
135
Prints elapsed time when loop has finished.
136
- - width : ` int ` (default: 30)
136
+ - width : ` int ` (default: 30)
137
137
Sets the progress bar width in characters.
138
- - stream : ` int ` (default: 2).
138
+ - stream : ` int ` (default: 2).
139
139
Setting the output stream.
140
140
Takes ` 1 ` for stdout, ` 2 ` for stderr, or a custom stream object
141
- - title : ` str ` (default: ` '' ` )
141
+ - title : ` str ` (default: ` '' ` )
142
142
Setting a title for the progress bar.
143
- - monitor : ` bool ` (default: ` False ` )
143
+ - monitor : ` bool ` (default: ` False ` )
144
144
Monitors CPU and memory usage if ` True ` (requires ` psutil ` package).
145
- - update_interval : float or int (default: ` None ` )
145
+ - update_interval : float or int (default: ` None ` )
146
146
The update_interval in seconds controls how often the progress
147
147
is flushed to the screen.
148
148
Automatic mode if ` update_interval=None ` .
149
- - email : ` bool ` (default: False)
149
+ - email : ` bool ` (default: False)
150
150
If ` True ` sends an email notification after finishing the task
151
151
152
152
##### ProgPercent
153
153
154
154
* `ProgPercent(iterations, track_time=True,
155
155
stream=2, title='', monitor=False, update_interval=None, email=False)`*
156
156
157
- - iterations : ` int `
158
- Number of iterations for the iterative computation.
159
- - track_time : ` bool ` (default: ` True ` )
157
+ - iterations : ` int `
158
+ Number of iterations for the iterative computation.
159
+ - track_time : ` bool ` (default: ` True ` )
160
160
Prints elapsed time when loop has finished.
161
- - stream : ` int ` (default: 2).
161
+ - stream : ` int ` (default: 2).
162
162
Setting the output stream.
163
163
Takes ` 1 ` for stdout, ` 2 ` for stderr, or a custom stream object
164
- - title : ` str ` (default : ` '' ` ).
164
+ - title : ` str ` (default : ` '' ` ).
165
165
Setting a title for the percentage indicator.
166
- - monitor : ` bool ` (default: ` False ` )
166
+ - monitor : ` bool ` (default: ` False ` )
167
167
Monitors CPU and memory usage if ` True ` (requires ` psutil ` package).
168
- - update_interval : float or int (default: ` None ` )
168
+ - update_interval : float or int (default: ` None ` )
169
169
The update_interval in seconds controls how often the progress
170
170
is flushed to the screen.
171
171
Automatic mode if ` update_interval=None ` .
172
- - email : ` bool ` (default: False)
172
+ - email : ` bool ` (default: False)
173
173
If ` True ` sends an email notification after finishing the task
174
174
175
175
##### update method
176
176
177
177
* ` update(iterations=1, item_id=None, force_flush=False) ` *
178
178
179
- - iterations : int (default: ` 1 ` )
179
+ - iterations : int (default: ` 1 ` )
180
180
default argument can be changed to integer values
181
181
` >=1 ` in order to update the progress indicators more than once
182
182
per iteration.
183
- - item_id : str (default: ` None ` )
183
+ - item_id : str (default: ` None ` )
184
184
Print an item_id sring behind the progress bar
185
- - force_flush : bool (default: ` False ` )
185
+ - force_flush : bool (default: ` False ` )
186
186
If True, flushes the progress indicator to the output screen
187
187
in each iteration.
188
188
@@ -192,11 +192,11 @@ Alternatively, the progress can be tracked via the equivalent generator function
192
192
193
193
* ` pyprind.setup_email(smtp_server, smtp_port, username, password) ` *
194
194
195
- - smtp_server : str
196
- - smtp_port : int
197
- - username : str
195
+ - smtp_server : str
196
+ - smtp_port : int
197
+ - username : str
198
198
your full email username example (pyprind@pyprind.com )
199
- - password : str
199
+ - password : str
200
200
your password
201
201
202
202
If you want to use email notifications you can call function * ` pyprind.setup_email ` * only once and it will create an encrypted file with your email config and will be using it, if you want to change the email config just call * ` pyprind.setup_email ` * with new parameters and it will rewrite the email config file.
0 commit comments