Grammalecte  Hex Artifact Content

Artifact 74d38805d740ff3378b5ea3b0e527892e9905cdb19ce290081b71991721a8bb1:

  • File doc/API.txt — part of check-in [2fd7dc4dd5] at 2017-04-25 11:51:19 on branch trunk — commit 1 (user: olr size: 3054)

0000: 0a 3d 20 47 72 61 6d 6d 61 6c 65 63 74 65 20 41  .= Grammalecte A
0010: 50 49 20 3d 0a 0a 53 6f 72 72 79 2c 20 50 45 50  PI =..Sorry, PEP
0020: 38 2e 20 43 61 6d 65 6c 43 61 73 65 20 68 65 72  8. CamelCase her
0030: 65 2e 20 57 72 69 74 65 72 20 6c 65 67 61 63 79  e. Writer legacy
0040: 20 26 20 4a 61 76 61 53 63 72 69 70 74 2e 0a 0a   & JavaScript...
0050: 0a 3d 3d 20 67 72 61 6d 6d 61 6c 65 63 74 65 2e  .== grammalecte.
0060: 69 62 64 61 77 67 20 3d 3d 0a 0a 20 20 20 20 2e  ibdawg ==..    .
0070: 49 42 44 41 57 47 0a 20 20 20 20 20 20 20 20 2e  IBDAWG.        .
0080: 5f 5f 69 6e 69 74 5f 5f 28 64 69 63 5f 6e 61 6d  __init__(dic_nam
0090: 65 29 0a 20 20 20 20 20 20 20 20 20 20 20 20 4c  e).            L
00a0: 6f 61 64 73 20 74 68 65 20 64 69 63 74 69 6f 6e  oads the diction
00b0: 61 72 79 20 64 69 63 5f 6e 61 6d 65 20 66 72 6f  ary dic_name fro
00c0: 6d 20 74 68 65 20 66 6f 6c 64 65 72 20 5f 64 69  m the folder _di
00d0: 63 74 69 6f 6e 61 72 69 65 73 2e 0a 0a 20 20 20  ctionaries...   
00e0: 20 20 20 20 20 2e 6c 6f 6f 6b 75 70 28 77 6f 72       .lookup(wor
00f0: 64 29 0a 20 20 20 20 20 20 20 20 20 20 20 20 52  d).            R
0100: 65 74 75 72 6e 73 20 54 72 75 65 20 69 66 20 77  eturns True if w
0110: 6f 72 64 20 69 73 20 69 6e 20 74 68 65 20 64 69  ord is in the di
0120: 63 74 69 6f 6e 61 72 79 20 65 6c 73 65 20 46 61  ctionary else Fa
0130: 6c 73 65 2e 0a 0a 20 20 20 20 20 20 20 20 2e 69  lse...        .i
0140: 73 56 61 6c 69 64 28 77 6f 72 64 29 0a 20 20 20  sValid(word).   
0150: 20 20 20 20 20 20 20 20 20 52 65 74 75 72 6e 73           Returns
0160: 20 54 72 75 65 20 69 66 20 77 6f 72 64 20 69 73   True if word is
0170: 20 69 6e 20 74 68 65 20 64 69 63 74 69 6f 6e 61   in the dictiona
0180: 72 79 20 65 6c 73 65 20 46 61 6c 73 65 2e 20 53  ry else False. S
0190: 65 76 65 72 61 6c 20 63 61 73 69 6e 67 20 74 72  everal casing tr
01a0: 69 65 64 2e 0a 0a 20 20 20 20 20 20 20 20 2e 69  ied...        .i
01b0: 73 56 61 6c 69 64 54 6f 6b 65 6e 28 74 6f 6b 65  sValidToken(toke
01c0: 6e 29 0a 20 20 20 20 20 20 20 20 20 20 20 20 52  n).            R
01d0: 65 74 75 72 6e 73 20 54 72 75 65 20 69 66 20 74  eturns True if t
01e0: 6f 6b 65 6e 20 28 63 6f 6d 62 69 6e 61 74 69 6f  oken (combinatio
01f0: 6e 20 6f 66 20 77 6f 72 64 73 29 20 69 73 20 76  n of words) is v
0200: 61 6c 69 64 2e 20 53 65 76 65 72 61 6c 20 63 61  alid. Several ca
0210: 73 69 6e 67 20 74 72 69 65 64 2e 0a 0a 20 20 20  sing tried...   
0220: 20 20 20 20 20 2e 67 65 74 4d 6f 72 70 68 28 77       .getMorph(w
0230: 6f 72 64 29 0a 20 20 20 20 20 20 20 20 20 20 20  ord).           
0240: 20 52 65 74 75 72 6e 73 20 74 68 65 20 6c 69 73   Returns the lis
0250: 74 20 6f 66 20 6d 6f 72 70 68 6f 6c 6f 67 69 65  t of morphologie
0260: 73 20 6f 66 20 77 6f 72 64 2e 0a 0a 0a 3d 3d 20  s of word....== 
0270: 67 72 61 6d 6d 61 6c 65 63 74 65 2e 66 72 20 3d  grammalecte.fr =
0280: 3d 0a 0a 20 20 20 20 47 72 61 6d 6d 61 72 20 63  =..    Grammar c
0290: 68 65 63 6b 65 72 20 66 6f 72 20 46 72 65 6e 63  hecker for Frenc
02a0: 68 20 6c 61 6e 67 75 61 67 65 0a 0a 20 20 20 20  h language..    
02b0: 2e 6c 6f 61 64 28 29 0a 20 20 20 20 20 20 20 20  .load().        
02c0: 49 6e 69 74 69 61 6c 69 7a 65 20 74 68 65 20 67  Initialize the g
02d0: 72 61 6d 6d 61 72 20 63 68 65 63 6b 65 72 2e 0a  rammar checker..
02e0: 0a 20 20 20 20 2e 70 61 72 73 65 28 70 61 72 61  .    .parse(para
02f0: 67 72 61 70 68 29 0a 20 20 20 20 20 20 20 20 52  graph).        R
0300: 65 74 75 72 6e 73 20 61 20 6c 69 73 74 20 6f 66  eturns a list of
0310: 20 65 72 72 6f 72 73 20 66 6f 75 6e 64 20 69 6e   errors found in
0320: 20 74 68 65 20 70 61 72 61 67 72 61 70 68 2e 0a   the paragraph..
0330: 0a 20 20 20 20 2e 73 65 74 4f 70 74 69 6f 6e 73  .    .setOptions
0340: 28 64 69 63 74 5f 6f 70 74 69 6f 6e 73 29 0a 20  (dict_options). 
0350: 20 20 20 20 20 20 20 43 68 61 6e 67 65 20 74 68         Change th
0360: 65 20 67 72 61 6d 6d 61 72 20 63 68 65 63 6b 69  e grammar checki
0370: 6e 67 20 6f 70 74 69 6f 6e 73 2e 0a 0a 20 20 20  ng options...   
0380: 20 2e 67 65 74 44 69 63 74 69 6f 6e 61 72 79 28   .getDictionary(
0390: 29 0a 20 20 20 20 20 20 20 20 52 65 74 75 72 6e  ).        Return
03a0: 73 20 74 68 65 20 64 69 63 74 69 6f 6e 61 72 79  s the dictionary
03b0: 20 28 49 42 44 41 57 47 29 0a 0a 0a 3d 3d 20 67   (IBDAWG)...== g
03c0: 72 61 6d 6d 61 6c 65 63 74 65 2e 66 72 2e 63 6f  rammalecte.fr.co
03d0: 6e 6a 20 3d 3d 0a 0a 20 20 20 20 2e 69 73 56 65  nj ==..    .isVe
03e0: 72 62 28 77 6f 72 64 29 0a 20 20 20 20 20 20 20  rb(word).       
03f0: 20 52 65 74 75 72 6e 73 20 54 72 75 65 20 69 73   Returns True is
0400: 20 77 6f 72 64 20 65 78 69 73 74 73 20 69 6e 20   word exists in 
0410: 74 68 65 20 6c 69 73 74 20 6f 66 20 76 65 72 62  the list of verb
0420: 20 28 69 6e 66 69 6e 69 74 65 20 66 6f 72 6d 29   (infinite form)
0430: 0a 0a 20 20 20 20 2e 67 65 74 43 6f 6e 6a 28 76  ..    .getConj(v
0440: 65 72 62 2c 20 74 65 6e 73 65 2c 20 77 68 6f 29  erb, tense, who)
0450: 0a 20 20 20 20 20 20 20 20 52 65 74 75 72 6e 73  .        Returns
0460: 20 63 6f 6e 6a 75 67 61 74 69 6f 6e 20 6f 66 20   conjugation of 
0470: 76 65 72 62 20 77 69 74 68 20 73 75 62 6a 65 63  verb with subjec
0480: 74 20 77 68 6f 20 61 74 20 74 65 6e 73 65 20 28  t who at tense (
0490: 63 61 6e 20 62 65 20 61 6e 20 65 6d 70 74 79 20  can be an empty 
04a0: 73 74 72 69 6e 67 29 0a 20 20 20 20 20 20 20 20  string).        
04b0: 20 20 20 20 74 65 6e 73 65 20 68 61 73 20 74 6f      tense has to
04c0: 20 62 65 3a 0a 20 20 20 20 20 20 20 20 20 20 20   be:.           
04d0: 20 20 20 20 20 3a 59 20 20 20 20 20 20 69 6e 66       :Y      inf
04e0: 69 6e 69 74 69 66 0a 20 20 20 20 20 20 20 20 20  initif.         
04f0: 20 20 20 20 20 20 20 3a 50 51 20 20 20 20 20 70         :PQ     p
0500: 61 72 74 69 63 69 70 65 73 20 70 61 73 73 c3 a9  articipes pass..
0510: 73 20 65 74 20 70 72 c3 a9 73 65 6e 74 0a 20 20  s et pr..sent.  
0520: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 3a 49                :I
0530: 70 20 20 20 20 20 69 6e 64 69 63 61 74 69 66 20  p     indicatif 
0540: 70 72 c3 a9 73 65 6e 74 0a 20 20 20 20 20 20 20  pr..sent.       
0550: 20 20 20 20 20 20 20 20 20 3a 49 71 20 20 20 20           :Iq    
0560: 20 69 6d 70 61 72 66 61 69 74 0a 20 20 20 20 20   imparfait.     
0570: 20 20 20 20 20 20 20 20 20 20 20 3a 49 73 20 20             :Is  
0580: 20 20 20 70 61 73 73 c3 a9 20 73 69 6d 70 6c 65     pass.. simple
0590: 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  .               
05a0: 20 3a 49 66 20 20 20 20 20 66 75 74 75 72 0a 20   :If     futur. 
05b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 3a                 :
05c0: 4b 20 20 20 20 20 20 63 6f 6e 64 69 74 69 6f 6e  K      condition
05d0: 6e 65 6c 0a 20 20 20 20 20 20 20 20 20 20 20 20  nel.            
05e0: 20 20 20 20 3a 53 70 20 20 20 20 20 73 75 62 6a      :Sp     subj
05f0: 6f 6e 63 74 69 66 20 70 72 c3 a9 73 65 6e 74 0a  onctif pr..sent.
0600: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0610: 3a 53 71 20 20 20 20 20 73 75 62 6a 6f 6e 63 74  :Sq     subjonct
0620: 69 66 20 69 6d 70 61 72 66 61 69 74 0a 20 20 20  if imparfait.   
0630: 20 20 20 20 20 20 20 20 20 20 20 20 20 3a 45 20               :E 
0640: 20 20 20 20 20 69 6d 70 c3 a9 72 61 74 69 66 0a       imp..ratif.
0650: 0a 20 20 20 20 20 20 20 20 20 20 20 20 77 68 6f  .            who
0660: 20 68 61 73 20 74 6f 20 62 65 3a 0a 20 20 20 20   has to be:.    
0670: 20 20 20 20 20 20 20 20 20 20 20 20 3a 50 20 20              :P  
0680: 20 20 20 20 70 61 72 74 69 63 69 70 65 20 70 72      participe pr
0690: c3 a9 73 65 6e 74 0a 20 20 20 20 20 20 20 20 20  ..sent.         
06a0: 20 20 20 20 20 20 20 3a 51 31 20 20 20 20 20 70         :Q1     p
06b0: 61 72 74 69 63 69 70 65 20 70 61 73 73 c3 a9 20  articipe pass.. 
06c0: 6d 61 73 63 75 6c 69 6e 20 73 69 6e 67 75 6c 69  masculin singuli
06d0: 65 72 20 6f 75 20 69 6e 76 61 72 69 61 62 6c 65  er ou invariable
06e0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  .               
06f0: 20 3a 51 32 20 20 20 20 20 70 61 72 74 69 63 69   :Q2     partici
0700: 70 65 20 70 61 73 73 c3 a9 20 6d 61 73 63 75 6c  pe pass.. mascul
0710: 69 6e 20 70 6c 75 72 69 65 6c 0a 20 20 20 20 20  in pluriel.     
0720: 20 20 20 20 20 20 20 20 20 20 20 3a 51 33 20 20             :Q3  
0730: 20 20 20 70 61 72 74 69 63 69 70 65 20 70 61 73     participe pas
0740: 73 c3 a9 20 66 c3 a9 6d 69 6e 69 6e 20 73 69 6e  s.. f..minin sin
0750: 67 75 6c 69 65 72 0a 20 20 20 20 20 20 20 20 20  gulier.         
0760: 20 20 20 20 20 20 20 3a 51 34 20 20 20 20 20 70         :Q4     p
0770: 61 72 74 69 63 69 70 65 20 70 61 73 73 c3 a9 20  articipe pass.. 
0780: 66 c3 a9 6d 69 6e 69 6e 20 70 6c 75 72 69 65 6c  f..minin pluriel
0790: 0a 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ..              
07a0: 20 20 3a 31 73 20 20 20 20 20 70 72 65 6d 69 c3    :1s     premi.
07b0: a8 72 65 20 70 65 72 73 6f 6e 6e 65 20 61 75 20  .re personne au 
07c0: 73 69 6e 67 75 6c 69 65 72 20 0a 20 20 20 20 20  singulier .     
07d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
07e0: 20 20 20 28 31 c5 9b 20 70 6f 75 72 20 75 6e 65     (1.. pour une
07f0: 20 c3 a9 76 65 6e 74 75 65 6c 6c 65 20 66 6f 72   ..ventuelle for
0800: 6d 65 20 69 6e 74 65 72 72 6f 67 61 74 69 76 65  me interrogative
0810: 20 73 70 c3 a9 63 69 66 69 71 75 65 29 0a 20 20   sp..cifique).  
0820: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 3a 32                :2
0830: 73 20 20 20 20 20 64 65 75 78 69 c3 a8 6d 65 20  s     deuxi..me 
0840: 70 65 72 73 6f 6e 6e 65 20 61 75 20 73 69 6e 67  personne au sing
0850: 75 6c 69 65 72 0a 20 20 20 20 20 20 20 20 20 20  ulier.          
0860: 20 20 20 20 20 20 3a 33 73 20 20 20 20 20 74 72        :3s     tr
0870: 6f 69 73 69 c3 a8 6d 65 20 70 65 72 73 6f 6e 6e  oisi..me personn
0880: 65 20 61 75 20 73 69 6e 67 75 6c 69 65 72 0a 20  e au singulier. 
0890: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 3a                 :
08a0: 31 70 20 20 20 20 20 70 72 65 6d 69 c3 a8 72 65  1p     premi..re
08b0: 20 70 65 72 73 6f 6e 6e 65 20 61 75 20 70 6c 75   personne au plu
08c0: 72 69 65 6c 0a 20 20 20 20 20 20 20 20 20 20 20  riel.           
08d0: 20 20 20 20 20 3a 32 70 20 20 20 20 20 64 65 75       :2p     deu
08e0: 78 69 c3 a8 6d 65 20 70 65 72 73 6f 6e 6e 65 20  xi..me personne 
08f0: 61 75 20 70 6c 75 72 69 65 6c 0a 20 20 20 20 20  au pluriel.     
0900: 20 20 20 20 20 20 20 20 20 20 20 3a 33 70 20 20             :3p  
0910: 20 20 20 74 72 6f 69 73 69 c3 a8 6d 65 20 70 65     troisi..me pe
0920: 72 73 6f 6e 6e 65 20 61 75 20 70 6c 75 72 69 65  rsonne au plurie
0930: 6c 0a 0a 20 20 20 20 20 20 20 20 45 78 63 65 70  l..        Excep
0940: 74 69 6f 6e 20 56 61 6c 75 65 45 72 72 6f 72 20  tion ValueError 
0950: 69 73 20 72 61 69 73 65 64 20 69 66 20 66 61 69  is raised if fai
0960: 6c 65 64 20 74 6f 20 72 65 74 72 69 65 76 65 20  led to retrieve 
0970: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 0a 20 20  information...  
0980: 20 20 2e 68 61 73 43 6f 6e 6a 28 76 65 72 62 2c    .hasConj(verb,
0990: 20 74 65 6e 73 65 2c 20 77 68 6f 29 0a 20 20 20   tense, who).   
09a0: 20 20 20 20 20 52 65 74 75 72 6e 73 20 46 61 6c       Returns Fal
09b0: 73 65 20 69 66 20 6e 6f 20 63 6f 6e 6a 75 67 61  se if no conjuga
09c0: 74 69 6f 6e 20 77 69 74 68 20 73 75 62 6a 65 63  tion with subjec
09d0: 74 20 77 68 6f 20 61 74 20 74 65 6e 73 65 20 65  t who at tense e
09e0: 6c 73 65 20 54 72 75 65 2e 0a 20 20 20 20 20 20  lse True..      
09f0: 20 20 45 78 63 65 70 74 69 6f 6e 20 56 61 6c 75    Exception Valu
0a00: 65 45 72 72 6f 72 20 69 73 20 72 61 69 73 65 64  eError is raised
0a10: 20 69 66 20 66 61 69 6c 65 64 20 74 6f 20 72 65   if failed to re
0a20: 74 72 69 65 76 65 20 69 6e 66 6f 72 6d 61 74 69  trieve informati
0a30: 6f 6e 2e 0a 0a 20 20 20 20 2e 56 65 72 62 0a 20  on...    .Verb. 
0a40: 20 20 20 20 20 20 20 2e 5f 5f 69 6e 69 74 5f 5f         .__init__
0a50: 28 76 65 72 62 29 0a 0a 20 20 20 20 20 20 20 20  (verb)..        
0a60: 2e 64 43 6f 6e 6a 0a 20 20 20 20 20 20 20 20 20  .dConj.         
0a70: 20 20 20 41 74 74 72 69 62 75 74 65 2e 20 44 69     Attribute. Di
0a80: 63 74 69 6f 6e 61 72 79 20 6f 66 20 61 6c 6c 20  ctionary of all 
0a90: 63 6f 6e 6a 75 67 61 74 69 6f 6e 73 2e 0a 0a 20  conjugations... 
0aa0: 20 20 20 20 20 20 20 2e 73 49 6e 66 6f 0a 20 20         .sInfo.  
0ab0: 20 20 20 20 20 20 20 20 20 20 41 74 74 72 69 62            Attrib
0ac0: 75 74 65 2e 20 52 65 61 64 61 62 6c 65 20 69 6e  ute. Readable in
0ad0: 66 6f 72 6d 61 74 69 6f 6e 73 20 61 62 6f 75 74  formations about
0ae0: 20 74 68 65 20 76 65 72 62 2e 0a 0a 20 20 20 20   the verb...    
0af0: 20 20 20 20 2e 69 6e 66 69 6e 69 74 69 66 28 62      .infinitif(b
0b00: 50 72 6f 2c 20 62 4e 65 67 2c 20 62 54 70 73 43  Pro, bNeg, bTpsC
0b10: 6f 2c 20 62 49 6e 74 2c 20 62 46 65 6d 29 0a 0a  o, bInt, bFem)..
0b20: 20 20 20 20 20 20 20 20 2e 70 61 72 74 69 63 69          .partici
0b30: 70 65 50 61 73 73 65 28 73 57 68 6f 29 0a 0a 20  pePasse(sWho).. 
0b40: 20 20 20 20 20 20 20 2e 70 61 72 74 69 63 69 70         .particip
0b50: 65 50 72 65 73 65 6e 74 28 62 50 72 6f 2c 20 62  ePresent(bPro, b
0b60: 4e 65 67 2c 20 62 54 70 73 43 6f 2c 20 62 49 6e  Neg, bTpsCo, bIn
0b70: 74 2c 20 62 46 65 6d 29 0a 0a 20 20 20 20 20 20  t, bFem)..      
0b80: 20 20 2e 63 6f 6e 6a 75 67 75 65 28 73 54 65 6d    .conjugue(sTem
0b90: 70 73 2c 20 73 57 68 6f 2c 20 62 50 72 6f 2c 20  ps, sWho, bPro, 
0ba0: 62 4e 65 67 2c 20 62 54 70 73 43 6f 2c 20 62 49  bNeg, bTpsCo, bI
0bb0: 6e 74 2c 20 62 46 65 6d 29 0a 0a 20 20 20 20 20  nt, bFem)..     
0bc0: 20 20 20 2e 69 6d 70 65 72 61 74 69 66 28 73 57     .imperatif(sW
0bd0: 68 6f 2c 20 62 50 72 6f 2c 20 62 4e 65 67 2c 20  ho, bPro, bNeg, 
0be0: 62 54 70 73 43 6f 2c 20 62 46 65 6d 29 0a        bTpsCo, bFem).