validate_initial
- pyrcs.utils.validate_initial(x, as_is=False)
Get a valid initial letter as an input.
- Parameters
x (str) – any string variable (which is supposed to be an initial letter)
as_is (bool) – whether to return the validated letter as is the input
- Returns
validated initial letter
- Return type
str
Examples:
>>> from pyrcs.utils import validate_initial >>> validate_initial('x') 'X' >>> validate_initial('x', as_is=True) 'x' >>> validate_initial('xyz') AssertionError: `x` must be a single letter.