Project

Profile

Help

How to connect?
Download (2.83 KB) Statistics View on GitHub Reload from mirrored respository
| Branch: | Tag: | Revision:

github / src / screenreader.py @ 05b173a7

1
# Copyright (c) 2016, LE GOFF Vincent
2
# All rights reserved.
3

    
4
# Redistribution and use in source and binary forms, with or without
5
# modification, are permitted provided that the following conditions are met:
6

    
7
# * Redistributions of source code must retain the above copyright notice, this
8
#   list of conditions and the following disclaimer.
9

    
10
# * Redistributions in binary form must reproduce the above copyright notice,
11
#   this list of conditions and the following disclaimer in the documentation
12
#   and/or other materials provided with the distribution.
13

    
14
# * Neither the name of ytranslate nor the names of its
15
#   contributors may be used to endorse or promote products derived from
16
#   this software without specific prior written permission.
17

    
18
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28

    
29
"""This file contains the ScreenReader class, to interact with the TTS.
30

31
This class is supposed to be platform-independent and use what is
32
available on that system.  To use it, one should call its 'talk' method,
33
which allows to speak to the screen reader.
34

35
"""
36

    
37
try:
38
    from UniversalSpeech import say
39
    from UniversalSpeech import braille as display_braille
40
except (ImportError, OSError):
41
    say = None
42
    display_braille = None
43

    
44
class ScreenReader:
45

    
46
    """Wrapper class to send messages to the screen reader.
47

48
    No need to instantiate this class.  Just use its  'talk' method.
49

50
    >>> from screenreader import ScreenReader
51
    >>> ScreenReader.talk("So it works")
52
    >>> ScreenReader.talk("But don't display that.", braille=False)
53

54
    """
55

    
56
    @staticmethod
57
    def talk(message, speech=True, braille=True, interrupt=True):
58
        """Send the message to the screen reader to be spoken or displayed.
59

60
        Parameters:
61
            message: The message to be sent (str or unicode)
62
            speech (default True): should htis message be spoken?
63
            braille (default True): should the message be displayed?
64

65
        """
66
        message = message.strip()
67
        if not message:
68
            return
69

    
70
        if say and speech:
71
            say(message, interrupt=interrupt)
72

    
73
        if braille and display_braille:
74
            display_braille(message)
(15-15/20)