return the prefixation letters. This constant take DEFAULT_PREFIX_LETTERS by default.

Returns: unicode.

return a letters.

set the prefixation letters. This constant take DEFAULT_PREFIX_LETTERS by default.

Parameters:

• new_prefix_letters (unicode.) - letters to be striped from a word, e.g.new_prefix_letters = u"وف":.

return the suffixation letters. This constant take DEFAULT_SUFFIX_LETTERS by default.

Returns: unicode.

return a letters.

set the suffixation letters. This constant take DEFAULT_SUFFIX_LETTERS by default.

Parameters:

• new_suffix_letters (unicode.) - letters to be striped from the end of a word, e.g.new_suffix_letters = u"ةون":.

get the inffixation letters. This constant take DEFAULT_INFIX_LETTERS by default.

Returns: unicode.

infixes letters.

set the inffixation letters. This constant take DEFAULT_INFIX_LETTERS by default.

Parameters:

• new_infix_letters (unicode.) - letters to be striped from the middle of a word, e.g.new_infix_letters = u"أوي":.

get the joker letter. This constant take DEFAULT_JOKER by default.

Returns: unicode.

joker letter.

set the joker letter. This constant take DEFAULT_JOKER by default.

Parameters:

• new_joker (unicode.) - joker letter.

return the constant of max length of the prefix used by the stemmer. This constant take DEFAULT_MAX_PREFIX_LENGTH by default.

Returns: integer.

return a number.

Set the constant of max length of the prefix used by the stemmer. This constant take DEFAULT_MAX_PREFIX_LENGTH by default.

Parameters:

• new_max_prefix_length (integer.) - the new max prefix length constant.

return the constant of max length of the suffix used by the stemmer. This constant take DEFAULT_MAX_SUFFIX_LENGTH by default.

Returns: integer.

return a number.

Set the constant of max length of the suffix used by the stemmer. This constant take DEFAULT_MAX_SUFFIX_LENGTH by default.

Parameters:

• new_max_suffix_length (integer.) - the new max suffix length constant.

return the constant of min length of the stem used by the stemmer. This constant take DEFAULT_MIN_STEM_LENGTH by default.

Returns: integer.

return a number.

Set the constant of min length of the stem used by the stemmer. This constant take DEFAULT_MIN_STEM_LENGTH by default.

Parameters:

• new_min_stem_length (integer.) - the min stem length constant.

return the prefixes list used by the stemmer. This constant take DEFAULT_PREFIX_LIST by default.

Returns: set().

prefixes list.

Set prefixes list used by the stemmer. This constant take DEFAULT_PREFIX_LIST by default.

Parameters:

• new_prefix_list (set of unicode string.) - a set of prefixes.

return the suffixes list used by the stemmer. This constant take DEFAULT_SUFFIX_LIST by default.

Returns: set().

suffixes list.

Set suffixes list used by the stemmer. This constant take DEFAULT_SUFFIX_LIST by default.

Parameters:

• new_suffix_list (set of unicode string.) - a set of suffixes.

Set the word to treat by the stemmer.

Parameters:

• new_word (unicode.) - the new word.

return the last word treated by the stemmer.

Returns: unicode.

word.

return the starlike word treated by the stemmer. All non affix letters are converted to a joker. The joker take by default DEFAULT_JOKER = "*".

Exmaple:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتصربونني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_starword()
أفت***ونني

Returns: unicode.

word.

return the root of the treated word by the stemmer. All non affix letters are converted to a joker. All letters in the joker places are part of root. The joker take by default DEFAULT_JOKER = "*".

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتصربونني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_starword()
أفت***ونني
>>> print ArListem.get_root()
ضرب

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

root.

return the normalized form of the treated word by the stemmer. Some letters are converted into normal form like Hamzat.

Example:

>>> word = u"استؤجرُ"
>>> ArListem = ArabicLightStemmer()
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_normalized()
استءجر

Returns: unicode.

normalized word.

return the unvocalized form of the treated word by the stemmer. Harakat are striped.

Example:

>>> word = u"الْعَرَبِيّةُ"
>>> ArListem = ArabicLightStemmer()
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_unvocalized()
العربية

Returns: unicode.

unvocalized word.

return the the left position of stemming (prefixe end position )in the word treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتصربونني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_starword()
أفت***ونني
>>> print ArListem.get_left()
3

Returns: integer.

the left position of stemming.

