Set methods to static objects

Improve exception handling
Remove exit calls
Fix docstrings
Adhere to pep8 standards
Remove custom six.py

Author: dormant-user

pyproject.toml

@@ -5,7 +5,8 @@ dependencies = [
     "comtypes; platform_system == 'Windows'",
     "pypiwin32; platform_system == 'Windows'",
     "pywin32; platform_system == 'Windows'",
-    "pyobjc>=2.4; platform_system == 'Darwin'"
+    "pyobjc>=2.4; platform_system == 'Darwin'",
+    "six"
 ]
 description = "Text to Speech (TTS) library for Python 3. Works without internet connection or delay. Supports multiple TTS engines, including Sapi5, nsss, and espeak."
 readme = "README.md"

pyttsx3/__init__.py

@@ -5,7 +5,8 @@
 _activeEngines = weakref.WeakValueDictionary()
 
 
-def init(driverName=None, debug=False):
+# noinspection PyPep8Naming
+def init(driverName: str = None, debug: bool = False) -> Engine:
     """
     Constructs a new TTS engine instance or reuses the existing instance for
     the driver name.
@@ -21,12 +22,11 @@ def init(driverName=None, debug=False):
     try:
         eng = _activeEngines[driverName]
     except KeyError:
-        eng = Engine(driverName, debug)
-        _activeEngines[driverName] = eng
+        try:
+            eng = Engine(driverName=driverName, debug=debug)
+        except ModuleNotFoundError:
+            raise ValueError("\n\nDriver '%s' is unavailable" % driverName)
+        except Exception:
+            raise RuntimeError("\n\nUnable to load driver '%s'" % driverName)
+    _activeEngines[driverName] = eng
     return eng
-
-
-def speak(text):
-    engine = init()
-    engine.say(text)
-    engine.runAndWait()

pyttsx3/driver.py

@@ -4,6 +4,7 @@
 import weakref
 
 
+# noinspection PyPep8Naming
 class DriverProxy(object):
     """
     Proxy to a driver implementation.
@@ -25,7 +26,7 @@ class DriverProxy(object):
     @type _iterator: iterator
     """
 
-    def __init__(self, engine, driverName, debug):
+    def __init__(self, engine, driverName: str, debug: bool):
         """
         Constructor.
 
@@ -54,7 +55,7 @@ def __init__(self, engine, driverName, debug):
         self._engine = engine
         self._queue = []
         self._busy = True
-        self._name = None
+        self._name = ""
         self._iterator = None
         self._debug = debug
 
@@ -89,10 +90,11 @@ def _pump(self):
             try:
                 cmd[0](*cmd[1])
             except Exception as e:
-                self.notify('error', exception=e)
+                self.notify('error', exception=e.__dict__)
                 if self._debug:
                     traceback.print_exc()
 
+    # noinspection PyProtectedMember,PyTypeChecker
     def notify(self, topic, **kwargs):
         """
         Sends a notification to the engine from the driver.
@@ -156,6 +158,8 @@ def save_to_file(self, text, filename, name):
 
         @param text: Text to speak
         @type text: unicode
+        @param filename: Name of the file
+        @type filename: str
         @param name: Name to associate with the utterance
         @type name: str
         """

pyttsx3/drivers/__init__.py

@@ -1,9 +1,10 @@
 """
 Utility functions to help with Python 2/3 compatibility
 """
-from .. import six
+import six
 
 
+# noinspection PyPep8Naming
 def toUtf8(value):
     """
     Takes in a value and converts it to a text (unicode) type.  Then decodes that
@@ -15,6 +16,7 @@ def toUtf8(value):
     return six.text_type(value).encode('utf-8')
 
 
+# noinspection PyPep8Naming
 def fromUtf8(value):
     """
     Takes in a byte array encoded as utf-8 and returns a text (unicode) type.  In

pyttsx3/drivers/_espeak.py

@@ -82,10 +82,7 @@ def load_windows_epng3():
     load_linux_ep() or load_linux_epng() or load_linux_epng2() or load_windows_epng1() or load_windows_epng2() or load_windows_epng3()
 except Exception as exp:
     print("Exception: " + str(exp) + "\n")
