Dragonfly

--------------------

Fixed
~~~~~
* Add temporary mitigation for Windows keyboard action processing bug
specific to the Kaldi engine (thanks `daanzu`_).

--------------------

Changed
~~~~~~~
* Add get_current_engine() function that doesn't initialize an engine.
* Add is_primary and name properties to all Monitor classes.
* Change SAPI5 engine backend to use the recognizer language selected in the
options window instead of "en".
* Reword confusing Natlink warning message shown when Dragon isn't running.
* Update and fix various parts of the documentation.

Fixed
~~~~~
* Add automatic fix for the NatlinkEngine class that allows threads to work
properly after the first grammar is loaded.
* Change Dragonfly monitor lists to always have the primary monitor with
coordinates (0, 0) first on the list.
* Fix Mouse action bug with negative absolute screen coordinates that made
monitors tricky to access sometimes.
* Fix bug where X11Window.executable may return None in certain
circumstances.
* Support AppContext edge cases where window executables or titles aren't
valid (thanks `shervinemami`_).

--------------------

Changed
~~~~~~~
* Add __str__ method to essential action classes for visualization (thanks
`dmakarov`_).
* Change the Dictation element's value to be a list of recognized words
instead of a DictationContainer object if the 'format' constructor
argument is False. Previously, the 'format' argument did nothing.
* Make various improvements to Dragonfly's documentation.
* Make various improvements to the Kaldi engine's audio code (thanks
`daanzu`_).

Fixed
~~~~~
* Add code to verify that natlink is on the Python path before initializing
the engine (thanks `LexiconCode`_).
* Fix Python 2.7 console output encoding errors in on_recognition()
callbacks in CLI and module loaders.
* Fix a minor bug in DictListRef's constructor.
* Fix bugs where X11 Keyboard and Window class sub-processes can exit early.
* Fix encoding bug with the string representation of BoundAction.
* Fix some Python 3.x bugs with the Natlink engine and its tests (thanks
`mrob95`_).
* Make DarwinWindow get_window_module/pid methods error safe (thanks
`dmakarov`_).

--------------------

Fixed
~~~~~
* Add set_exclusive() alias methods to Grammar & EngineBase classes to make
some older grammars work again.
* Fix a few issues related to the Impossible and Empty elements
(thanks `caspark`_ and `daanzu`_).
* Fix Win32 modifier bug where the control key could be released if held
down when Window.set_foreground() is called.
* Make all engine mimic() methods fail properly when given empty input.

--------------------

Added
~~~~~
* Add optional recursive mode to CommandModuleDirectory class.
* Add new load and load-directory CLI commands as alternatives to module
loader scripts.
* Add new on_end() and on_post_recognition() recognition observers
with optional parameters (thanks `daanzu`_).
* Add Window.set_focus() method for focusing windows without raising them
(only supported on X11).
* Add 'focus_only' argument to BringApp and FocusWindow actions to support
focusing windows without raising them (only supported on X11).

Changed
~~~~~~~
* Add context manager to ListBase class for optimized list updates.
* Add missing CommandModule properties and methods to CommandModuleDirectory
class.
* Change ActionBase class to catch all exceptions raised during execution,
not just ActionErrors (thanks `daanzu`_).
* Change ActionSeries class to stop execution if errors occur. The
ActionSeries.stop_on_failures attribute, UnsafeActionSeries class and
the '|' and '\|\=' operators can be used to have the previous behaviour.
* Change Kaldi retain support to allow retaining only specifically chosen
recognitions (thanks `daanzu`_).
* Change on_recognition() recognition observer to allow optional rule and
node parameters on functions (thanks `daanzu`_).
* Change setup.py test command to support running the test suites with
different pytest options (thanks `daanzu`_).
* Change the StartApp action to use the macOS 'open' program if applicable.
* Clean up and enhance log messages and dependency checks done in the
is_engine_available() and get_engine() functions (thanks `LexiconCode`_).
* Use application IDs instead of application names to differentiate between
different application processes on macOS (thanks `dmakarov`_).

Fixed
~~~~~
* Fix Dragonfly's CLI so glob patterns are expanded where necessary (i.e. if
using cmd.exe on Windows).
* Fix Kaldi version number checking (thanks `daanzu`_).
* Fix Python 2/3 bool incompatibility with dictation containers
(thanks `daanzu`_).
* Fix bug with CommandModuleDirectory 'excludes' constructor parameter.
* Fix bug with the command-line interface where the 'command' argument
wasn't required.
* Fix Function action deprecation warning in Python 3.

--------------------

Added
~~~~~
* Add DarwinWindow class for macOS using 'py-applescript' (thanks to various
Aenea contributors).
* Add Kaldi engine support for defining your own, external engine to use for
dictation elements (thanks `daanzu`_).
* Add Kaldi engine support for weights on individual rule elements
(thanks `daanzu`_).
* Add support for special specifiers in Compound specs
(thanks `daanzu`_).

Changed
~~~~~~~
* Change Kaldi default model directory to 'kaldi_model' (thanks `daanzu`_).
* Change dragonfly's CLI test command to accept zero file arguments.
* Clean up code in grammar, actions and windows sub-packages.
* Improve overall Kaldi engine recognition accuracy (thanks `daanzu`_).
* Make a few minor Windows-related speed optimizations
(thanks `Versatilus`_).

Fixed
~~~~~
* Add missing DNS parser entry for the special "numeral" word.
* Fix a Windows bug where the wrong mouse buttons will be pressed if the
primary/secondary buttons are inverted.
* Fix a bug with dragonfly's CLI 'test' command where grammars weren't
properly unloaded.
* Fix on_recognition() observer callback for the natlink engine.
* Fix various Kaldi engine bugs (thanks `daanzu`_).
* Fix wsr_module_loader_plus.py for newer Python versions.

Removed
~~~~~~~
* Remove basic Kaldi module loader 'kaldi_module_loader.py'.