formatron.formats.utils Namespace Reference

Functions
str	escape_identifier (str s)
	For each character in the string, if it is a valid kbnf identifier character, add it to the result.
str	from_str_to_kbnf_str (str s)
	Convert a string to a kbnf string.

Variables
str	VALID_IDENTIFIER_CHARACTERS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_"

Function Documentation

escape_identifier()

str formatron.formats.utils.escape_identifier

(

str

s

)

For each character in the string, if it is a valid kbnf identifier character, add it to the result.

Otherwise, add its Unicode code point to the result.

Parameters

s	The string to escape.

Returns

The escaped string.

Examples

>>> escape_identifier("hello")
"hello"
>>> escape_identifier("hello_world")
"hello_world"
>>> escape_identifier("hello world")
"hellou20world"

Definition at line 23 of file utils.py.

from_str_to_kbnf_str()

str formatron.formats.utils.from_str_to_kbnf_str

(

str

s

)

Convert a string to a kbnf string.

Parameters

s	The string to convert.

Returns

The kbnf string.

Definition at line 41 of file utils.py.

Variable Documentation

VALID_IDENTIFIER_CHARACTERS

str formatron.formats.utils.VALID_IDENTIFIER_CHARACTERS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_"

Definition at line 1 of file utils.py.