-    print("This means you probably do not have eSpeak or eSpeak-ng installed!")
-    import sys
-
-    sys.exit()
+    raise RuntimeError("This means you probably do not have eSpeak or eSpeak-ng installed!")
 
 # constants and such from speak_lib.h
 

pyttsx3/drivers/dummy.py

@@ -3,6 +3,7 @@
 from ..voice import Voice
 
 
+# noinspection PyPep8Naming
 def buildDriver(proxy):
     """
     Builds a new instance of a driver and returns it for use by the driver
@@ -14,6 +15,7 @@ def buildDriver(proxy):
     return DummyDriver(proxy)
 
 
+# noinspection PyPep8Naming,PyBroadException
 class DummyDriver(object):
     """
     Dummy speech engine implementation. Documents the interface, notifications,
@@ -53,7 +55,7 @@ def __init__(self, proxy):
     def destroy(self):
         """
         Optional method that will be called when the driver proxy is being
-        destroyed. Can cleanup any resources to make sure the engine terminates
+        destroyed. Can clean up any resources to make sure the engine terminates
         properly.
         """
         pass
@@ -157,7 +159,7 @@ def getProperty(self, name):
     def setProperty(self, name, value):
         """
         Sets one of the supported property values of the speech engine listed
-        above. If a value is invalid, attempts to clip it / coerce so it is
+        above. If a value is invalid, attempts to clip it / coerce, so it is
         valid before giving up and firing an exception.
 
         @param name: Property name

pyttsx3/drivers/espeak.py

@@ -8,10 +8,12 @@
 from ..voice import Voice
 
 
+# noinspection PyPep8Naming
 def buildDriver(proxy):
     return EspeakDriver(proxy)
 
 
+# noinspection PyPep8Naming
 class EspeakDriver(object):
     _moduleInitialized = False
     _defaultVoice = ''
@@ -44,26 +46,25 @@ def numerise(self, data):
     def decode_numeric(self, data):
         return self._numerise_buffer[int(data) - 1]
 
-    def destroy(self):
+    @staticmethod
+    def destroy():
         _espeak.SetSynthCallback(None)
 
     def say(self, text):
         self._proxy.setBusy(True)
         self._proxy.notify('started-utterance')
-        _espeak.Synth(toUtf8(text), flags=_espeak.ENDPAUSE |
-                                          _espeak.CHARS_UTF8)
+        _espeak.Synth(toUtf8(text), flags=_espeak.ENDPAUSE | _espeak.CHARS_UTF8)
 
     def stop(self):
         if _espeak.IsPlaying():
             self._stopping = True
 
-    def getProperty(self, name):
+    @staticmethod
+    def getProperty(name: str):
         if name == 'voices':
             voices = []
             for v in _espeak.ListVoices(None):
-                kwargs = {}
-                kwargs['id'] = fromUtf8(v.name)
-                kwargs['name'] = fromUtf8(v.name)
+                kwargs = {'id': fromUtf8(v.name), 'name': fromUtf8(v.name)}
                 if v.languages:
                     kwargs['languages'] = [v.languages]
                 genders = [None, 'male', 'female']
@@ -83,7 +84,8 @@ def getProperty(self, name):
         else:
             raise KeyError('unknown property %s' % name)
 
-    def setProperty(self, name, value):
+    @staticmethod
+    def setProperty(name: str, value):
         if name == 'voice':
             if value is None:
                 return
@@ -133,8 +135,7 @@ def startLoop(self):
 
     def save_to_file(self, text, filename):
         code = self.numerise(filename)
-        _espeak.Synth(toUtf8(text), flags=_espeak.ENDPAUSE |
-                                          _espeak.CHARS_UTF8, user_data=code)
+        _espeak.Synth(toUtf8(text), flags=_espeak.ENDPAUSE | _espeak.CHARS_UTF8, user_data=code)
 
     def endLoop(self):
         self._looping = False

pyttsx3/drivers/nsss.py

@@ -1,15 +1,24 @@
+# noinspection PyUnresolvedReferences
 from AppKit import NSSpeechSynthesizer
 from Foundation import *
 from PyObjCTools import AppHelper
 
 from ..voice import Voice
 
 
+# noinspection PyPep8Naming
 def buildDriver(proxy):
     return NSSpeechDriver.alloc().initWithProxy(proxy)
 
 
+# noinspection PyUnresolvedReferences,PyPep8Naming,PyUnusedLocal
 class NSSpeechDriver(NSObject):
+
+    def __init__(self):
+        self._proxy = None
+        self._tts = None
+        self._completed = False
+
     @objc.python_method
     def initWithProxy(self, proxy):
         try:
@@ -37,7 +46,8 @@ def startLoop(self):
             0.0, self, 'onPumpFirst:', None, False)
         AppHelper.runConsoleEventLoop()
 
-    def endLoop(self):
+    @staticmethod
+    def endLoop():
         AppHelper.stopEventLoop()
 
     def iterate(self):

pyttsx3/drivers/sapi5.py

@@ -1,3 +1,4 @@
+# noinspection PyUnresolvedReferences
 import comtypes.client  # Importing comtypes.client will make the gen subpackage
 
 try:
@@ -6,8 +7,10 @@
     # Generate the SpeechLib lib and any associated files
     engine = comtypes.client.CreateObject("SAPI.SpVoice")
     stream = comtypes.client.CreateObject("SAPI.SpFileStream")
+    # noinspection PyUnresolvedReferences
     from comtypes.gen import SpeechLib
 
+# noinspection PyUnresolvedReferences
 import pythoncom
 import time
 import math
@@ -27,10 +30,12 @@
          MSMIKE: (154.37, 1.11)}
 
 
+# noinspection PyPep8Naming
 def buildDriver(proxy):
     return SAPI5Driver(proxy)
 
 
+# noinspection PyPep8Naming,PyShadowingNames
 class SAPI5Driver(object):
     def __init__(self, proxy):
         self._tts = comtypes.client.CreateObject('SAPI.SPVoice')
@@ -74,7 +79,8 @@ def save_to_file(self, text, filename):
         stream.close()
         os.chdir(cwd)
 
-    def _toVoice(self, attr):
+    @staticmethod
+    def _toVoice(attr):
         return Voice(attr.Id, attr.GetDescription())
 
     def _tokenFromId(self, id_):
@@ -142,6 +148,7 @@ def iterate(self):
             yield
 
 
+# noinspection PyPep8Naming,PyProtectedMember,PyUnusedLocal,PyShadowingNames
 class SAPI5DriverEventSink(object):
     def __init__(self):
         self._driver = None

pyttsx3/engine.py

@@ -4,12 +4,13 @@
 from . import driver
 
 
+# noinspection PyPep8Naming
 class Engine(object):
     """
     @ivar proxy: Proxy to a driver implementation
     @type proxy: L{DriverProxy}
