plover-python-dictionary-lib 0.4.2

Library for writing Python dictionary for Plover, and generating JSON dictionary file from Python dictionary.

plover-python-dictionary-lib

Library for writing Python dictionary for Plover, and generating JSON dictionary file from Python dictionary.

Installation

This package is available on PyPI. To install it, run the command

pip install plover-python-dictionary-lib

This is required to use/run the Python dictionaries that use this library.

Example & Usage

Imports And Setup

• The example code assumes you have run the code below

from plover.system import english_stenotype as e
from plover_python_dictionary_lib import get_context_from_system
context=get_context_from_system(e)
s=context.SingleDictionary
stroke=context.stroke
translation=context.translation

Dictionary Operations

• The | operator
  • Compute the union of two dictionaries together (basically updating one dictionary with another as like a normal python dictionary)

you = s({"KPWR": "you"})
they = s({"TWH": "they"})
dict1 = you | they
dict1.print_items()
# {"KPWR": "you", "TWH": "they"}

• The * operator
  • Compute the Cartesian product of two dictionaries such that:
    • Adjacent strokes are merged as according to steno order
    • Adjacent translations are merged using the + operator
  • Example:

dict1 = s({
		"KPWR": "you",
		"TWH": "they"
	})
dict2 = s({
		"-R": " are"
	})
dict = dict1 * dict2
dict.print_items()
# {"KPWR-R": "you are", "TWH-R": "they are"}

Named Dictionaries

• Sometimes you want to have custom behavior for your translations
• For example applying mods on some characters

def applyMods(mods, characters):
	for mod in mods:
		characters = f"{mod}({characters})"
	return characters
mods = s({"-R": ["shift"], "": []}).named("mods") 
characters = s({"A": "a"}).named("characters")
dict = (mods * characters).map(applyMods)
dict.print_items()
# {"AR": "shift(a)", "A": "a"}

Extra Notes

• The most common use case would be a Cartesian product of various dictionaries.
• You can read
  • 00_two_letter_fingerspelling_example example dictionary file (GitHub link) for an example (this one is the most well-documented example file, with common patterns and explanation),
  • the rest of the files in the example/ folder,
  • and the documentation (as Python docstrings) in the source code,
• Useful resources: Frequently used dictionary components (feel free to edit the wiki)

Generate JSON

The Python dictionary must be written with this plugin.

Call .print_items() on the main Dictionary object. (see also the example dictionaries above)

Note: because of an incompatibility between Plover and the plover_stroke library, sometimes the JSON dictionary may not work in Plover.

For example: if this code is included at the end of the Python dictionary file named dictionary.py

if __name__=="__main__":
	dictionary.print_items()

(assuming that the main dictionary object is named dictionary) then running python dictionary.py will print the dictionary as JSON to the standard output.