How can I convert a RTF/CRE stroke string to Stroke object?

[user202729]

# Do we have tags?

The question is in the title.

[user202729]

I don't think there's a function in Plover.

Method 1. Use Benoit's new library plover-stroke. See the README for more documentation.

Method 2. Use steno_to_stroke function in testing build utils (plover_build_utils.testing.steno_to_stroke).

[benoit-pierre]

Tags?

[user202729]

I mean, perhaps there can be some way to classify the discussion with some popular topic.

Not sure if GitHub discussion have such a feature.

[benoit-pierre]

Categories (top-right)?

[user202729]

I was kind-of thinking about stack overflow's tag thing. This is okay, but not as specific.

[morinted]

community/community#19

[benoit-pierre]

Anyway, I think plover_stroke is more robust than plover_build_utils.testing.steno_to_stroke. It also does not rely on plover.system.

[user202729]

Side note:

To use plover_stroke in Plover plugins: (the set & is required in some cases, see #1449)

from plover import system
from plover_stroke import BaseStroke
class Stroke_(BaseStroke): pass
Stroke_.setup(system.KEYS, {*system.IMPLICIT_HYPHEN_KEYS} & {*system.KEYS}, system.NUMBER_KEY, system.NUMBERS)

stroke_=Stroke_("STK")

Or in an independent script: (without the overhead mentioned in #1292)

from plover.system import english_stenotype as e
from plover_stroke import BaseStroke
class Stroke_(BaseStroke): pass
Stroke_.setup(e. ... )

Sometimes you would need to convert Stroke_ object to Stroke object too:

from plover.steno import Stroke
print(Stroke(stroke_.keys()))

Note that if you use this in a Python dictionary, the Stroke_ constructor will raise ValueError if the RTF/CRE string is invalid (which can happen if you enter an invalid stroke into the "Strokes:" text box in the "Add translation" dialog). Handle it correspondingly.