Debian Codegraph @

pymeasure/console.py

raw
1 #
2 # This file is part of the PyMeasure package.
3 #
4 # Copyright (c) 2013-2024 PyMeasure Developers
5 #
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 # THE SOFTWARE.
23 #
24
25 import logging
26
27 import numpy as np
28
29 log = logging.getLogger(__name__)
30 log.addHandler(logging.NullHandler())
31
32 log.warning('not implemented yet')
33
34
35 class ProgressBar:
36 """ ProgressBar keeps track of the progress, predicts the
37 estimated time of arrival (ETA), and formats the bar for
38 display in the console
39 """
40
41 def __init__(self):
42 self.data = np.empty()
43 self.progress_percentage = []
44 self.progress_times = []
45
46 def advance(self, progress):
47 """ Appends the progress state and the current
48 time to the data, so that a more accurate prediction
49 for the ETA can be made
50 """
51 pass
52
53 def __str__(self):
54 """ Returns a string representation of the progress bar
55 """
56 pass
57
58
59 def display(log, port, level=logging.INFO):
60 """ Displays the log to the console with a progress bar
61 that always remains at the bottom of the screen and refreshes itself
62 """
63 pass