Manage a set of tips.
Tips is a set of short help messages that a software tool can display
when it's starting. Some users find them useful...
Tips are stored into a file with name TIPS_FILE. This file format is
with one tip a line.
>>> t = sppasTips()
>>> print(t.get_message())
Create a sppasTips instance.
Load the list of message tips of the software.
def __init__(self):
"""Create a sppasTips instance.
Load the list of message tips of the software.
"""
self._current = 0
self._tips = list()
self.load_tips()
Load message tips from a file.
Update the existing tips of the list (if any).
def load_tips(self, filename=None):
"""Load message tips from a file.
Update the existing tips of the list (if any).
:param filename: (str) Name of the file to get message tips.
"""
if filename is None:
filename = os.path.join(paths.etc, 'tips.txt')
try:
with codecs.open(filename, 'r', sg.__encoding__) as f:
for line in f.readlines():
self.add_message(line)
except Exception as e:
logging.info('Error while reading tips: {:s}'.format(str(e)))
if len(self._tips) == 0:
self._tips = ['Welcome!']
Save tips in a file.
def save_tips(self, filename=None):
"""Save tips in a file.
:param filename: (str) Name of the file to store message tips.
"""
if filename is None:
filename = os.path.join(paths.etc, 'tips.txt')
with codecs.open(filename, 'w', sg.__encoding__) as f:
for message in self._tips:
f.write('{:s}\n'.format(b(message)))
Add a new message tips in the list of tips.
def add_message(self, message):
"""Add a new message tips in the list of tips.
:param message: (str) A help message.
"""
su = sppasUnicode(message)
u_message = su.to_strip()
if len(u_message) > 0:
self._tips.append(u_message)
Return a random tips message.
def get_message(self):
"""Return a random tips message.
:returns: unicode
"""
if len(self._tips) == 1:
self._current = 0
return self._tips[0]
if len(self._tips) == 2:
self._current = (self._current + 1) % 2
return self._tips[self._current]
p_round = 0
new = self._current
while new == self._current and p_round < 3:
new = random.randint(0, len(self._tips) - 1)
p_round += 1
self._current = new
return self._tips[self._current]
Return the number of tips.
def __len__(self):
"""Return the number of tips."""
return len(self._tips)