-    @ivar _connects: Array of subscriptions
-    @type _connects: list
+    @ivar _connects: Dictionary of list of subscriptions
+    @type _connects: dict
     @ivar _inLoop: Running an event loop or not
     @type _inLoop: bool
     @ivar _driverLoop: Using a driver event loop or not
@@ -18,7 +19,7 @@ class Engine(object):
     @type _debug: bool
     """
 
-    def __init__(self, driverName=None, debug=False):
+    def __init__(self, driverName: str = None, debug: bool = False):
         """
         Constructs a new TTS engine instance.
 
@@ -35,6 +36,7 @@ def __init__(self, driverName=None, debug=False):
         self._driverLoop = True
         self._debug = debug
 
+    # noinspection PyBroadException
     def _notify(self, topic, **kwargs):
         """
         Invokes callbacks for an event topic.
@@ -143,8 +145,8 @@ def getProperty(self, name):
 
         @param name: Name of the property to fetch
         @type name: str
-        @return: Value associated with the property
-        @rtype: object
+        @return: List of values associated with the property
+        @rtype: list
         @raise KeyError: When the property name is unknown
         """
         return self.proxy.getProperty(name)
@@ -163,7 +165,7 @@ def setProperty(self, name, value):
 
         @param name: Name of the property to fetch
         @type name: str
-        @param: Value to set for the property
+        @param value: Value to set for the property
         @rtype: object
         @raise KeyError: When the property name is unknown
         """