Skip to content

new (preliminary) converter for Avar #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxmerben wants to merge 6 commits into
base: main
Choose a base branch
from
Open

new (preliminary) converter for Avar #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7a77a94
new (preliminary) converter for Avar
maxmerben Feb 3, 2026
d62a857
small fix concerning palochkas
maxmerben Feb 3, 2026
377549e
small fix regarding the meta orthography
maxmerben Feb 3, 2026
ad28d87
Standard Dargwa language added + small fixes in Avar
maxmerben Feb 3, 2026
4b02fcd
Lezgian added + small fixes for other languages
maxmerben Feb 3, 2026
0e96f58
Update README.md
maxmerben Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
This is for transliterators
# Transliterators for Caucasian languages

### Languages available
- East Caucasian
- Avar [ava]
- Standard Dargwa [dar]
- Lezgian [lez]

### To-do
- East Caucasian
- Botlikh
- Godoberi
- Chamalal
- Chechen
- Hinuq
- Ingush
- Khwarshi
- Lak
- Tsakhur
175 changes: 175 additions & 0 deletions converter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
import re, os, csv

current_folder = os.path.dirname(os.path.abspath(__file__))
ortho_table_path = os.path.join(current_folder, os.path.join("static", "ortho_table.csv"))
ortho_txt_default_name = "ortho"

all_letters = "A-Za-zÀ-ÖØ-öø-ӿԀ-ԯⷩ"
punct = "\!-/:-@\[-`{-~ -¿\‐-⁞"

#cyr_check = "[ПпБДдЛлЖжШшЩщФфЦцЧчИиЙйЬьЪъЫыЭэЮюЯя]"
#lat_check = "[SsVvFfIiGgZzQqNR]"

_cyr = ["cyr", "cyrillic", "кир", "кириллица"]
#_lat = ["lat", "latin", "лат", "латиница"]
other_targets = ["ipa", "cauc"]

possible_targets = _cyr + other_targets
recommended_targets = [_cyr[0]] + other_targets


def raise_error_wrong_argument(token, recommended):
raise ValueError(f"Invalid '{token}' argument given! Should be one of these: {recommended}")


class ConverterOutput:
"""The output of the Converter.convert() function."""

def __init__(self, text, lang, orig, target):
"""
Parameters
----------
"""

self.text = text
self.lang = lang
self.orig = orig
self.target = target


def __repr__(self):
return self.text


def full(self):
"""Prints all the settings of the converted text."""
return f"ConverterOutput(\n\ttext='{self.text}',\n\tlang={self.lang}, orig={self.orig}, target={self.target}\n)"


class Converter:
"""The main class to convert from alphabet X to alphabet Y.

Make a `Converter` object. Optionally, set the default target alphabet as an argument:
> c = Converter(target="cyr")

Then use the method `convert` to change the alphabet of a text:
> converted_text = c.convert(original_text)
"""

def __init__(self, lang, orig=None, target=None):
"""
Parameters
----------
"""

with open(ortho_table_path, 'r', encoding='utf-8-sig') as f:
reader = list(csv.reader(f, delimiter=","))
self._ortho_table = {}
headers = []
for i in range(len(reader)):
row = reader[i]
if i == 0:
headers = row
else:
self._ortho_table[row[0]] = {
headers[i]: row[i] for i in range(1, len(row))}

possible_langs = sorted(set([x.split("_")[0] for x in list(list(self._ortho_table.values())[0].keys())]))
if lang in possible_langs:
self.lang = lang
else:
raise_error_wrong_argument("lang", possible_langs)

if orig in possible_targets:
self.orig = orig
elif orig is None:
self.orig = None
else:
raise_error_wrong_argument("orig", recommended_targets)

if target in _cyr:
self._lang_target = f"{self.lang}_{_cyr[0]}"
elif target in other_targets:
self._lang_target = f"{self.lang}_{target}"
elif target is None:
self._lang_target = None
else:
raise_error_wrong_argument("target", recommended_targets)

self.target = target

with open(
os.path.join(current_folder, os.path.join("static", f"ortho_{lang}.txt")),
"r", encoding="utf-8-sig") as file:
ortho_txt_file = file.readlines()

self._ortho_to_meta = {}
for line in ortho_txt_file:
if not line.startswith("#"):
bad, good = line.split("\t")
good = good.strip("\r\n")
self._ortho_to_meta[bad] = good


def __repr__(self):
return f"Converter(lang={self.lang}, orig={self.orig}, target={self.target})"


def convert(self, text, orig=None, target=None):
"""
Converts a text.

Parameters
----------
"""
if text is None:
return None
if orig is None:
if self.orig is None:
raise ValueError("No 'orig' value given!")
else:
orig = self.orig
elif orig not in possible_targets:
raise_error_wrong_argument("orig", recommended_targets)

lang_target = None
if target is None:
if self._lang_target is None:
raise ValueError("No 'target' value given!")
else:
lang_target = self._lang_target
target = self.target
elif target in possible_targets:
lang_target = f"{self.lang}_{target}"
else:
raise_error_wrong_argument("target", recommended_targets)

######################

# TO-DO: Fix palochkas which are incorrectly written as I if Cyrillic
#
#
#

# Fix palochkas which are incorrectly capital but within a word
text = re.sub(f"(?<=[{all_letters}])Ӏ", "ӏ", text)

# Fix palochkas which are written as '1' or '|'
text = re.sub(f"(?<=[{all_letters}])[|1]|[|1](?=[{all_letters}])", "ӏ", text)

# Split into tokens
tokens = re.findall(f"[{all_letters}]+|[{punct}]+|[0-9]+|[^{all_letters}{punct}0-9]+", text)

# Convert to the meta-orthography
for i in range(len(tokens)):
if re.fullmatch(f"[{all_letters}]+", tokens[i]):
for bad, good in self._ortho_to_meta.items():
tokens[i] = re.sub(bad, good, tokens[i])
text = "".join(tokens)

# Convert to the target orthography
for letter in self._ortho_table:
text = re.sub(letter, self._ortho_table[letter][lang_target], text)

return ConverterOutput(text, lang=self.lang, orig=orig, target=target)

Loading