+ h΃csRt.ROtRt^RIt^RIt^RIHt^RI H t H t ^RIHt^RIHt!R R 4t!R R 4t!R R]4t!RR]4t!RR]4t]!4t]P0t]P2t]P4t]P6t]P8t]P:t]P<tRtRt Rt!R# ]d)]PPRR4'ghRtLi;i)a? enchant: Access to the enchant spellchecking library ===================================================== This module provides several classes for performing spell checking via the Enchant spellchecking library. For more details on Enchant, visit the project website: https://abiword.github.io/enchant/ Spellchecking is performed using 'Dict' objects, which represent a language dictionary. Their use is best demonstrated by a quick example:: >>> import enchant >>> d = enchant.Dict("en_US") # create dictionary for US English >>> d.check("enchant") True >>> d.check("enchnt") False >>> d.suggest("enchnt") ['enchant', 'enchants', 'enchanter', 'penchant', 'incant', 'enchain', 'enchanted'] Languages are identified by standard string tags such as "en" (English) and "fr" (French). Specific language dialects can be specified by including an additional code - for example, "en_AU" refers to Australian English. The later form is preferred as it is more widely supported. To check whether a dictionary exists for a given language, the function 'dict_exists' is available. Dictionaries may also be created using the function 'request_dict'. A finer degree of control over the dictionaries and how they are created can be obtained using one or more 'Broker' objects. These objects are responsible for locating dictionaries for a specific language. Note that unicode strings are expected throughout the entire API. Bytestrings should not be passed into any function. Errors that occur in this module are reported by raising subclasses of 'Error'. z3.2.2N)_enchantZPYENCHANT_IGNORE_MISSING_LIBF)ErrorDictNotFoundError)get_default_language)PyPWLcsHa]tRt^\toRtR.tRtRtRtRt Rt Rt Vt R #) ProviderDesca4Simple class describing an Enchant provider. Each provider has the following information associated with it: * name: Internal provider name (e.g. "aspell") * desc: Human-readable description (e.g. "Aspell Provider") * file: Location of the library containing the provider desccs*WnW nW0nR#Nnamerfileselfr rr &&&&5/usr/lib/python3.14/site-packages/enchant/__init__.py__init__ZProviderDesc.__init__is   cs(RVP,#)z )rr &r__str__ZProviderDesc.__str__ns**rcs\V4#r)Zstrrrr__repr__ZProviderDesc.__repr__qs 4yrc sVPVP8H;'d;VPVP8H;'dVPVP8H#)z*Equality operator on ProviderDesc objects.r)r Zpd&&r__eq__ZProviderDesc.__eq__ts?yyBGG#UU RWW(<UUbggAUUrc sp\VPVP,VP,4#)z&Hash operator on ProviderDesc objects.)Zhashr rr rrr__hash__ZProviderDesc.__hash__xs#DII )DII566r)rr r N) __name__ __module__ __qualname____firstlineno____doc__ _DOC_ERRORSrrrrr__static_attributes____classdictcell__ __classdict__@rrr\s2(K +V77rrcsda]tRt^}toRtRtR RltRtR]3Rlt R.] n R t R t R t VtR#) _EnchantObjectaBase class for enchant objects. This class implements some general functionality for interfacing with the '_enchant' C-library in a consistent way. All public objects from the 'enchant' module are subclasses of this class. All enchant objects have an attribute '_this' which contains the pointer to the underlying C-library object. The method '_check_this' can be called to ensure that this point is not None, raising an exception if it is. c sHRVn\eVP4R#R#)z_EnchantObject constructor.N)_this_e _init_thisrrrrZ_EnchantObject.__init__s  > OO  rNc s~VPf/Vf RpWPP3,p\V4hR#)z is used. The class of the exception can be specified using the argument )r defaulteclass&&&r _raise_errorZ_EnchantObject._raise_errorsWorr-c sDVPP4pRVR&V#)zCustomize pickling of PyEnchant objects. Since it's not safe for multiple objects to share the same C-library object, we make sure it's unset when pickling. Nr$)__dict__Zcopyr state& r __getstate__Z_EnchantObject.__getstate__s$  ""$g rcs\VPPV4VP4R#r)r0Zupdater&r1rr __setstate__Z_EnchantObject.__setstate__s U# r)r$r)rrrrrrr)r&rr/rr4r5rrr r"rr#r#}s@ "$7u !)zLrr#csaa]tRt^toRtV3RltRtRtV3RltR] 3Rlt Rt RR lt R .] n R tR tR tRtRtRtRtRtRtRtRtRtR.]n RtR.]n RtRtVtV;t#)Brokera]Broker object for the Enchant spellchecker. Broker objects are responsible for locating and managing dictionaries. Unless custom functionality is required, there is no need to use Broker objects directly. The 'enchant' module provides a default broker object so that 'Dict' objects can be created directly. The most important methods of this class include: * :py:meth:`dict_exists`: check existence of a specific language dictionary * :py:meth:`request_dict`: obtain a dictionary for specific language * :py:meth:`set_ordering`: specify which dictionaries to try for a given language. c s$<\SV`4R#)zpBroker object constructor. This method is the constructor for the 'Broker' object. No arguments are required. N)superrr r'&rrZBroker.__init__s rcs\P!4VnVP'g \R4h/VnR#)z'Could not initialise an enchant broker.N)r%Z broker_initr$r _live_dictsrrrr&ZBroker._init_thiss-^^% zzzAB Brc XVP4R# \\3dR#i;i)zBroker object destructor.N_freeZAttributeErrorZ TypeErrorrrr__del__ZBroker.__del__'  JJL *    ))csF<\SV`4pVPR4V#)r:)r7r4Zpop)r r2r's& rr4ZBroker.__getstate__s!$& -  rr*c \P!VP4pVR8XgVf V!V4hV!VP44h)z=Overrides _EnchantObject._raise_error to check broker errors.)r%Zbroker_get_errorr$decoder r,r-err&&& rr/ZBroker._raise_errors<!!$**- "9 / !SZZ\""rc sVPez\VPP44F)wrV'gKVP V4V^,pK& \ P !VP4RVnR#R#)a6Free system resource associated with a Broker object. This method can be called to free the underlying system resources associated with a Broker object. It is called automatically when the object is garbage collected. If called explicitly, the Broker and any associated Dict objects must no longer be used. N)r$Zlistr:Zitems_free_dict_datar%Z broker_free)r dictZcounts& rr=Z Broker._freesk :: !"&d&6&6&<&<&>!? e((.QJE"@ NN4:: &DJ "rc s\W4#)atRequest a Dict object for the language specified by . This method constructs and returns a Dict object for the requested language. 'tag' should be a string of the appropriate form for specifying a language, such as "fr" (French) or "en_AU" (Australian English). The existence of a specific language can be tested using the 'dict_exists' method. If is not given or is None, an attempt is made to determine the current language in use. If this cannot be determined, Error is raised. .. note:: this method is functionally equivalent to calling the Dict() constructor and passing in the argument. )Dict)r tagrr request_dictZBroker.request_dicts$Crfrc s\VP4\P!VPVP 44pVf)RpVR, pVP W13,\ 4W P9d^VPV&V#VPV;;,^, uu&V#)zRequest raw C pointer data for a dictionary. This method call passes on the call to the C library, and does some internal bookkeeping. z0Dictionary for language '%s' could not be found z?Please check https://pyenchant.github.io/pyenchant/ for details)r)r%Zbroker_request_dictr$encoder/rr:)r rJnew_dicte_str&& r_request_dict_dataZBroker._request_dict_datas ))$**cjjlC  GE V VE   efn.? @ ++ +)*D  X &   X &! + &rc svVP4\P!VPVP 44pVfRpVP W13,4W P 9d^VP V&MVP V;;,^, uu&\R4pVPW 4V#)a"Request a Dict object for a personal word list. This method behaves as 'request_dict' but rather than returning a dictionary for a specific language, it returns a dictionary referencing a personal word list. A personal word list is a file of custom dictionary entries, one word per line. z0Personal Word List file '%s' could not be loadedF) r)r%Zbroker_request_pwl_dictr$rMr/r:rI _switch_this)r pwlrNrOZds&& rrequest_pwl_dictZBroker.request_pwl_dict&s --djj#**,G  FE   efn - ++ +)*D  X &   X &! + & K x&rc sXVPVP4RVnRVnR#)zFree memory associated with a dictionary. This method frees system resources associated with a Dict object. It is equivalent to calling the object's 'free' method. Once this method has been called on a dictionary, it must not be used again. N)rGr$_brokerr rHrr _free_dictZBroker._free_dict;s$ TZZ(  rc sVP4\P!VPV4VPV;;,^,uu&VPV,^8XdVPVR#R#)z'Free the underlying pointer for a dict.N)r)r%Zbroker_free_dictr$r:rVrrrGZBroker._free_dict_dataFs^  DJJ- !#   D !Q &  & 'rc sVP4\P!VPVP 44p\ V4#)zCheck availability of a dictionary. This method checks whether there is a dictionary available for the language specified by 'tag'. It returns True if a dictionary is available, and False otherwise. )r)r%Zbroker_dict_existsr$rMZbool)r rJval&& r dict_existsZBroker.dict_existsNs6 ##DJJ =Cyrc sVP4\P!VPVP 4VP 44R#)a2Set dictionary preferences for a language. The Enchant library supports the use of multiple dictionary programs and multiple languages. This method specifies which dictionaries the broker should prefer when dealing with a given language. 'tag' must be an appropriate language specification and 'ordering' is a string listing the dictionaries in order of preference. For example a valid ordering might be "aspell,myspell,ispell". The value of 'tag' can also be set to "*" to set a default ordering for all languages for which one has not been set explicitly. N)r)r%Zbroker_set_orderingr$rM)r rJZorderingr.r set_orderingZBroker.set_orderingYs3  tzz3::<9JKrc sVP4.Vn\P!VPVP 4VPUu.uF p\ V!NK up#uupi)zReturn list of provider descriptions. This method returns a list of descriptions of each of the dictionary providers available. Each entry in the list is a ProviderDesc object. )r)_Broker__describe_resultr%Zbroker_describer$_Broker__describe_callbackrr Zrr3rdescribeZBroker.describehsW !# 4::t'?'?@*.*@*@A*@Q a *@AAAsA&c sVP4pVP4pVP4pVPPWV34R#)zCollector callback for dictionary description. This method is used as a callback into the _enchant function 'enchant_broker_describe'. It collects the given arguments in a tuple and appends them to the list '__describe_result'. N)rCr\appendr r r__describe_callbackZBroker.__describe_callbackts>{{}{{}{{} %%t4&89rc sVP4.Vn\P!VPVP 4VPUu.uFq^,\ V^,!3NK up#uupi)aWReturn list of available dictionaries. This method returns a list of dictionaries available to the broker. Each entry in the list is a two-tuple of the form: (tag,provider) where is the language lag for the dictionary and is a ProviderDesc object describing the provider through which that dictionary can be obtained. )r)_Broker__list_dicts_resultr%Zbroker_list_dictsr$_Broker__list_dicts_callbackrr^r3r list_dictsZBroker.list_dictssb #%  TZZ)C)CD595M5MN5M1|QqT*+5MNNNs!A5c sVP4pVP4pVP4pVP4pVPPWW4334R#)zCollector callback for listing dictionaries. This method is used as a callback into the _enchant function 'enchant_broker_list_dicts'. It collects the given arguments into an appropriate tuple and appends them to '__list_dicts_result'. N)rCrbr`r rJr rr &&&&&rZ__list_dicts_callbackZBroker.__list_dicts_callbacksLjjl{{}{{}{{}   ''T.@(ABrc sn.pVP4Fwr#W!9gK VPV4K V#)zList languages for which dictionaries are available. This function returns a list of language tags for which a dictionary is available. )rdr`)r ZlangsrJZprovs& rlist_languagesZBroker.list_languagess5 ??,KS S!- rc sRa.oV3Rlp\P!W4S^,#)zGet the description tuple for a dict data object. must be a C-library pointer to an enchant dictionary. The return value is a tuple of the form: (,,,) cs<VP4pVP4pVP4pVP4pSPWW#34R#r)rCr`)rJr rr cb_results&&&&rcb_funcZ'Broker.__describe_dict..cb_funcsB**,C;;=D;;=D;;=D   c4 5r)r% dict_describe)r Z dict_datarirhs&& @rZ__describe_dictZBroker.__describe_dicts)  6 ,|rrc s\P!VPVP44pVeVP 4pV#)a+Get the value of a named parameter on this broker. Parameters are used to provide runtime information to individual provider backends. See the method :py:meth:`set_param` for more details. .. warning:: This method does **not** work when using the Enchant C library version 2.0 and above )r%Zbroker_get_paramr$rMrC)r r paramrYr get_paramZBroker.get_params6##DJJ >  LLNE rrkc sVP4pVeVP4p\P!VPW4R#)zSet the value of a named parameter on this broker. Parameters are used to provide runtime information to individual provider backends. .. warning:: This method does **not** work when using the Enchant C library version 2.0 and above N)rMr%Zbroker_set_paramr$)r r Zvaluer.r set_paramZBroker.set_params4{{}  LLNE DJJ4r)__describe_resultZ__list_dicts_resultr:r$r)rrrrrrr&r>r4rr/r=rKrrQrTrWrGrZr[r_r]rdrcrgZ_Broker__describe_dictrlrmrr __classcell__r'r!@@rr6r6s   $7u#$(!%vL$* '  L B :O" C ($*(O %II55rr6csaa]tRtRtoRtRV3RlltRtRtRtR.]n RV3Rllt R ] 3R lt R t R tR tRtRtRtRtRtRtRtRtRR.]n RRltRtRtVtV;t#)rIiaDictionary object for the Enchant spellchecker. Dictionary objects are responsible for checking the spelling of words and suggesting possible corrections. Each dictionary is owned by a Broker object, but unless a new Broker has explicitly been created then this will be the 'enchant' module default Broker and is of little interest. The important methods of this class include: * check(): check whether a word id spelled correctly * suggest(): suggest correct spellings for a word * add(): add a word to the user's personal dictionary * remove(): add a word to the user's personal exclude list * add_to_session(): add a word to the current spellcheck session * store_replacement(): indicate a replacement for a given word Information about the dictionary is available using the following attributes: * tag: the language tag of the dictionary * provider: a ProviderDesc object for the dictionary provider c s<RVnVf%\4pVfRpVR,p\V4hWnVf\pW n\ SV`4R#)aDict object constructor. A dictionary belongs to a specific language, identified by the string . If the tag is not given or is None, an attempt to determine the language currently in use is made using the 'locale' module. If the current language cannot be determined, Error is raised. If is instead given the value of False, a 'dead' Dict object is created without any reference to a language. This is typically only useful within PyEnchant itself. Any other non-string value for raises Error. Each dictionary must also have an associated Broker object which obtains the dictionary information from the underlying system. This may be specified using . If not given, the default broker is used. Nz0No tag specified and default language could not zbe determined.)providerrrrJrUr7r)r rJbrokerrEr's&&& rrZ Dict.__init__sW& ;&(C{H,,Cj  >F  rcsRVnVP'dCVPPVP4pVP WP4R#R#r)r$rJrUrQrR)r thisr3rr&ZDict._init_this sC 888<<22488Z Dict.__del__(r?r@c s\PV4WnW nVP RR7pV^,Vn\ VR,!VnR#)a Switch the underlying C-library pointer for this object. As all useful state for a Dict is stored by the underlying C-library pointer, it is very convenient to allow this to be switched at run-time. Pass a new dict data object into this method to affect the necessary changes. The creating Broker object (at the Python level) must also be provided. This should *never* *ever* be used by application code. It's a convenience for developers only, replacing the clunkier parameter to __init__ from earlier versions. F) check_this:iNNN)rIr=r$rU_Dict__describerJrrr)r rtrsrrFrrRZDict._switch_this0sE 4  %07$d2h/ rZinitc s<VPeVPPfRVn\SV` V4R#)zExtend _EnchantObject._check_this() to check Broker validity. It is possible for the managing Broker object to be freed without freeing the Dict. Thus validity checking must take into account self._broker._this as well as self._this. N)rUr$r7r)r r(r'&&rr)ZDict._check_thisIs2 << 4<<#5#5#=DJ C rr*c rA)z;Overrides _EnchantObject._raise_error to check dict errors.rB)r%Zdict_get_errorr$rCrDrFrr/ZDict._raise_errorTs< + "9 / !SZZ\""rc sVPeHVPe8VPPeVPPV4R#R#R#R#)zFree the system resources associated with a Dict object. This method frees underlying system resources for a Dict object. Once it has been called, the Dict object must no longer be used. It is called automatically when the object is garbage collected. N)r$rUrWrrrr=Z Dict._free[sI :: !||'DLL,>,>,J ''--K' "rc sVP4\V4^8Xd \R4h\P!VP VP 44pV^8XdR#V^8dR#VP4R#)zCheck spelling of a word. This method takes a word in the dictionary language and returns True if it is correctly spelled, and false otherwise. z$can't check spelling of empty stringTFN)r)len ValueErrorr%Z dict_checkr$rMr/)r wordrXrYrcheckZ Dict.checkhsc  t9>CD DmmDJJ 6 !8 7 rc sVP4\V4^8Xd \R4h\P!VP VP 44pVUu.uFq3P4NK up#uupi)Suggest possible spellings for a word. This method tries to guess the correct spelling for a given word, returning the possibilities in a list. z(can't suggest spellings for empty string)r)ryrzr%Z dict_suggestr$rMrC)r r{suggswrPrsuggestZ Dict.suggestzs_  t9>GH H DKKM:$)*Eq E***sA:c VP4\P!VPVP 44R#),Add a word to the user's personal word list.N)r)r%Zdict_addr$rMr r{rraddZDict.adds&  DJJ .rc r)z/Add a word to the user's personal exclude list.N)r)r%Z dict_remover$rMrrrremoveZ Dict.removes&  tzz4;;=1rc s\P!R\^R7VP4\P !VP VP44R#)rz2Dict.add_to_pwl is deprecated, please use Dict.add)ZcategoryZ stacklevelN)warningsZwarnZDeprecationWarningr)r%Zdict_add_to_pwlr$rMrrr add_to_pwlZDict.add_to_pwls? @'  4::t{{}5rc r)z(Add a word to the session personal list.N)r)r%Zdict_add_to_sessionr$rMrrradd_to_sessionZDict.add_to_sessions(  tzz4;;=9rc r)z'Add a word to the session exclude list.N)r)r%Zdict_remove_from_sessionr$rMrrrremove_from_sessionZDict.remove_from_sessions(  ##DJJ >rc VP4\P!VPVP 44#z2Check whether a word is in the personal word list.)r)r%Z dict_is_addedr$rMrrris_addedZ Dict.is_addeds+  DKKM::rc rz5Check whether a word is in the personal exclude list.)r)r%Zdict_is_removedr$rMrrr is_removedZDict.is_removeds+ !!$**dkkm< is in fact correctly spelled as . Such a suggestion will typically mean that appears early in the list of suggested spellings offered for later instances of . z+can't store replacement for an empty stringz)can't store empty string as a replacementN)rzr)r%Zdict_store_replacementr$rM)r misZcorr.rstore_replacementZDict.store_replacementsPJK KHI I  !!$**cjjlCJJLIrrc sV'dVP4\P!VPVP4VP #)aReturn a tuple describing the dictionary. This method returns a four-element tuple describing the underlying spellchecker system providing the dictionary. It will contain the following strings: * language tag * name of dictionary provider * description of dictionary provider * dictionary file Direct use of this method is not recommended - instead, access this information through the 'tag' and 'provider' attributes. )r)r%rjr$_Dict__describe_callback_Dict__describe_result)r rurrZ __describeZDict.__describes9      T%=%=>%%%rc sVP4pVP4pVP4pVP4pWW43VnR#)zCollector callback for dictionary description. This method is used as a callback into the _enchant function 'enchant_dict_describe'. It collects the given arguments in a tuple and stores them in the attribute '__describe_result'. N)rCrrerfrraZDict.__describe_callbacks=jjl{{}{{}{{}"%T!8r)rnrUr$rrrJ)NNr)T)rrrrrrr&r>rRrr)rr/r=r|rrrrrrrrrrvrrrrorprqrrIrIs2!F20.!'xL !$7u# .$ +/ 2 6: ? ; = J&+EN!&( 9 9rrIcsaa]tRtRtoRt.ROtRV3RlltRV3RlltV3RltV3Rlt V3Rlt Rt R t R t R tR tR tVtV;t#) DictWithPWLiadDictionary with separately-managed personal word list. .. note:: As of version 1.4.0, enchant manages a per-user pwl and exclude list. This class is now only needed if you want to explicitly maintain a separate word list in addition to the default one. This class behaves as the standard Dict class, but also manages a personal word list stored in a separate file. The file must be specified at creation time by the 'pwl' argument to the constructor. Words added to the dictionary are automatically appended to the pwl file. A personal exclude list can also be managed, by passing another filename to the constructor in the optional 'pel' argument. If this is not given, requests to exclude words are ignored. If either 'pwl' or 'pel' are None, an in-memory word list is used. This will prevent calls to add() and remove() from affecting the user's default word lists. The Dict object managing the PWL is available as the 'pwl' attribute. The Dict object managing the PEL is available as the 'pel' attribute. To create a DictWithPWL from the user's default language, use None as the 'tag' argument. c s<\SV`W4Ved\PP V4'g\ VR4pVP 4?VPPV4Vn M\4Vn Vee\PP V4'g\ VR4pVP 4?VPPV4Vn R#\4Vn R#)aLDictWithPWL constructor. The argument 'pwl', if not None, names a file containing the personal word list. If this file does not exist, it is created with default permissions. The argument 'pel', if not None, names a file containing the personal exclude list. If this file does not exist, it is created with default permissions. NZwt) r7rospathZexistsZopenZcloserUrTrSrpel)r rJrSrrsZfr's&&&&& rrZDictWithPWL.__init__s % ?77>>#&&dO ||44S9DHwDH ?77>>#&&dO ||44S9DHwDHrc s <VPfVP4VPfVP4\SV`V4VPP V4VPP V4R#)z0Extend Dict._check_this() to check PWL validity.N)rSr=rr7r)rwrxrr)ZDictWithPWL._check_thissZ 88  JJL 88  JJL C  S! S!rc s<VPe"VPP4RVnVPe"VPP4RVn\SV`4R#)z,Extend Dict._free() to free the PWL as well.N)rSr=rr7r8r9rr=ZDictWithPWL._free)sJ 88  HHNN DH 88  HHNN DH  rc s<VPPV4'dR#VPPV4'dR#\SV`V4'dR#R#)zCheck spelling of a word. This method takes a word in the dictionary language and returns True if it is correctly spelled, and false otherwise. It checks both the dictionary and the personal word list. FT)rr|rSr7)r r{r'rxrr|ZDictWithPWL.check3sF 88>>$   88>>$   7=  rc sR<\SV`V4pTPVPPV4Uu.uF q3V9gK VNK up4\ \ V4^, RR4F.pVP PW$,4'gK,W$K0 V#uupi)r}i)r7rZextendrSZrangeryrr|)r r{r~rZir's&& rrZDictWithPWL.suggestBs % !1!1$!7J!7AE>aa!7JKs5zA~r2.Axx~~eh''H/ Ks B$B$c VP4VPPV4VPP V4R#zAdd a word to the associated personal word list. This method adds the given word to the personal word list, and automatically saves the list to disk. N)r)rSrrrrrrrZDictWithPWL.addOs0   T rc r)z*Add a word to the associated exclude list.N)r)rSrrrrrrrZDictWithPWL.removeYs.    Trc rr)r)rSrrrrrrrZDictWithPWL.add_to_pwl_s2  D! rc XVP4VPPV4#r)r)rSrrrrrZDictWithPWL.is_addedi# xx  &&rc rr)r)rrrrrrZDictWithPWL.is_removednrr)rrS)rrZPELr)NNNr)rrrrrrrr)r=r|rrrrrrrrrorprqrrrsH8/K:"   ' ''rrcH\P!4P4#)z:Get the version string for the underlying enchant library.)r%Z get_versionrCr+rrget_enchant_versionrs >>  " " $$rcs.\P!V4#)zSet the prefix used by the Enchant library to find its plugins Called automatically when the Python library is imported when required. )r%set_prefix_dirr)rrrrrs   T ""rcr)z]Return the path that will be used by some Enchant providers to look for custom dictionaries. )r%get_user_config_dirrCr+rrrrs  ! ! # * * ,,r)enchntrZincantrL)"rrZ __version__rrZenchantrr%Z ImportErrorZenvironZgetZenchant.errorsrrZ enchant.utilsrZ enchant.pypwlrrr#r6rIrrUrKrTrZrdrgrlrmrrrr+rrrs <*V3  & 4.77B::zf5^f5R }9>}9@N'$N'f (## ++!!    ''       % -- ::>>8% @ @ BsC(C60C65C6