Reference Manual#

This reference manual details modules, functions, and variables included in Maha, describing what they are and what they do. For learning how to use Maha, see overview.

maha.constants
- Subpackages
- Submodules
  - maha.constants.general
- Package Contents
  - ARABIC_LETTERS
  - SIMPLE_HARAKAT
  - TANWEN
  - HARAKAT
  - ALEF_VARIATIONS
  - LAM_ALEF_VARIATIONS
  - LAM_ALEF_VARIATIONS_NORMALIZED
  - WAW_VARIATIONS
  - YEH_VARIATIONS
  - ARABIC_NUMBERS
  - ARABIC_PUNCTUATIONS
  - ARABIC_LIGATURES
  - ARABIC_LIGATURES_NORMALIZED
  - SMALL_HARAKAT
  - OTHER_HARAKAT
  - ALL_HARAKAT
  - ARABIC
  - ARABIC_DOTLESS_MAP
  - ALEF
  - BEH
  - TEH
  - THEH
  - JEEM
  - HAH
  - KHAH
  - DAL
  - THAL
  - REH
  - ZAIN
  - SEEN
  - SHEEN
  - SAD
  - DAD
  - TAH
  - ZAH
  - AIN
  - GHAIN
  - FEH
  - QAF
  - KAF
  - LAM
  - MEEM
  - NOON
  - HEH
  - WAW
  - YEH
  - ALEF_MAKSURA
  - TEH_MARBUTA
  - ALEF_MADDA_ABOVE
  - ALEF_HAMZA_ABOVE
  - ALEF_HAMZA_BELOW
  - HAMZA
  - HAMZA_WAW
  - HAMZA_YA
  - TATWEEL
  - KASHIDA
  - ALEF_WASLA
  - ALEF_HAMZA_ABOVE_WAVY
  - ALEF_HAMZA_BELOW_WAVY
  - LAM_ALEF
  - LAM_ALEF_HAMZA_ABOVE
  - LAM_ALEF_HAMZA_BELOW
  - LAM_ALEF_MADDA_ABOVE
  - FATHATAN
  - DAMMATAN
  - KASRATAN
  - FATHA
  - DAMMA
  - KASRA
  - SHADDA
  - SUKUN
  - ARABIC_ZERO
  - ARABIC_ONE
  - ARABIC_TWO
  - ARABIC_THREE
  - ARABIC_FOUR
  - ARABIC_FIVE
  - ARABIC_SIX
  - ARABIC_SEVEN
  - ARABIC_EIGHT
  - ARABIC_NINE
  - ARABIC_COMMA
  - ARABIC_SEMICOLON
  - ARABIC_QUESTION_MARK
  - TRIPLE_DOT
  - ARABIC_DECIMAL_SEPARATOR
  - ARABIC_THOUSANDS_SEPARATOR
  - STAR
  - ARABIC_FULL_STOP
  - DATE_SEPARATOR
  - END_OF_AYAH
  - MISRA_SIGN
  - POETIC_VERSE_SIGN
  - SAJDAH
  - HIZB_START
  - ORNATE_LEFT_PARENTHESIS
  - ORNATE_RIGHT_PARENTHESIS
  - ARABIC_PERCENTAGE
  - LIGATURE_SALLA_KORANIC
  - LIGATURE_QALA
  - LIGATURE_ALLAH
  - LIGATURE_AKBAR
  - LIGATURE_MOHAMMAD
  - LIGATURE_SALAM
  - LIGATURE_RASOUL
  - LIGATURE_ALAYHE
  - LIGATURE_WASALLAM
  - LIGATURE_SALLA
  - LIGATURE_SALLALLAHOU
  - LIGATURE_JALLAJALALOUHOU
  - LIGATURE_RIAL
  - LIGATURE_BISMILLAH
  - SMALL_LIGATURE_SALLA_KORANIC
  - SMALL_LIGATURE_QALA
  - SMALL_WAW
  - SMALL_YEH
  - SMALL_TAH
  - SMALL_LAM_ALEF_YEH
  - SMALL_ZAIN
  - SMALL_FATHA
  - SMALL_DAMMA
  - SMALL_KASRA
  - SMALL_LAM_ALEF_HIGH
  - SMALL_JEEM_HIGH
  - SMALL_THREE_DOTS_HIGH
  - SMALL_MEEM_HIGH_ISOLATED
  - SMALL_MEEM_HIGH_INITIAL
  - SMALL_MEEM_LOW
  - SMALL_SEEN_LOW
  - SMALL_SEEN_HIGH
  - SMALL_ZERO_ROUNDED_HIGH
  - SMALL_ZERO_RECTANGULAR_HIGH
  - SMALL_DOTLESS_HEAD_HIGH
  - SMALL_MADDA
  - SMALL_YEH_HIGH
  - SMALL_NOON
  - SMALL_V
  - SMALL_V_INVERTED
  - SAD_SIGN
  - AIN_SIGN
  - RAHMATULLAH_SIGN
  - RADI_SIGN
  - TAKHALLUS
  - MADDAH_ABOVE
  - HAMZA_ABOVE
  - HAMZA_BELOW
  - ALEF_SUBSCRIPT
  - ALEF_SUPERSCRIPT
  - DAMMA_INVERTED
  - NOON_MARK
  - ZWARAKAY
  - DOT_BELOW
  - DAMMA_REVERSED
  - PERCENTAGE_ABOVE
  - HAMZA_BELOW_WAVY
  - LOW_STOP
  - HIGH_STOP
  - HIGH_STOP_FILLED
  - DOTLESS_BEH
  - DOTLESS_TEH
  - DOTLESS_THEH
  - DOTLESS_JEEM
  - DOTLESS_KHAH
  - DOTLESS_THAL
  - DOTLESS_ZAIN
  - DOTLESS_SHEEN
  - DOTLESS_DAD
  - DOTLESS_ZAH
  - DOTLESS_GHAIN
  - DOTLESS_FEH
  - DOTLESS_QAF
  - DOTLESS_NOON_GHUNNA
  - DOTLESS_YEH
  - DOTLESS_TEH_MARBUTA
  - ENGLISH_SMALL_LETTERS
  - ENGLISH_CAPITAL_LETTERS
  - ENGLISH_LETTERS
  - ENGLISH_NUMBERS
  - ENGLISH_PUNCTUATIONS
  - ENGLISH
  - A
  - B
  - C
  - D
  - E
  - F
  - G
  - H
  - I
  - J
  - K
  - L
  - M
  - N
  - O
  - P
  - Q
  - R
  - S
  - T
  - U
  - V
  - W
  - X
  - Y
  - Z
  - SMALL_A
  - SMALL_B
  - SMALL_C
  - SMALL_D
  - SMALL_E
  - SMALL_F
  - SMALL_G
  - SMALL_H
  - SMALL_I
  - SMALL_J
  - SMALL_K
  - SMALL_L
  - SMALL_M
  - SMALL_N
  - SMALL_O
  - SMALL_P
  - SMALL_Q
  - SMALL_R
  - SMALL_S
  - SMALL_T
  - SMALL_U
  - SMALL_V
  - SMALL_W
  - SMALL_X
  - SMALL_Y
  - SMALL_Z
  - ZERO
  - ONE
  - TWO
  - THREE
  - FOUR
  - FIVE
  - SIX
  - SEVEN
  - EIGHT
  - NINE
  - EXCLAMATION_MARK
  - QUOTATION_MARK
  - NUMBER_SIGN
  - HASHTAG
  - DOLLAR_SIGN
  - PERCENT_SIGN
  - AND_SIGN
  - AMPERSAND
  - APOSTROPHE
  - LEFT_PARENTHESIS
  - RIGHT_PARENTHESIS
  - ASTERISK
  - PLUS_SIGN
  - COMMA
  - MINUS_SIGN
  - HYPHEN_SIGN
  - DOT
  - FULL_STOP
  - SLASH
  - COLON
  - SEMICOLON
  - LESSTHAN_SIGN
  - EQUAL_SIGN
  - GREATERTHAN_SIGN
  - QUESTION_MARK
  - AT_SIGN
  - LEFT_BRACKET
  - BACKSLASH
  - RIGHT_BRACKET
  - EXPONENT_SIGN
  - CIRCUMFLEX_ACCENT
  - UNDERSCORE
  - LOWLINE
  - GRAVE_ACCENT
  - LEFTCURLY_BRACKET
  - VERTICAL_BAR
  - RIGHTCURLY_BRACKET
  - TILDE
  - ARABIC_NUMBERS
  - ARABIC_PUNCTUATIONS
  - ENGLISH_NUMBERS
  - ENGLISH_PUNCTUATIONS
  - SPACE
  - EMPTY
  - PUNCTUATIONS
  - NUMBERS
  - PERSIAN_NUMBERS
  - PERSIAN_UNIQUE_LETTERS
  - PERSIAN
  - PERSIAN_PE
  - PERSIAN_CE
  - PERSIAN_ZE
  - PERSIAN_KAF
  - PERSIAN_GAF
  - PERSIAN_YE
  - PERSIAN_EYE
  - PERSIAN_ZERO
  - PERSIAN_ONE
  - PERSIAN_TWO
  - PERSIAN_THREE
  - PERSIAN_FOUR
  - PERSIAN_FIVE
  - PERSIAN_SIX
  - PERSIAN_SEVEN
  - PERSIAN_EIGHT
  - PERSIAN_NINE
maha.cleaners
- Subpackages
  - maha.cleaners.functions
- Submodules
  - maha.cleaners.pipelines
maha.expressions
- Submodules
- Package Contents
maha.parsers
maha.processors
- Submodules
- Package Contents
  - Classes
maha.rexy
maha.utils
- Module Contents
  - Functions