plover 5.0.0.dev2__py3-none-any.whl → 5.0.0rc1__py3-none-any.whl

plover/__init__.py

@@ -3,8 +3,9 @@
 
 """Plover: Open Source Stenography Software"""
 
-if __name__ == 'plover':
+if __name__ == "plover":
     from plover.i18n import Translator
+
     _ = Translator(__package__)
 else:
     # exec from `setup.py`, package data
@@ -12,10 +13,10 @@ else:
     # want to translate anyway.
     _ = lambda s: s
 
-__version__ = '5.0.0.dev2'
-__copyright__ = '(C) Open Steno Project'
-__url__ = 'http://www.openstenoproject.org/'
-__download_url__ = 'http://www.openstenoproject.org/plover'
+__version__ = "5.0.0rc1"
+__copyright__ = "(C) Open Steno Project"
+__url__ = "http://www.openstenoproject.org/"
+__download_url__ = "http://www.openstenoproject.org/plover"
 __credits__ = _("""\
 Founded by stenographer Mirabai Knight.
 
@@ -30,9 +31,9 @@ Martin Koerner
 
 and many more on GitHub:
 <https://github.com/openstenoproject/plover>""")
-__license__ = 'GNU General Public License v2 or later (GPLv2+)'
+__license__ = "GNU General Public License v2 or later (GPLv2+)"
 # i18n: Short description for Plover, currently not used in the interface.
