language-profiles.md

Language Profiles

Functions for querying and extending transliteration language profiles.

list_langs

::: disarm.list_langs

Example

from disarm import list_langs

langs = list_langs()
assert langs == ['am', 'ar', 'as', 'ban', 'bax', 'bg', 'bn', 'bo', 'bug', 'ca', 'chr', 'cjm', 'cop', 'cs', 'cy', 'da', 'de', 'dv', 'el', 'es', 'et', 'fa', 'fi', 'fr', 'ga', 'gu', 'he', 'hi', 'hr', 'hu', 'hy', 'is', 'it', 'ja', 'ja-kunrei', 'jv', 'ka', 'khb', 'km', 'kn', 'ko', 'lis', 'lo', 'lt', 'lv', 'ml', 'mn', 'mni', 'mr', 'mt', 'my', 'ne', 'nl', 'no', 'nod', 'nqo', 'or', 'pa', 'pl', 'pt', 'ro', 'ru', 'sa', 'sat', 'si', 'sk', 'sl', 'sq', 'sr', 'su', 'sv', 'syr', 'ta', 'tdd', 'te', 'th', 'tl', 'tr', 'tzm', 'uk', 'vai', 'vi', 'zh']

Returns both built-in and user-registered language codes, sorted alphabetically.

!!! tip Use lang="auto" to auto-detect the language from the dominant non-Latin script in the input, instead of specifying a code manually. See Language Support for details.

---

lang_info

::: disarm.lang_info

Returns a LangMeta dict with name, script, region, and context keys for a language code. The context field is one of "none", "partial", or "full", indicating how much the language benefits from context=True in transliterate(). Raises KeyError if the code is not recognized.

Example

from disarm import lang_info

meta = lang_info("de")
assert meta["name"] == 'German'
assert meta["script"] == 'Latin'
assert meta["region"] == 'European'
assert meta["context"] == 'none'

assert lang_info("cop")["script"] == 'Coptic'

---

script_info

::: disarm.script_info

Returns a ScriptMeta dict with name, default_lang, example, and context_aware keys for a Unicode script. Accepts either a script name string or a Script enum value. Raises KeyError if the script is not recognized.

Example

from disarm import Script, script_info

meta = script_info("Coptic")
assert meta["name"] == 'Coptic'
assert meta["default_lang"] == 'cop'
assert meta["context_aware"] is False

# A Script enum value works too
assert script_info(Script.THAI)["name"] == 'Thai'

---

list_context_langs

::: disarm.list_context_langs

Returns the sorted list of language codes whose lang_info() metadata has a context field other than "none" — i.e. the languages that benefit from context=True in transliterate().

Example

from disarm import list_context_langs

assert list_context_langs() == ['ar', 'fa', 'he']
assert "ar" in list_context_langs()
assert "de" not in list_context_langs()

---

register_lang

::: disarm.register_lang

Example

from disarm import register_lang, transliterate

register_lang("eo", {
    "ĉ": "cx", "ĝ": "gx", "ĥ": "hx",
    "ĵ": "jx", "ŝ": "sx", "ŭ": "ux",
})

assert transliterate("ĉapelo", lang="eo") == 'cxapelo'

# Verify registration
from disarm import list_langs
assert "eo" in list_langs()

!!! warning This is a global, process-wide operation. Registered profiles persist for the lifetime of the Python process and are visible to all threads.

---

register_replacements

::: disarm.register_replacements

Example

from disarm import register_replacements, transliterate

register_replacements({
    "©": "(c)",
    "®": "(R)",
    "™": "(TM)",
})

assert transliterate("Hello™ World©") == 'Hello(TM) World(c)'

Replacements are applied as a pre-processing step before the character-by-character transliteration lookup. They are global and persist for the process lifetime.

---

remove_replacement

::: disarm.remove_replacement

Example

from disarm import register_replacements, remove_replacement, transliterate

register_replacements({"©": "(c)", "®": "(R)"})
assert transliterate("©®") == '(c)(R)'

assert remove_replacement("©") == True
assert remove_replacement("©") == False
assert transliterate("©®") == '(c)(R)'

---

clear_replacements

::: disarm.clear_replacements

Example

from disarm import register_replacements, clear_replacements, transliterate

register_replacements({"©": "(c)", "®": "(R)"})
assert transliterate("©®") == '(c)(R)'

clear_replacements()
assert transliterate("©®") == '(c)(R)'

!!! note clear_replacements() removes all user-registered replacements. Built-in transliteration tables are not affected.