├── data ├── __init__.py ├── compile.sh ├── regex └── hfst.att ├── tests ├── __init__.py └── test_basic_output.py ├── requirements.txt ├── franco_arabic_transliterator ├── __init__.py └── franco_arabic_transliterator.py ├── MANIFEST.in ├── .github └── workflows │ ├── greetings.yml │ └── pythonpackage.yml ├── setup.py ├── README.md ├── .gitignore └── LICENSE /data/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | hfst==3.16.0.1 2 | -------------------------------------------------------------------------------- /data/compile.sh: -------------------------------------------------------------------------------- 1 | hfst-regexp2fst -j -i regex | hfst-fst2txt -o hfst.att 2 | -------------------------------------------------------------------------------- /franco_arabic_transliterator/__init__.py: -------------------------------------------------------------------------------- 1 | name = "franco_arabic_transliterator" 2 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include data/rules.tsv 2 | include data/hfst.att 3 | include data/lexicon 4 | -------------------------------------------------------------------------------- /tests/test_basic_output.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from franco_arabic_transliterator.franco_arabic_transliterator import FrancoArabicTransliterator 3 | 4 | 5 | def test_generate_output(): 6 | transliterator = FrancoArabicTransliterator() 7 | word = 'Ahlan' 8 | transliterated_word = transliterator.transliterate(word, None) 9 | assert(transliterated_word) 10 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greetings 2 | 3 | on: [pull_request, issues] 4 | 5 | jobs: 6 | greeting: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/first-interaction@v1 10 | with: 11 | repo-token: ${{ secrets.GITHUB_TOKEN }} 12 | issue-message: 'Thanks for posting your issue. I will look through it shortly!' 13 | pr-message: 'WOW! Thanks for submitting your PR. Let''s work on it together' 14 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | setuptools.setup( 4 | name='franco_arabic_transliterator', 5 | version='0.0.1.5', 6 | description='Convert franco-arabic text into arabic', 7 | url='https://github.com/AMR-KELEG/Franco-Arabic-Transliterator', 8 | author='Amr Keleg', 9 | author_email='amr_mohamed@live.com', 10 | license='GPLv3', 11 | packages=setuptools.find_packages(), 12 | install_requires=['hfst'], 13 | include_package_data=True, 14 | zip_safe=False) 15 | 16 | -------------------------------------------------------------------------------- /data/regex: -------------------------------------------------------------------------------- 1 | [2+]:أ 2 | [%^ [[a|o|u|e|2]+]]:ا 3 | [a]:ا 4 | [%^ [[e|i]+]]:إ 5 | [a n %$]:ا 6 | 7 | [[b|p]+]:ب 8 | 9 | t:ت 10 | 11 | [t h]:ث 12 | [s]:ث 13 | 14 | [7+]:ح 15 | [h]:ح 16 | 17 | [[j|g]+]:ج 18 | 19 | [[[k h]|5]+]:خ 20 | 21 | [d+]:د 22 | 23 | [z+]:ذ 24 | 25 | [r+]:ر 26 | 27 | [z+]:ز 28 | 29 | [s+]:س 30 | [c]:س 31 | 32 | [[s|c] h]:ش 33 | 34 | [s+]:ص 35 | 36 | [d]:ض 37 | 38 | [t]:ط 39 | 40 | 3:ع 41 | [aa [a*]]:ع 42 | a:ع 43 | 44 | [3'|[g h]|8]:غ 45 | 46 | [f+]:ف 47 | [v+]:ف 48 | 49 | [2+]:ق 50 | [[9|q]+]:ق 51 | [k]:ق 52 | 53 | [c]:ك 54 | [k+]:ك 55 | 56 | [l+]:ل 57 | 58 | [m+]:م 59 | 60 | [[e | []] [n+]]:ن 61 | 62 | [h+]:ه 63 | a:ه 64 | [a %$]:ة 65 | [a h %$]:ة 66 | [t %$]:ة 67 | 68 | [o [e|2]]:ؤ 69 | 70 | [u %$]:و 71 | [[w a]|w|[w e]|[o+]]:و 72 | [[o|u]+]:و 73 | 74 | [[a|[]] [[e|i|y]+]]:ي 75 | 76 | %^:0 77 | %$:0 78 | a:0 79 | e:0 80 | i:0 81 | o:0 82 | 83 | [%^ [e|a] l]:ال 84 | [a a %$]:اء 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![https://github.com/AMR-KELEG/Franco-Arabic-Transliterator/actions?query=workflow%3ABuild](https://github.com/AMR-KELEG/Franco-Arabic-Transliterator/workflows/Build/badge.svg) 2 | [![Huggingface Space](https://img.shields.io/badge/🤗-Demo%20-yellow.svg)](https://huggingface.co/spaces/AMR-KELEG/Franco-Arabic-Transliterator) 3 | 4 | # Franco Arabic Transliterator 5 | A rule-based python script to convert romanised/franco arabic into Arabic. 6 | 7 | ## Installation 8 | `pip install franco_arabic_transliterator` 9 | 10 | ## Usage 11 | ``` 12 | from franco_arabic_transliterator.franco_arabic_transliterator import * 13 | 14 | str = '2zayak ya 7abeby' 15 | transliterator = FrancoArabicTransliterator() 16 | 17 | # Pick up one of the disambiguation methods 18 | print(transliterator.transliterate(str, method="lexicon")) # ازيك يا حبيبي 19 | print(transliterator.transliterate(str, method="language-model")) # ازيك يا حبيبي 20 | 21 | ``` 22 | -------------------------------------------------------------------------------- /.github/workflows/pythonpackage.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.8, 3.9, 3.10, 3.11, 3.12] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v1 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 pytest 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | - name: Lint with flake8 32 | run: | 33 | # stop the build if there are Python syntax errors or undefined names 34 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 35 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 36 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 37 | - name: Test with pytest 38 | run: | 39 | pytest tests/* 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /data/hfst.att: -------------------------------------------------------------------------------- 1 | 0 1 @0@ @0@ 0.000000 2 | 0 3 @0@ @0@ 0.000000 3 | 0 6 @0@ @0@ 0.000000 4 | 0 8 @0@ @0@ 0.000000 5 | 0 11 @0@ @0@ 0.000000 6 | 0 15 @0@ @0@ 0.000000 7 | 0 17 @0@ @0@ 0.000000 8 | 0 19 @0@ @0@ 0.000000 9 | 0 22 @0@ @0@ 0.000000 10 | 0 24 @0@ @0@ 0.000000 11 | 0 26 @0@ @0@ 0.000000 12 | 0 28 @0@ @0@ 0.000000 13 | 0 30 @0@ @0@ 0.000000 14 | 0 33 @0@ @0@ 0.000000 15 | 0 35 @0@ @0@ 0.000000 16 | 0 37 @0@ @0@ 0.000000 17 | 0 39 @0@ @0@ 0.000000 18 | 0 41 @0@ @0@ 0.000000 19 | 0 43 @0@ @0@ 0.000000 20 | 0 45 @0@ @0@ 0.000000 21 | 0 48 @0@ @0@ 0.000000 22 | 0 50 @0@ @0@ 0.000000 23 | 0 52 @0@ @0@ 0.000000 24 | 0 54 @0@ @0@ 0.000000 25 | 0 56 @0@ @0@ 0.000000 26 | 0 58 @0@ @0@ 0.000000 27 | 0 60 @0@ @0@ 0.000000 28 | 0 63 @0@ @0@ 0.000000 29 | 0 65 @0@ @0@ 0.000000 30 | 0 67 @0@ @0@ 0.000000 31 | 0 69 @0@ @0@ 0.000000 32 | 0 71 @0@ @0@ 0.000000 33 | 0 73 @0@ @0@ 0.000000 34 | 0 75 @0@ @0@ 0.000000 35 | 0 77 @0@ @0@ 0.000000 36 | 0 79 @0@ @0@ 0.000000 37 | 0 81 @0@ @0@ 0.000000 38 | 0 84 @0@ @0@ 0.000000 39 | 0 86 @0@ @0@ 0.000000 40 | 0 88 @0@ @0@ 0.000000 41 | 0 91 @0@ @0@ 0.000000 42 | 0 95 @0@ @0@ 0.000000 43 | 0 98 @0@ @0@ 0.000000 44 | 0 101 @0@ @0@ 0.000000 45 | 0 104 @0@ @0@ 0.000000 46 | 0 108 @0@ @0@ 0.000000 47 | 0 110 @0@ @0@ 0.000000 48 | 0 113 @0@ @0@ 0.000000 49 | 0 115 @0@ @0@ 0.000000 50 | 0 117 @0@ @0@ 0.000000 51 | 0 119 @0@ @0@ 0.000000 52 | 0 121 @0@ @0@ 0.000000 53 | 0 123 @0@ @0@ 0.000000 54 | 0 125 @0@ @0@ 0.000000 55 | 0 129 @0@ @0@ 0.000000 56 | 1 2 2 أ 0.000000 57 | 2 2 2 @0@ 0.000000 58 | 2 0.000000 59 | 3 4 ^ ا 0.000000 60 | 4 5 2 @0@ 0.000000 61 | 4 5 a @0@ 0.000000 62 | 4 5 o @0@ 0.000000 63 | 4 5 u @0@ 0.000000 64 | 4 5 e @0@ 0.000000 65 | 5 5 2 @0@ 0.000000 66 | 5 5 a @0@ 0.000000 67 | 5 5 o @0@ 0.000000 68 | 5 5 u @0@ 0.000000 69 | 5 5 e @0@ 0.000000 70 | 5 0.000000 71 | 6 7 a ا 0.000000 72 | 7 0.000000 73 | 8 9 ^ إ 0.000000 74 | 9 10 e @0@ 0.000000 75 | 9 10 i @0@ 0.000000 76 | 10 10 e @0@ 0.000000 77 | 10 10 i @0@ 0.000000 78 | 10 0.000000 79 | 11 12 a ا 0.000000 80 | 12 13 n @0@ 0.000000 81 | 13 14 $ @0@ 0.000000 82 | 14 0.000000 83 | 15 16 b ب 0.000000 84 | 15 16 p ب 0.000000 85 | 16 16 b @0@ 0.000000 86 | 16 16 p @0@ 0.000000 87 | 16 0.000000 88 | 17 18 t ت 0.000000 89 | 18 0.000000 90 | 19 20 t ث 0.000000 91 | 20 21 h @0@ 0.000000 92 | 21 0.000000 93 | 22 23 s ث 0.000000 94 | 23 0.000000 95 | 24 25 7 ح 0.000000 96 | 25 25 7 @0@ 0.000000 97 | 25 0.000000 98 | 26 27 h ح 0.000000 99 | 27 0.000000 100 | 28 29 j ج 0.000000 101 | 28 29 g ج 0.000000 102 | 29 29 j @0@ 0.000000 103 | 29 29 g @0@ 0.000000 104 | 29 0.000000 105 | 30 31 k خ 0.000000 106 | 30 32 5 خ 0.000000 107 | 31 32 h @0@ 0.000000 108 | 32 31 k @0@ 0.000000 109 | 32 32 5 @0@ 0.000000 110 | 32 0.000000 111 | 33 34 d د 0.000000 112 | 34 34 d @0@ 0.000000 113 | 34 0.000000 114 | 35 36 z ذ 0.000000 115 | 36 36 z @0@ 0.000000 116 | 36 0.000000 117 | 37 38 r ر 0.000000 118 | 38 38 r @0@ 0.000000 119 | 38 0.000000 120 | 39 40 z ز 0.000000 121 | 40 40 z @0@ 0.000000 122 | 40 0.000000 123 | 41 42 s س 0.000000 124 | 42 42 s @0@ 0.000000 125 | 42 0.000000 126 | 43 44 c س 0.000000 127 | 44 0.000000 128 | 45 46 s ش 0.000000 129 | 45 46 c ش 0.000000 130 | 46 47 h @0@ 0.000000 131 | 47 0.000000 132 | 48 49 s ص 0.000000 133 | 49 49 s @0@ 0.000000 134 | 49 0.000000 135 | 50 51 d ض 0.000000 136 | 51 0.000000 137 | 52 53 t ط 0.000000 138 | 53 0.000000 139 | 54 55 3 ع 0.000000 140 | 55 0.000000 141 | 56 57 aa ع 0.000000 142 | 57 57 a @0@ 0.000000 143 | 57 0.000000 144 | 58 59 a ع 0.000000 145 | 59 0.000000 146 | 60 61 g غ 0.000000 147 | 60 62 3' غ 0.000000 148 | 60 62 8 غ 0.000000 149 | 61 62 h @0@ 0.000000 150 | 62 0.000000 151 | 63 64 f ف 0.000000 152 | 64 64 f @0@ 0.000000 153 | 64 0.000000 154 | 65 66 v ف 0.000000 155 | 66 66 v @0@ 0.000000 156 | 66 0.000000 157 | 67 68 2 ق 0.000000 158 | 68 68 2 @0@ 0.000000 159 | 68 0.000000 160 | 69 70 9 ق 0.000000 161 | 69 70 q ق 0.000000 162 | 70 70 9 @0@ 0.000000 163 | 70 70 q @0@ 0.000000 164 | 70 0.000000 165 | 71 72 k ق 0.000000 166 | 72 0.000000 167 | 73 74 c ك 0.000000 168 | 74 0.000000 169 | 75 76 k ك 0.000000 170 | 76 76 k @0@ 0.000000 171 | 76 0.000000 172 | 77 78 l ل 0.000000 173 | 78 78 l @0@ 0.000000 174 | 78 0.000000 175 | 79 80 m م 0.000000 176 | 80 80 m @0@ 0.000000 177 | 80 0.000000 178 | 81 82 e ن 0.000000 179 | 81 83 n ن 0.000000 180 | 82 83 n @0@ 0.000000 181 | 83 83 n @0@ 0.000000 182 | 83 0.000000 183 | 84 85 h ه 0.000000 184 | 85 85 h @0@ 0.000000 185 | 85 0.000000 186 | 86 87 a ه 0.000000 187 | 87 0.000000 188 | 88 89 a ة 0.000000 189 | 89 90 $ @0@ 0.000000 190 | 90 0.000000 191 | 91 92 a ة 0.000000 192 | 92 93 h @0@ 0.000000 193 | 93 94 $ @0@ 0.000000 194 | 94 0.000000 195 | 95 96 t ة 0.000000 196 | 96 97 $ @0@ 0.000000 197 | 97 0.000000 198 | 98 99 o ؤ 0.000000 199 | 99 100 2 @0@ 0.000000 200 | 99 100 e @0@ 0.000000 201 | 100 0.000000 202 | 101 102 u و 0.000000 203 | 102 103 $ @0@ 0.000000 204 | 103 0.000000 205 | 104 105 o و 0.000000 206 | 104 106 w و 0.000000 207 | 105 105 o @0@ 0.000000 208 | 105 0.000000 209 | 106 107 a @0@ 0.000000 210 | 106 107 e @0@ 0.000000 211 | 106 0.000000 212 | 107 0.000000 213 | 108 109 o و 0.000000 214 | 108 109 u و 0.000000 215 | 109 109 o @0@ 0.000000 216 | 109 109 u @0@ 0.000000 217 | 109 0.000000 218 | 110 111 a ي 0.000000 219 | 110 112 e ي 0.000000 220 | 110 112 i ي 0.000000 221 | 110 112 y ي 0.000000 222 | 111 112 e @0@ 0.000000 223 | 111 112 i @0@ 0.000000 224 | 111 112 y @0@ 0.000000 225 | 112 112 e @0@ 0.000000 226 | 112 112 i @0@ 0.000000 227 | 112 112 y @0@ 0.000000 228 | 112 0.000000 229 | 113 114 ^ @0@ 0.000000 230 | 114 0.000000 231 | 115 116 $ @0@ 0.000000 232 | 116 0.000000 233 | 117 118 a @0@ 0.000000 234 | 118 0.000000 235 | 119 120 e @0@ 0.000000 236 | 120 0.000000 237 | 121 122 i @0@ 0.000000 238 | 122 0.000000 239 | 123 124 o @0@ 0.000000 240 | 124 0.000000 241 | 125 126 ^ ال 0.000000 242 | 126 127 a @0@ 0.000000 243 | 126 127 e @0@ 0.000000 244 | 127 128 l @0@ 0.000000 245 | 128 0.000000 246 | 129 130 a اء 0.000000 247 | 130 131 a @0@ 0.000000 248 | 131 132 $ @0@ 0.000000 249 | 132 0.000000 250 | -------------------------------------------------------------------------------- /franco_arabic_transliterator/franco_arabic_transliterator.py: -------------------------------------------------------------------------------- 1 | import re 2 | import math 3 | import hfst 4 | import string 5 | import logging 6 | import pkg_resources 7 | from functools import reduce, lru_cache 8 | from collections import Counter 9 | 10 | 11 | class FrancoArabicTransliterator: 12 | def __init__(self): 13 | """Construct a transliterator object.""" 14 | rules_file_location = pkg_resources.resource_filename("data", "hfst.att") 15 | with open(rules_file_location, "r") as f: 16 | self.transducer = hfst.AttReader(f).read() 17 | self.logger = logging.getLogger("franco_arabic_transliterator") 18 | logging.basicConfig(level=logging.DEBUG) 19 | 20 | with open(pkg_resources.resource_filename("data", "lexicon"), "r") as f: 21 | self.wordlist = { 22 | l.split("\t")[0]: int(l.split("\t")[1]) for l in f.readlines() 23 | } 24 | 25 | def find_pairs(word, grams=10, max_len=20): 26 | pairs = [] 27 | chars = ["_" for _ in range(grams)] 28 | word = "{}{}".format(word, "$" * (max_len - len(word))) 29 | for c in word: 30 | pairs.append((c, "".join(chars))) 31 | chars = chars[1:] + [c] 32 | return pairs 33 | 34 | pairs = [p for w in self.wordlist for p in find_pairs(w)] 35 | self.counts = Counter(pairs) 36 | self.sigma_counts = sum(self.counts.values()) 37 | 38 | def transliterate(self, sentence, method): 39 | """Transliterate a sentence. 40 | 41 | Keyword arguments: 42 | sentence: A string of Franco Arabic words 43 | method: The method used to disambiguate the results ("lexicon" OR "language-model") 44 | """ 45 | 46 | sentence = sentence.lower() 47 | transliteration = [] 48 | for word in sentence.split(): 49 | word = word.lower() 50 | transliteration.append( 51 | sorted(self.__transliterate_word("^{}$".format(word), {})) 52 | ) 53 | 54 | if method == "lexicon": 55 | self.logger.info( 56 | "Number of valid strings before lexicon search are: {}".format( 57 | reduce((lambda x, y: x * y), [len(t) for t in transliteration]) 58 | ) 59 | ) 60 | 61 | transliteration = [ 62 | self.__lexicon_filter(r, w.lower()) 63 | for r, w in zip(transliteration, sentence.split()) 64 | ] 65 | 66 | self.logger.info( 67 | "Number of valid strings after lexicon search are: {}".format( 68 | reduce((lambda x, y: x * y), [len(t) for t in transliteration]) 69 | ) 70 | ) 71 | 72 | return " ".join( 73 | [self.__lexicon_disambiguate(results) for results in transliteration] 74 | ) 75 | else: 76 | return " ".join( 77 | [ 78 | self.__language_model_disambiguate(results) 79 | for results in transliteration 80 | ] 81 | ) 82 | 83 | def __transliterate_word(self, word, temperorary_results_dictionary={}): 84 | """Find all the possible transliteration given the regex rules 85 | - Divide the word into all the valid prefixes, suffixes 86 | - Find the possible transliterations for the prefixes, suffixes 87 | - Join the prefix and suffix transliterations 88 | 89 | Keyword arguments: 90 | word: A Franco Arabic word 91 | temperorary_results_dictionary: A dictionary for storing intermediate results 92 | """ 93 | if not word: 94 | return set() 95 | if word in temperorary_results_dictionary: 96 | return temperorary_results_dictionary[word] 97 | results = self.__get_analyses(word) 98 | for index in range(1, len(word)): 99 | results = results.union( 100 | self.__join( 101 | self.__transliterate_word( 102 | word[:index], temperorary_results_dictionary 103 | ), 104 | self.__transliterate_word( 105 | word[index:], temperorary_results_dictionary 106 | ), 107 | ) 108 | ) 109 | 110 | # Store the temporary results in the dictionary 111 | temperorary_results_dictionary[word] = results 112 | return results 113 | 114 | @lru_cache(maxsize=1048576) 115 | def __get_analyses(self, word): 116 | """Find all the possible matches for a word string in the regex transducer. 117 | 118 | Keyword arguments: 119 | word: A Franco Arabic word 120 | temperorary_results_dictionary: A dictionary for storing intermediate results 121 | """ 122 | results = self.transducer.lookup(word, output="raw") 123 | if results: 124 | return set( 125 | [ 126 | "".join([r for r in result[1] if not "@_EPSILON_SYMBOL_@" in r]) 127 | for result in results 128 | ] 129 | ) 130 | else: 131 | return set() 132 | 133 | def __join(self, prefixes_set, suffixes_set): 134 | """Join the results of prefix and suffix sets into a single merged results set. 135 | 136 | Keyword arguments: 137 | prefixes_set: A set of all the valid transliterations of the prefix 138 | suffixes_set: set of all the valid transliterations of the suffix 139 | """ 140 | if not prefixes_set and not suffixes_set: 141 | return set() 142 | 143 | if not prefixes_set: 144 | return suffixes_set 145 | 146 | if not suffixes_set: 147 | return prefixes_set 148 | 149 | prefixes_set = list(prefixes_set) 150 | suffixes_set = list(suffixes_set) 151 | return set( 152 | ["{}{}".format(i1, i2) for i1 in prefixes_set for i2 in suffixes_set] 153 | ) 154 | 155 | def __lexicon_filter(self, word_results, word): 156 | """Use the lexicon to filter the results. 157 | 158 | Keyword arguments: 159 | word_results: The list of valid transliterations 160 | word: A Franco Arabic word 161 | """ 162 | self.logger.debug( 163 | "Results before disambiguation: {}".format(" ".join(word_results)) 164 | ) 165 | if sum([r in self.wordlist for r in word_results]) > 0: 166 | return { 167 | r: self.wordlist[r] - 50 * abs(len(r) - len(word)) 168 | for r in word_results 169 | if r in self.wordlist 170 | } 171 | return {w: 1 / (1 + abs(len(w) - len(word))) for w in word_results} 172 | 173 | def __lexicon_disambiguate(self, word_results): 174 | """Select the most relevant result. 175 | 176 | Keyword arguments: 177 | word_results: The dictionary of valid transliterations 178 | """ 179 | self.logger.debug( 180 | "Results before disambiguation: {}".format( 181 | " ".join(["{}: {}".format(w, word_results[w]) for w in word_results]) 182 | ) 183 | ) 184 | # TODO: Use a better sorting function 185 | return sorted(word_results, key=lambda t: word_results[t])[-1] 186 | 187 | def get_conditional_probability(self, word, context): 188 | prob = math.log(self.counts.get((word, context), 0) + 1) - math.log( 189 | self.sigma_counts 190 | ) 191 | return prob 192 | 193 | def get_probability(self, word, grams=10): 194 | chars = ["_" for _ in range(grams)] 195 | prob = 0 196 | for c in word: 197 | prob += self.get_conditional_probability(c, "".join(chars)) 198 | chars = chars[1:] + [c] 199 | return prob 200 | 201 | def __language_model_disambiguate(self, word_results, max_len=20): 202 | word_results = { 203 | word: self.get_probability("{}{}".format(word, "$" * (max_len - len(word)))) 204 | for word in word_results 205 | } 206 | 207 | return sorted(word_results, key=lambda t: word_results[t])[-1] 208 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------