-__description__ = _('Open Source Stenography Software')
+__description__ = _("Open Source Stenography Software")
 __long_description__ = _("""\
 Plover is a free open source program intended to bring realtime
 stenographic technology not just to stenographers, but also to

plover/__main__.py

@@ -1,5 +1,5 @@
 from plover.scripts.main import main
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

plover/command/set_config.py

@@ -22,11 +22,14 @@ def set_config(engine, cmdline):
 
 
 def _cmdline_to_dict(cmdline):
-    """ Add braces and parse the entire command line as a Python dict literal. """
+    """Add braces and parse the entire command line as a Python dict literal."""
     try:
-        opt_dict = ast.literal_eval('{'+cmdline+'}')
+        opt_dict = ast.literal_eval("{" + cmdline + "}")
         assert isinstance(opt_dict, dict)
         return opt_dict
     except (AssertionError, SyntaxError, ValueError) as e:
-        raise ValueError('Bad command string "%s" for PLOVER:SET_CONFIG.\n' % cmdline
-                         + 'See for reference:\n\n' + set_config.__doc__) from e
+        raise ValueError(
+            'Bad command string "%s" for PLOVER:SET_CONFIG.\n' % cmdline
+            + "See for reference:\n\n"
+            + set_config.__doc__
+        ) from e

plover/config.py

@@ -17,26 +17,25 @@ from plover import log
 
 
 # General configuration sections, options and defaults.
-MACHINE_CONFIG_SECTION = 'Machine Configuration'
+MACHINE_CONFIG_SECTION = "Machine Configuration"
 
-LEGACY_DICTIONARY_CONFIG_SECTION = 'Dictionary Configuration'
+LEGACY_DICTIONARY_CONFIG_SECTION = "Dictionary Configuration"
 
-LOGGING_CONFIG_SECTION = 'Logging Configuration'
+LOGGING_CONFIG_SECTION = "Logging Configuration"
 
-OUTPUT_CONFIG_SECTION = 'Output Configuration'
+OUTPUT_CONFIG_SECTION = "Output Configuration"
 DEFAULT_UNDO_LEVELS = 100
 MINIMUM_UNDO_LEVELS = 1
 DEFAULT_TIME_BETWEEN_KEY_PRESSES = 0
 MINIMUM_TIME_BETWEEN_KEY_PRESSES = 0
 
-DEFAULT_SYSTEM_NAME = 'English Stenotype'
+DEFAULT_SYSTEM_NAME = "English Stenotype"
 
-SYSTEM_CONFIG_SECTION = 'System: %s'
-SYSTEM_KEYMAP_OPTION = 'keymap[%s]'
+SYSTEM_CONFIG_SECTION = "System: %s"
+SYSTEM_KEYMAP_OPTION = "keymap[%s]"
 
 
-class DictionaryConfig(namedtuple('DictionaryConfig', 'path enabled')):
-
+class DictionaryConfig(namedtuple("DictionaryConfig", "path enabled")):
     def __new__(cls, path, enabled=True):
         return super().__new__(cls, expand_path(path), enabled)
 
@@ -48,8 +47,8 @@ class DictionaryConfig(namedtuple('DictionaryConfig', 'path enabled')):
         # Note: do not use _asdict because of
         # https://bugs.python.org/issue24931
         return {
-            'path': self.short_path,
-            'enabled': self.enabled,
+            "path": self.short_path,
+            "enabled": self.enabled,
         }
 
     def replace(self, **kwargs):
@@ -60,17 +59,20 @@ class DictionaryConfig(namedtuple('DictionaryConfig', 'path enabled')):
         return DictionaryConfig(**d)
 
     def __repr__(self):
-        return 'DictionaryConfig(%r, %r)' % (self.short_path, self.enabled)
+        return "DictionaryConfig(%r, %r)" % (self.short_path, self.enabled)
 
 
-ConfigOption = namedtuple('ConfigOption', '''
+ConfigOption = namedtuple(
+    "ConfigOption",
+    """
                           name default
                           getter setter
                           validate full_key
-                          ''')
+                          """,
+)
 
-class InvalidConfigOption(ValueError):
 
+class InvalidConfigOption(ValueError):
     def __init__(self, raw_value, fixed_value, message=None):
         super().__init__(raw_value)
         self.raw_value = raw_value
@@ -83,118 +85,161 @@ class InvalidConfigOption(ValueError):
 
 def raw_option(name, default, section, option, validate):
     option = option or name
+
     def getter(config, key):
         return config._config[section][option]
+
     def setter(config, key, value):
         config._set(section, option, value)
+
     return ConfigOption(name, lambda c, k: default, getter, setter, validate, None)
 
+
 def json_option(name, default, section, option, validate):
     option = option or name
+
     def getter(config, key):
         value = config._config[section][option]
         try:
             return json.loads(value)
         except json.JSONDecodeError as e:
             raise InvalidConfigOption(value, default) from e
+
     def setter(config, key, value):
         if isinstance(value, set):
             # JSON does not support sets.
             value = list(sorted(value))
-        config._set(section, option, json.dumps(value, sort_keys=True, ensure_ascii=False))
+        config._set(
+            section, option, json.dumps(value, sort_keys=True, ensure_ascii=False)
+        )
+
     return ConfigOption(name, default, getter, setter, validate, None)
 
+
 def int_option(name, default, minimum, maximum, section, option=None):
     option = option or name
+
     def getter(config, key):
         return config._config[section][option]
+
     def setter(config, key, value):
         config._set(section, option, str(value))
+
     def validate(config, key, value):
         try:
             value = int(value)
         except ValueError as e:
             raise InvalidConfigOption(value, default) from e
-        if (minimum is not None and value < minimum) or \
-           (maximum is not None and value > maximum):
-            message = '%s not in [%s, %s]' % (value, minimum or '-∞', maximum or '∞')
+        if (minimum is not None and value < minimum) or (
+            maximum is not None and value > maximum
+        ):
+            message = "%s not in [%s, %s]" % (value, minimum or "-∞", maximum or "∞")
             raise InvalidConfigOption(value, default, message)
         return value
+
     return ConfigOption(name, lambda c, k: default, getter, setter, validate, None)
 
+
 def boolean_option(name, default, section, option=None):
     option = option or name
+
     def getter(config, key):
         return config._config[section][option]
+
     def setter(config, key, value):
         config._set(section, option, str(value))
+
     def validate(config, key, value):
         try:
             return boolean(value)
         except ValueError as e:
             raise InvalidConfigOption(value, default) from e
+
     return ConfigOption(name, lambda c, k: default, getter, setter, validate, None)
 
+
 def choice_option(name, choices, section, option=None):
     default = choices[0]
+
     def validate(config, key, value):
         if value not in choices:
             raise InvalidConfigOption(value, default)
         return value
+
     return raw_option(name, default, section, option, validate)
 
+
 def plugin_option(name, plugin_type, default, section, option=None):
     def validate(config, key, value):
         try:
             return registry.get_plugin(plugin_type, value).name
         except KeyError as e:
             raise InvalidConfigOption(value, default) from e
+
     return raw_option(name, default, section, option, validate)
 
+
 def opacity_option(name, section, option=None):
     return int_option(name, 100, 0, 100, section, option)
 
+
 def path_option(name, default, section, option=None):
     option = option or name
+
     def getter(config, key):
         return expand_path(config._config[section][option])
+
     def setter(config, key, value):
         config._set(section, option, shorten_path(value))
+
     def validate(config, key, value):
         if not isinstance(value, str):
             raise InvalidConfigOption(value, default)
         return value
+
     return ConfigOption(name, lambda c, k: default, getter, setter, validate, None)
 
+
 def enabled_extensions_option():
     def validate(config, key, value):
         if not isinstance(value, (list, set, tuple)):
             raise InvalidConfigOption(value, ())
         return set(value)
-    return json_option('enabled_extensions', lambda c, k: set(), 'Plugins', 'enabled_extensions', validate)
+
+    return json_option(
+        "enabled_extensions",
+        lambda c, k: set(),
+        "Plugins",
+        "enabled_extensions",
+        validate,
+    )
+
 
 def machine_specific_options():
     def full_key(config, key):
         if isinstance(key, tuple):
             assert len(key) == 2
             return key
-        return (key, config['machine_type'])
+        return (key, config["machine_type"])
+
     def default(config, key):
-        machine_class = registry.get_plugin('machine', key[1]).obj
+        machine_class = registry.get_plugin("machine", key[1]).obj
         return {
-            name: params[0]
-            for name, params in machine_class.get_option_info().items()
+            name: params[0] for name, params in machine_class.get_option_info().items()
         }
+
     def getter(config, key):
         return config._config[key[1]]
+
     def setter(config, key, value):
         config._config[key[1]] = value
+
     def validate(config, key, raw_options):
         if not isinstance(raw_options, (dict, configparser.SectionProxy)):
             raise InvalidConfigOption(raw_options, default(config, key))
         machine_options = OrderedDict()
         invalid_options = OrderedDict()
-        machine_class = registry.get_plugin('machine', key[1]).obj
+        machine_class = registry.get_plugin("machine", key[1]).obj
         for name, params in sorted(machine_class.get_option_info().items()):
             fallback, convert = params
             try:
@@ -211,78 +256,102 @@ def machine_specific_options():
         if invalid_options:
             raise InvalidConfigOption(invalid_options, machine_options)
         return machine_options
-    return ConfigOption('machine_specific_options', default, getter, setter, validate, full_key)
+
+    return ConfigOption(
+        "machine_specific_options", default, getter, setter, validate, full_key
+    )
+
 
 def system_keymap_option():
     def full_key(config, key):
         if isinstance(key, tuple):
             assert len(key) == 3
             return key
-        return (key, config['system_name'], config['machine_type'])
+        return (key, config["system_name"], config["machine_type"])
+
     def location(config, key):
         return SYSTEM_CONFIG_SECTION % key[1], SYSTEM_KEYMAP_OPTION % key[2]
+
     def build_keymap(config, key, mappings=None):
-        system = registry.get_plugin('system', key[1]).obj
-        machine_class = registry.get_plugin('machine', key[2]).obj
-        keymap = Keymap(machine_class.get_keys(), system.KEYS + machine_class.get_actions())
+        system = registry.get_plugin("system", key[1]).obj
+        machine_class = registry.get_plugin("machine", key[2]).obj
+        keymap = Keymap(
+            machine_class.get_keys(), system.KEYS + machine_class.get_actions()
+        )
         if mappings is None:
             mappings = system.KEYMAPS.get(key[2])
         if mappings is None:
             if machine_class.KEYMAP_MACHINE_TYPE is not None:
                 # Try fallback.
-                return build_keymap(config, (key[0], key[1], machine_class.KEYMAP_MACHINE_TYPE))
+                return build_keymap(
+                    config, (key[0], key[1], machine_class.KEYMAP_MACHINE_TYPE)
+                )
             # No fallback...
             mappings = {}
         keymap.set_mappings(mappings)
         return keymap
+
     def default(config, key):
         return build_keymap(config, key)
+
     def getter(config, key):
         section, option = location(config, key)
         return config._config[section][option]
+
     def setter(config, key, keymap):
         section, option = location(config, key)
         config._set(section, option, str(keymap))
+
     def validate(config, key, value):
         try:
             return build_keymap(config, key, value)
         except (TypeError, ValueError) as e:
             raise InvalidConfigOption(value, default(config, key)) from e
-    return ConfigOption('system_keymap', default, getter, setter, validate, full_key)
+
+    return ConfigOption("system_keymap", default, getter, setter, validate, full_key)
+
 
 def dictionaries_option():
     def full_key(config, key):
         if isinstance(key, tuple):
             assert len(key) == 2
             return key
-        return (key, config['system_name'])
+        return (key, config["system_name"])
+
     def location(config, key):
         return (
             SYSTEM_CONFIG_SECTION % key[1],
-            'dictionaries',
+            "dictionaries",
         )
+
     def default(config, key):
-        system = registry.get_plugin('system', key[1]).obj
+        system = registry.get_plugin("system", key[1]).obj
         return [DictionaryConfig(path) for path in system.DEFAULT_DICTIONARIES]
+
     def legacy_getter(config):
         options = config._config[LEGACY_DICTIONARY_CONFIG_SECTION].items()
         return [
-            {'path': value}
+            {"path": value}
             for name, value in reversed(sorted(options))
-            if re.match(r'dictionary_file\d*$', name) is not None
+            if re.match(r"dictionary_file\d*$", name) is not None
         ]
+
     def getter(config, key):
         section, option = location(config, key)
         value = config._config.get(section, option, fallback=None)
         if value is None:
             return legacy_getter(config)
         return json.loads(value)
+
     def setter(config, key, dictionaries):
         section, option = location(config, key)
-        config._set(section, option, json.dumps([
-            d.to_dict() for d in dictionaries
-        ], sort_keys=True))
+        config._set(
+            section,
+            option,
+            json.dumps([d.to_dict() for d in dictionaries], sort_keys=True),
+        )
         config._config.remove_section(LEGACY_DICTIONARY_CONFIG_SECTION)
+
     def validate(config, key, value):
         dictionaries = []
         for d in value:
@@ -294,11 +363,11 @@ def dictionaries_option():
                 d = DictionaryConfig.from_dict(d)
             dictionaries.append(d)
         return dictionaries
-    return ConfigOption('dictionaries', default, getter, setter, validate, full_key)
 
+    return ConfigOption("dictionaries", default, getter, setter, validate, full_key)
 
-class Config:
 
+class Config:
     def __init__(self, path=None):
         self._config = None
         self._cache = {}
@@ -308,7 +377,7 @@ class Config:
 
     def load(self):
         self.clear()
-        with open(self.path, encoding='utf-8') as fp:
+        with open(self.path, encoding="utf-8") as fp:
             try:
                 self._config.read_file(fp)
             except configparser.Error as e:
@@ -320,7 +389,7 @@ class Config:
 
     def save(self):
         with resource_update(self.path) as temp_path:
-            with open(temp_path, mode='w', encoding='utf-8') as fp:
+            with open(temp_path, mode="w", encoding="utf-8") as fp:
                 self._config.write(fp)
 
     def _set(self, section, option, value):
@@ -331,35 +400,69 @@ class Config:
     # Note: order matters, e.g. machine_type comes before
     # machine_specific_options and system_keymap because
     # the latter depend on the former.
-    _OPTIONS = OrderedDict((opt.name, opt) for opt in [
-        # Output.
-        choice_option('space_placement', ('Before Output', 'After Output'), OUTPUT_CONFIG_SECTION),
-        boolean_option('start_attached', False, OUTPUT_CONFIG_SECTION),
-        boolean_option('start_capitalized', False, OUTPUT_CONFIG_SECTION),
-        int_option('undo_levels', DEFAULT_UNDO_LEVELS, MINIMUM_UNDO_LEVELS, None, OUTPUT_CONFIG_SECTION),
-        int_option('time_between_key_presses', DEFAULT_TIME_BETWEEN_KEY_PRESSES, MINIMUM_TIME_BETWEEN_KEY_PRESSES, None, OUTPUT_CONFIG_SECTION),
-        choice_option("keyboard_layout", ("qwerty", "qwertz", "colemak", "colemak-dh"), OUTPUT_CONFIG_SECTION),
-        # Logging.
-        path_option('log_file_name', expand_path('strokes.log'), LOGGING_CONFIG_SECTION, 'log_file'),
-        boolean_option('enable_stroke_logging', False, LOGGING_CONFIG_SECTION),
-        boolean_option('enable_translation_logging', False, LOGGING_CONFIG_SECTION),
-        # GUI.
-        boolean_option('start_minimized', False, 'Startup', 'Start Minimized'),
-        boolean_option('show_stroke_display', False, 'Stroke Display', 'show'),
-        boolean_option('show_suggestions_display', False, 'Suggestions Display', 'show'),
-        opacity_option('translation_frame_opacity', 'Translation Frame', 'opacity'),
-        boolean_option('classic_dictionaries_display_order', False, 'GUI'),
-        # Plugins.
-        enabled_extensions_option(),
-        # Machine.
-        boolean_option('auto_start', False, MACHINE_CONFIG_SECTION),
-        plugin_option('machine_type', 'machine', 'Keyboard', MACHINE_CONFIG_SECTION),
-        machine_specific_options(),
-        # System.
-        plugin_option('system_name', 'system', DEFAULT_SYSTEM_NAME, 'System', 'name'),
-        system_keymap_option(),
-        dictionaries_option(),
-    ])
+    _OPTIONS = OrderedDict(
+        (opt.name, opt)
+        for opt in [
+            # Output.
+            choice_option(
+                "space_placement",
+                ("Before Output", "After Output"),
+                OUTPUT_CONFIG_SECTION,
+            ),
+            boolean_option("start_attached", False, OUTPUT_CONFIG_SECTION),
+            boolean_option("start_capitalized", False, OUTPUT_CONFIG_SECTION),
+            int_option(
+                "undo_levels",
+                DEFAULT_UNDO_LEVELS,
+                MINIMUM_UNDO_LEVELS,
+                None,
+                OUTPUT_CONFIG_SECTION,
+            ),
+            int_option(
+                "time_between_key_presses",
+                DEFAULT_TIME_BETWEEN_KEY_PRESSES,
+                MINIMUM_TIME_BETWEEN_KEY_PRESSES,
+                None,
+                OUTPUT_CONFIG_SECTION,
+            ),
+            choice_option(
+                "keyboard_layout",
+                ("qwerty", "qwertz", "colemak", "colemak-dh", "dvorak"),
+                OUTPUT_CONFIG_SECTION,
+            ),
+            # Logging.
+            path_option(
+                "log_file_name",
+                expand_path("strokes.log"),
+                LOGGING_CONFIG_SECTION,
+                "log_file",
+            ),
+            boolean_option("enable_stroke_logging", False, LOGGING_CONFIG_SECTION),
+            boolean_option("enable_translation_logging", False, LOGGING_CONFIG_SECTION),
+            # GUI.
+            boolean_option("start_minimized", False, "Startup", "Start Minimized"),
+            boolean_option("show_stroke_display", False, "Stroke Display", "show"),
+            boolean_option(
+                "show_suggestions_display", False, "Suggestions Display", "show"
+            ),
+            opacity_option("translation_frame_opacity", "Translation Frame", "opacity"),
+            boolean_option("classic_dictionaries_display_order", False, "GUI"),
+            # Plugins.
+            enabled_extensions_option(),
+            # Machine.
+            boolean_option("auto_start", False, MACHINE_CONFIG_SECTION),
+            plugin_option(
+                "machine_type", "machine", "Keyboard", MACHINE_CONFIG_SECTION
+            ),
+            machine_specific_options(),
+            # System.
+            plugin_option(
+                "system_name", "system", DEFAULT_SYSTEM_NAME, "System", "name"
+            ),
+            system_keymap_option(),
+            dictionaries_option(),
+        ]
+    )
 
     def _lookup(self, key):
         name = key[0] if isinstance(key, tuple) else key
@@ -377,7 +480,7 @@ class Config:
         except (configparser.NoOptionError, KeyError):
             value = opt.default(self, key)
         except InvalidConfigOption as e:
-            log.error('invalid value for %r option', opt.name, exc_info=True)
+            log.error("invalid value for %r option", opt.name, exc_info=True)
             value = e.fixed_value
         self._cache[key] = value
         return value

plover/dictionary/base.py

@@ -1,7 +1,7 @@
 # Copyright (c) 2013 Hesky Fisher
 # See LICENSE.txt for details.
 
-# TODO: maybe move this code into the StenoDictionary itself. The current saver 
+# TODO: maybe move this code into the StenoDictionary itself. The current saver
 # structure is odd and awkward.
 # TODO: write tests for this file
 
@@ -17,47 +17,59 @@ from plover.registry import registry
 def _get_dictionary_class(filename):
     extension = splitext(filename)[1].lower()[1:]
     try:
-        dict_module = registry.get_plugin('dictionary', extension).obj
+        dict_module = registry.get_plugin("dictionary", extension).obj
     except KeyError:
         raise ValueError(
-            'Unsupported extension: %s. Supported extensions: %s' %
-            (extension, ', '.join(plugin.name for plugin in
-                                  registry.list_plugins('dictionary'))))
+            "Unsupported extension: %s. Supported extensions: %s"
+            % (
+                extension,
+                ", ".join(
+                    plugin.name for plugin in registry.list_plugins("dictionary")
+                ),
+            )
+        )
     return dict_module
 
+
 def _locked(fn):
     lock = threading.Lock()
+
     @functools.wraps(fn)
     def wrapper(*args, **kwargs):
         with lock:
             fn(*args, **kwargs)
+
     return wrapper
 
+
 def _threaded(fn):
     @functools.wraps(fn)
     def wrapper(*args, **kwargs):
         t = threading.Thread(target=fn, args=args, kwargs=kwargs)
         t.start()
+
     return wrapper
 
+
 def create_dictionary(resource, threaded_save=True):
-    '''Create a new dictionary.
+    """Create a new dictionary.
 
     The format is inferred from the extension.
 
     Note: the file is not created! The resulting dictionary save
     method must be called to finalize the creation on disk.
-    '''
+    """
     d = _get_dictionary_class(resource).create(resource)
     if threaded_save:
         d.save = _threaded(_locked(d.save))
     return d
 
+
 def load_dictionary(resource, threaded_save=True):
-    '''Load a dictionary from a file.
+    """Load a dictionary from a file.
 
     The format is inferred from the extension.
-    '''
+    """
     d = _get_dictionary_class(resource).load(resource)
     if not d.readonly and threaded_save:
         d.save = _threaded(_locked(d.save))

plover/dictionary/helpers.py

@@ -4,7 +4,6 @@ from plover.steno import normalize_steno
 
 
 class StenoNormalizer:
-
     def __init__(self, dictionary_path):
         self._dictionary_path = dictionary_path
         self._errors_count = 0
@@ -14,12 +13,15 @@ class StenoNormalizer:
             return normalize_steno(steno)
         except ValueError:
             self._errors_count += 1
-            return tuple(steno.split('/'))
+            return tuple(steno.split("/"))
 
     def __enter__(self):
         return self.normalize
 
     def __exit__(self, exc_type, exc_value, traceback):
         if exc_type is None and self._errors_count:
-            log.warning(_('dictionary `%s` loaded with %u invalid steno errors'),
-                        shorten_path(self._dictionary_path), self._errors_count)
+            log.warning(
+                _("dictionary `%s` loaded with %u invalid steno errors"),
+                shorten_path(self._dictionary_path),
+                self._errors_count,
+            )