return the the right position of stemming (suffixe start position )in the word treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتصربونني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_starword()
أفت***ونني
>>> print ArListem.get_right()
6

Returns: integer.

the right position of stemming.

return the stem of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتكاتبانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_stem()
كاتب

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

stem.

return the star form stem of the treated word by the stemmer. All non affix letters are converted to a joker. The joker take by default DEFAULT_JOKER = "*".

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتكاتبانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_stem()
كاتب
>>> print ArListem.get_starstem()
*ات*

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

stared form of stem.

return the prefix of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتكاتبانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_prefix()
أفت

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.

Returns: unicode.

prefixe.

return the suffix of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتكاتبانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_suffix()
انني

Parameters:

• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

suffixe.

return the affix of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتكاتبانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_affix()
أفت-انني

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (in4teger.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

suffixe.

return the affix tuple of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتضاربانني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_affix_tuple()
{'prefix': u'أفت', 'root': u'ضرب', 'suffix': u'انني', 'stem': u'ضارب'}

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: dict.

affix tuple.

Stemming function, stem an arabic word, and return a stem. This function store in the instance the stemming positions (left, right), then it's possible to get other calculted attributs like : stem, prefixe, suffixe, root.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتضاربانني'
>>> stem = ArListem.light_stem(word)
>>> print ArListem.get_stem()
ضارب
>>> print ArListem.get_starstem()
*ا**
>>> print ArListem.get_left()
3
>>> print ArListem.get_right()
6
>>> print ArListem.get_root()
ضرب

Parameters:

• word (unicode.) - the input word.

Returns: unicode.

stem.

Transform all non affixation letters into a star. the star is a joker(by default '*'). which indicates that the correspandent letter is an original. this function is used by the stmmer to identify original letters. and return a stared form and stemming positions (left, right)

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتضاربانني'
>>> starword, left, right = ArListem.transformToStrars(word)
(أفت*ا**انني, 3, 6)

Parameters:

• word (unicode) - the input word.

Returns: tuple.

(starword, left, right):

• starword : all original letters converted into a star
• left : the greater possible left stemming position.
• right : the greater possible right stemming position.

return the root of the treated word by the stemmer. All non affix letters are converted to a joker. All letters in the joker places are part of root. The joker take by default DEFAULT_JOKER = "*".

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'أفتصربونني'
>>> stem = ArListem.lightStem(word)
>>> print ArListem.get_starword()
أفت***ونني
>>> print ArListem.get_root()
ضرب

Parameters:

• prefix_index (integer.) - indicate the left stemming position if = -1: not cosidered, and take the default word prefix lentgh.
• suffix_index (integer.) - indicate the right stemming position. if = -1: not cosidered, and take the default word suffix position.

Returns: unicode.

root.

lookup for prefixes in the word

Parameters:

• word (unicode @return : list of prefixes starts positions) - the given word

Returns: list of int

lookup for suffixes in the word

Parameters:

• word (unicode @return : list of suffixes starts positions) - the given word

Returns: list of int

generate a list of all posibble segmentation positions (lef, right) of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'فتضربين'
>>> print ArListem.segment(word)
set(([(1, 5), (2, 5), (0, 7)])

Returns: set of tuple of integer.

List of segmentation

return a list of segmentation positions (left, right) of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'فتضربين'
>>> ArListem.segment(word)
>>> print ArListem.get_segment_list()
set(([(1, 5), (2, 5), (0, 7)])

Returns: set of tuple of integer.

List of segmentation

return a list of affix tuple of the treated word by the stemmer.

Example:

>>> ArListem = ArabicLightStemmer()
>>> word = u'فتضربين'
>>> ArListem.segment(word)
>>> print ArListem.get_affix_list()
[{'prefix': u'ف', 'root': u'ضرب', 'suffix': u'ين', 'stem': u'تضرب'}, 
{'prefix': u'فت', 'root': u'ضرب', 'suffix': u'ين', 'stem': u'ضرب'}, 
{'prefix': u'', 'root': u'فضربن', 'suffix': u'', 'stem': u'فتضربين'}]

Returns: list of dict.

List of Affixes tuple

Normalize a word. Convert some leters forms into unified form.

Parameters:

• word (unicode.) - the input word, if word is empty, the word member of the class is normalized.

Returns: unicode.

normalized word.

Tokenize text into words

Parameters:

• text (unicode.) - the input text.

Returns: list.

list of words.