Hex Artifact Content

Artifact c37be4c149fa257724830e6129a8fcbe9365154b8a0cdeff3b4d14d88cb9f555:

Wiki page [Usage] by gwlester 2018-02-05 21:13:36.
0000: 44 20 32 30 31 38 2d 30 32 2d 30 35 54 32 31 3a  D 2018-02-05T21:
0010: 31 33 3a 33 36 2e 30 31 31 0a 4c 20 55 73 61 67  13:36.011.L Usag
0020: 65 0a 50 20 36 34 62 62 36 37 36 37 31 35 38 37  e.P 64bb67671587
0030: 62 30 39 32 33 61 37 61 33 31 64 66 66 61 31 34  b0923a7a31dffa14
0040: 63 30 38 65 38 39 39 66 34 39 31 62 63 62 36 36  c08e899f491bcb66
0050: 62 34 31 35 61 30 62 39 32 39 30 38 35 33 65 38  b415a0b9290853e8
0060: 62 34 30 31 0a 55 20 67 77 6c 65 73 74 65 72 0a  b401.U gwlester.
0070: 57 20 33 30 34 38 0a 3c 68 31 3e 55 73 61 67 65  W 3048.<h1>Usage
0080: 3c 2f 68 31 3e 0a 0a 3c 68 32 3e 70 61 63 6b 61  </h1>..<h2>packa
0090: 67 65 20 72 65 71 75 69 72 65 20 70 79 6d 61 6e  ge require pyman
00a0: 3c 2f 68 32 3e 0a 0a 3c 68 32 3e 3c 62 72 3e 0a  </h2>..<h2><br>.
00b0: 3c 2f 68 32 3e 0a 0a 3c 68 32 3e 70 79 6d 61 6e  </h2>..<h2>pyman
00c0: 26 6e 62 73 70 3b 61 64 64 50 61 74 68 20 3c 69  &nbsp;addPath <i
00d0: 3e 70 61 74 68 4e 61 6d 65 3c 2f 69 3e 3c 2f 68  >pathName</i></h
00e0: 32 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 20  2>..<blockquote 
00f0: 73 74 79 6c 65 3d 22 6d 61 72 67 69 6e 3a 20 30  style="margin: 0
0100: 20 30 20 30 20 34 30 70 78 3b 20 62 6f 72 64 65   0 0 40px; borde
0110: 72 3a 20 6e 6f 6e 65 3b 20 70 61 64 64 69 6e 67  r: none; padding
0120: 3a 20 30 70 78 3b 22 3e 0a 0a 3c 64 69 76 3e 0a  : 0px;">..<div>.
0130: 0a 3c 73 70 61 6e 20 73 74 79 6c 65 3d 22 66 6f  .<span style="fo
0140: 6e 74 2d 73 69 7a 65 3a 20 31 33 2e 33 33 33 33  nt-size: 13.3333
0150: 70 78 3b 22 3e 54 68 69 73 20 77 69 6c 6c 20 61  px;">This will a
0160: 64 64 20 3c 69 3e 3c 62 3e 70 61 74 68 4e 61 6d  dd <i><b>pathNam
0170: 65 3c 2f 62 3e 3c 2f 69 3e 26 6e 62 73 70 3b 74  e</b></i>&nbsp;t
0180: 6f 0a 74 68 65 20 6c 69 73 74 20 6f 66 20 64 69  o.the list of di
0190: 72 65 63 74 6f 72 69 65 73 20 74 68 61 74 20 50  rectories that P
01a0: 79 74 68 6f 6e 20 73 65 61 72 63 68 65 73 20 66  ython searches f
01b0: 6f 72 20 77 68 65 72 65 20 74 6f 20 66 69 6e 64  or where to find
01c0: 20 50 79 74 68 6f 6e 20 6d 6f 64 75 6c 65 0a 66   Python module.f
01d0: 69 6c 65 73 20 74 6f 20 62 65 20 69 6d 70 6f 72  iles to be impor
01e0: 74 65 64 2e 26 6e 62 73 70 3b 20 54 68 69 73 20  ted.&nbsp; This 
01f0: 69 73 20 72 6f 75 67 68 6c 79 20 61 6b 69 6e 20  is roughly akin 
0200: 74 6f 20 3c 62 3e 6c 61 70 70 65 6e 64 3c 2f 62  to <b>lappend</b
0210: 3e 20 6f 66 20 61 0a 64 69 72 65 63 74 6f 72 79  > of a.directory
0220: 20 74 6f 20 54 63 6c 27 73 20 3c 62 3e 61 75 74   to Tcl's <b>aut
0230: 6f 5f 70 61 74 68 3c 2f 62 3e 20 76 61 72 69 61  o_path</b> varia
0240: 62 6c 65 20 6f 72 20 64 6f 69 6e 67 20 61 20 3a  ble or doing a :
0250: 3a 74 63 6c 3a 3a 74 6d 3a 3a 70 61 74 68 20 61  :tcl::tm::path a
0260: 64 64 20 74 6f 0a 61 64 64 20 61 20 64 69 72 65  dd to.add a dire
0270: 63 74 6f 72 79 20 74 6f 20 74 68 65 20 64 69 72  ctory to the dir
0280: 65 63 74 6f 72 69 65 73 20 73 65 61 72 63 68 65  ectories searche
0290: 64 20 66 6f 72 20 6d 6f 64 75 6c 65 20 66 69 6c  d for module fil
02a0: 65 73 2e 3c 2f 73 70 61 6e 3e 3c 69 3e 3c 62 72  es.</span><i><br
02b0: 3e 0a 3c 2f 69 3e 3c 2f 64 69 76 3e 3c 2f 62 6c  >.</i></div></bl
02c0: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 68 32 3e 3c  ockquote>..<h2><
02d0: 62 72 3e 0a 3c 2f 68 32 3e 0a 0a 3c 68 32 3e 70  br>.</h2>..<h2>p
02e0: 79 6d 61 6e 20 69 6d 70 6f 72 74 20 3c 69 3e 3f  yman import <i>?
02f0: 2d 6e 61 6d 65 73 70 61 63 65 20 6e 73 4e 61 6d  -namespace nsNam
0300: 65 3f 3c 2f 69 3e 20 3c 69 3e 70 79 74 68 6f 6e  e?</i> <i>python
0310: 4d 6f 64 75 6c 65 46 69 6c 65 4e 61 6d 65 3c 2f  ModuleFileName</
0320: 69 3e 3c 2f 68 32 3e 0a 0a 3c 62 6c 6f 63 6b 71  i></h2>..<blockq
0330: 75 6f 74 65 20 73 74 79 6c 65 3d 22 6d 61 72 67  uote style="marg
0340: 69 6e 3a 20 30 20 30 20 30 20 34 30 70 78 3b 20  in: 0 0 0 40px; 
0350: 62 6f 72 64 65 72 3a 20 6e 6f 6e 65 3b 20 70 61  border: none; pa
0360: 64 64 69 6e 67 3a 20 30 70 78 3b 22 3e 0a 0a 3c  dding: 0px;">..<
0370: 64 69 76 3e 54 68 69 73 20 77 69 6c 6c 20 69 6d  div>This will im
0380: 70 6f 72 74 20 74 68 65 20 50 79 74 68 6f 6e 20  port the Python 
0390: 6d 6f 64 75 6c 65 20 61 6e 64 20 61 6e 61 6c 69  module and anali
03a0: 7a 65 20 74 68 65 20 6d 6f 64 75 6c 65 20 75 73  ze the module us
03b0: 69 6e 67 20 74 68 65 20 50 79 74 68 6f 6e 0a 69  ing the Python.i
03c0: 6e 74 72 6f 73 70 65 63 74 69 6f 6e 20 74 6f 6f  ntrospection too
03d0: 6c 73 2e 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e  ls. The followin
03e0: 67 20 77 69 6c 6c 20 62 65 20 64 6f 6e 65 3a 3c  g will be done:<
03f0: 2f 64 69 76 3e 0a 0a 3c 64 69 76 3e 0a 3c 6f 6c  /div>..<div>.<ol
0400: 3e 0a 3c 6c 69 3e 41 20 6e 61 6d 65 73 70 61 63  >.<li>A namespac
0410: 65 20 74 6f 20 63 6f 6e 74 61 69 6c 20 74 68 65  e to contail the
0420: 20 54 63 6c 20 66 75 6e 63 74 69 6f 6e 73 20 61   Tcl functions a
0430: 6e 64 20 63 6c 61 73 73 20 77 72 61 70 65 72 73  nd class wrapers
0440: 20 66 6f 72 20 74 68 65 0a 66 75 6e 63 74 69 6f   for the.functio
0450: 6e 73 20 61 6e 64 20 63 6c 61 73 73 20 77 69 6c  ns and class wil
0460: 6c 20 62 65 20 63 72 65 61 74 65 64 2e 26 6e 62  l be created.&nb
0470: 73 70 3b 20 49 66 20 74 68 65 20 3c 62 3e 2d 6e  sp; If the <b>-n
0480: 61 6d 65 73 61 70 63 65 3c 2f 62 3e 26 6e 62 73  amesapce</b>&nbs
0490: 70 3b 6f 70 74 69 6f 6e 0a 77 61 73 20 70 72 65  p;option.was pre
04a0: 73 65 6e 74 20 74 68 61 6e 20 69 74 73 20 76 61  sent than its va
04b0: 6c 75 65 2c 20 3c 69 3e 6e 73 4e 61 6d 65 3c 2f  lue, <i>nsName</
04c0: 69 3e 2c 20 77 69 6c 6c 20 62 65 20 75 73 65 64  i>, will be used
04d0: 2e 26 6e 62 73 70 3b 20 4f 74 68 65 72 77 69 73  .&nbsp; Otherwis
04e0: 65 20 74 68 65 0a 6e 61 6d 65 73 70 61 63 65 20  e the.namespace 
04f0: 77 69 6c 6c 20 62 65 20 6e 61 6d 65 64 20 3c 62  will be named <b
0500: 3e 3a 3a 70 79 6d 61 6e 3a 3a 3c 2f 62 3e 3c 69  >::pyman::</b><i
0510: 20 73 74 79 6c 65 3d 22 66 6f 6e 74 2d 77 65 69   style="font-wei
0520: 67 68 74 3a 20 62 6f 6c 64 3b 22 3e 70 79 74 68  ght: bold;">pyth
0530: 6f 6e 4d 6f 64 75 6c 65 4e 61 6d 65 3c 2f 69 3e  onModuleName</i>
0540: 26 6e 62 73 70 3b 77 68 65 72 65 0a 3c 69 3e 70  &nbsp;where.<i>p
0550: 79 74 68 6f 6e 4d 6f 64 75 6c 65 4e 61 6d 65 3c  ythonModuleName<
0560: 2f 69 3e 26 6e 62 73 70 3b 69 73 20 74 68 65 20  /i>&nbsp;is the 
0570: 6e 61 6d 65 20 6f 66 20 74 68 65 20 50 79 74 68  name of the Pyth
0580: 6f 6e 20 6d 6f 64 75 6c 65 20 74 68 61 74 20 77  on module that w
0590: 61 73 0a 69 6d 70 6f 72 74 65 64 2e 3c 2f 6c 69  as.imported.</li
05a0: 3e 0a 3c 6c 69 3e 46 6f 72 20 65 61 63 68 20 66  >.<li>For each f
05b0: 75 6e 63 74 69 6f 6e 20 66 6f 75 6e 64 20 69 6e  unction found in
05c0: 20 74 68 65 20 6d 6f 64 75 6c 65 2c 20 61 20 54   the module, a T
05d0: 63 6c 20 77 72 61 70 70 65 72 20 66 75 6e 63 74  cl wrapper funct
05e0: 69 6f 6e 20 77 69 6c 6c 20 62 65 0a 67 65 6e 65  ion will be.gene
05f0: 72 61 74 65 64 20 74 68 61 74 20 74 61 6b 65 20  rated that take 
0600: 74 68 65 20 73 61 6d 65 20 61 72 67 75 6d 65 6e  the same argumen
0610: 74 73 20 61 6e 64 20 77 69 6c 6c 20 63 61 6c 6c  ts and will call
0620: 20 74 68 65 20 50 79 74 68 6f 6e 20 66 75 6e 63   the Python func
0630: 74 69 6f 6e 20 61 6e 64 0a 72 65 74 75 72 6e 20  tion and.return 
0640: 69 74 73 20 72 65 73 75 6c 74 73 2e 3c 2f 6c 69  its results.</li
0650: 3e 0a 3c 6c 69 3e 46 6f 72 20 65 61 63 68 20 63  >.<li>For each c
0660: 6c 61 73 73 26 6e 62 73 70 3b 20 66 6f 75 6e 64  lass&nbsp; found
0670: 20 69 6e 20 74 68 65 20 6d 6f 64 75 6c 65 2c 20   in the module, 
0680: 61 20 54 63 6c 4f 4f 20 77 72 61 70 70 65 72 20  a TclOO wrapper 
0690: 63 6c 61 73 73 20 77 69 6c 6c 20 62 65 0a 67 65  class will be.ge
06a0: 6e 65 72 61 74 65 64 2e 26 6e 62 73 70 3b 20 54  nerated.&nbsp; T
06b0: 68 69 73 20 63 6c 61 73 73 20 77 69 6c 6c 20 68  his class will h
06c0: 61 76 65 20 74 68 65 20 73 61 6d 65 20 6d 65 74  ave the same met
06d0: 68 6f 64 73 20 77 69 74 68 20 74 68 65 20 73 61  hods with the sa
06e0: 6d 65 20 61 72 67 75 6d 65 6e 74 73 0a 61 73 20  me arguments.as 
06f0: 74 68 65 20 70 75 62 6c 69 63 20 6d 65 74 68 6f  the public metho
0700: 64 73 20 69 6e 20 74 68 65 20 50 79 74 68 6f 6e  ds in the Python
0710: 20 63 6c 61 73 73 2e 26 6e 62 73 70 3b 26 6e 62   class.&nbsp;&nb
0720: 73 70 3b 3c 2f 6c 69 3e 0a 3c 6c 69 3e 43 72 65  sp;</li>.<li>Cre
0730: 61 74 69 6f 6e 20 6f 66 20 61 20 6e 65 77 20 54  ation of a new T
0740: 63 6c 4f 4f 20 6f 62 6a 65 63 74 20 6f 66 20 74  clOO object of t
0750: 68 69 73 20 63 6c 61 73 73 20 77 69 6c 6c 20 72  his class will r
0760: 65 73 75 6c 74 20 69 6e 20 61 20 50 79 74 68 6f  esult in a Pytho
0770: 6e 20 6f 62 6a 65 63 74 0a 6f 66 20 74 68 65 20  n object.of the 
0780: 73 61 6d 65 20 63 6c 61 73 73 20 62 65 69 6e 67  same class being
0790: 20 63 72 65 61 74 65 64 2e 26 6e 62 73 70 3b 26   created.&nbsp;&
07a0: 6e 62 73 70 3b 3c 2f 6c 69 3e 0a 3c 75 6c 3e 0a  nbsp;</li>.<ul>.
07b0: 3c 6c 69 3e 3c 75 3e 3c 66 6f 6e 74 20 63 6f 6c  <li><u><font col
07c0: 6f 72 3d 22 23 66 66 30 30 30 30 22 3e 28 4e 6f  or="#ff0000">(No
07d0: 74 20 79 65 74 20 69 6d 70 6c 65 6d 65 6e 74 65  t yet implemente
07e0: 64 29 20 43 61 6c 6c 73 20 74 6f 20 63 6c 61 73  d) Calls to clas
07f0: 73 20 6d 65 74 68 6f 64 73 20 6f 66 0a 74 68 65  s methods of.the
0800: 20 63 6c 61 73 73 20 77 69 6c 6c 20 63 61 6c 6c   class will call
0810: 20 73 74 61 74 69 63 20 6d 65 74 68 6f 64 73 20   static methods 
0820: 6f 66 20 74 68 65 20 50 79 74 68 6f 6e 20 63 6c  of the Python cl
0830: 61 73 73 2e 3c 2f 66 6f 6e 74 3e 3c 2f 75 3e 3c  ass.</font></u><
0840: 2f 6c 69 3e 0a 3c 6c 69 3e 43 61 6c 6c 73 20 74  /li>.<li>Calls t
0850: 6f 20 69 6e 73 74 61 6e 63 65 20 6d 65 74 68 6f  o instance metho
0860: 64 73 20 6f 66 20 74 68 65 20 63 6c 61 73 73 20  ds of the class 
0870: 77 69 6c 6c 20 63 61 6c 6c 20 69 6e 73 74 61 6e  will call instan
0880: 63 65 20 6d 65 74 68 6f 64 73 20 6f 66 20 74 68  ce methods of th
0890: 65 0a 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20  e.corresponding 
08a0: 50 79 74 68 6f 6e 20 6f 62 6a 65 63 74 20 69 6e  Python object in
08b0: 73 74 61 6e 63 65 73 2e 3c 2f 6c 69 3e 0a 3c 6c  stances.</li>.<l
08c0: 69 3e 49 6e 73 74 61 6e 63 65 20 61 74 74 72 69  i>Instance attri
08d0: 62 75 74 65 73 20 63 61 6e 20 62 65 20 61 63 63  butes can be acc
08e0: 65 73 73 65 64 20 76 69 61 20 74 68 65 20 66 6f  essed via the fo
08f0: 6c 6c 6f 77 69 6e 67 20 73 70 65 63 69 61 6c 20  llowing special 
0900: 6d 65 74 68 6f 64 73 3a 3c 2f 6c 69 3e 0a 3c 75  methods:</li>.<u
0910: 6c 3e 0a 3c 6c 69 3e 3c 62 3e 5f 61 74 74 72 69  l>.<li><b>_attri
0920: 62 75 74 65 73 20 3c 69 3e 3f 70 61 74 74 65 72  butes <i>?patter
0930: 6e 3f 3c 2f 69 3e 3c 2f 62 3e 20 2d 2d 20 47 65  n?</i></b> -- Ge
0940: 74 20 61 20 6c 69 73 74 20 6f 66 20 61 74 74 72  t a list of attr
0950: 69 62 75 74 65 73 20 74 68 61 74 20 6d 61 74 63  ibutes that matc
0960: 68 0a 74 68 65 20 67 6c 6f 62 20 73 74 79 6c 65  h.the glob style
0970: 26 6e 62 73 70 3b 3c 69 20 73 74 79 6c 65 3d 22  &nbsp;<i style="
0980: 22 3e 3c 62 3e 70 61 74 74 65 72 6e 3c 2f 62 3e  "><b>pattern</b>
0990: 26 6e 62 73 70 3b 3c 2f 69 3e 61 6e 64 20 74 68  &nbsp;</i>and th
09a0: 65 69 72 20 61 6c 6c 6f 77 65 64 0a 76 61 6c 75  eir allowed.valu
09b0: 65 73 2e 26 6e 62 73 70 3b 20 26 6e 62 73 70 3b  es.&nbsp; &nbsp;
09c0: 54 68 65 20 64 65 66 61 75 6c 74 20 66 6f 72 20  The default for 
09d0: 3c 69 20 73 74 79 6c 65 3d 22 66 6f 6e 74 2d 77  <i style="font-w
09e0: 65 69 67 68 74 3a 20 62 6f 6c 64 3b 22 3e 70 61  eight: bold;">pa
09f0: 74 74 65 72 6e 3c 2f 69 3e 26 6e 62 73 70 3b 69  ttern</i>&nbsp;i
0a00: 73 0a 22 3c 62 3e 2a 3c 2f 62 3e 22 2e 3c 2f 6c  s."<b>*</b>".</l
0a10: 69 3e 0a 3c 6c 69 3e 3c 62 3e 5f 67 65 74 41 74  i>.<li><b>_getAt
0a20: 74 72 69 62 75 74 65 3c 2f 62 3e 20 3c 62 3e 3c  tribute</b> <b><
0a30: 69 3e 61 74 74 72 69 62 75 74 65 4e 61 6d 65 3c  i>attributeName<
0a40: 2f 69 3e 3c 2f 62 3e 20 2d 2d 20 52 65 74 75 72  /i></b> -- Retur
0a50: 6e 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74  n the value of t
0a60: 68 65 0a 6e 61 6d 65 64 20 61 74 74 72 69 62 75  he.named attribu
0a70: 74 65 2e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e  te.</li>.<li><b>
0a80: 5f 73 65 74 41 74 74 72 69 62 75 74 65 3c 2f 62  _setAttribute</b
0a90: 3e 20 3c 62 3e 3c 69 3e 61 74 74 72 69 62 75 74  > <b><i>attribut
0aa0: 65 4e 61 6d 65 20 76 61 6c 75 65 3c 2f 69 3e 3c  eName value</i><
0ab0: 2f 62 3e 20 2d 2d 20 53 65 74 20 74 68 65 20 6e  /b> -- Set the n
0ac0: 61 6d 65 64 0a 61 74 74 72 69 62 75 74 65 20 74  amed.attribute t
0ad0: 6f 20 74 68 65 20 73 70 65 63 69 66 69 65 64 20  o the specified 
0ae0: 76 61 6c 75 65 2e 20 28 4e 6f 74 65 3a 20 6e 6f  value. (Note: no
0af0: 74 20 61 6c 6c 20 61 74 74 72 69 62 75 74 65 73  t all attributes
0b00: 20 63 61 6e 20 62 65 20 6d 6f 64 69 66 69 65 64   can be modified
0b10: 29 2e 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 0a 3c 6c  ).</li>.</ul>.<l
0b20: 69 3e 54 68 65 20 54 63 6c 20 70 72 6f 67 72 61  i>The Tcl progra
0b30: 6d 6d 65 72 20 69 73 20 61 6c 6c 6f 77 65 64 20  mmer is allowed 
0b40: 74 6f 20 61 64 64 20 61 64 64 69 74 69 6f 6e 61  to add additiona
0b50: 6c 20 6d 65 74 68 6f 64 73 20 61 6e 64 2f 0a 0a  l methods and/..
0b60: 3c 73 70 61 6e 20 73 74 79 6c 65 3d 22 66 6f 6e  <span style="fon
0b70: 74 2d 73 69 7a 65 3a 20 31 33 2e 33 33 33 33 70  t-size: 13.3333p
0b80: 78 3b 22 3e 6f 72 20 76 61 72 69 61 62 6c 65 73  x;">or variables
0b90: 26 6e 62 73 70 3b 3c 2f 73 70 61 6e 3e 74 6f 20  &nbsp;</span>to 
0ba0: 74 68 65 26 6e 62 73 70 3b 0a 0a 3c 73 70 61 6e  the&nbsp;..<span
0bb0: 20 73 74 79 6c 65 3d 22 66 6f 6e 74 2d 73 69 7a   style="font-siz
0bc0: 65 3a 20 31 33 2e 33 33 33 33 70 78 3b 22 3e 54  e: 13.3333px;">T
0bd0: 63 6c 4f 4f 3c 2f 73 70 61 6e 3e 26 6e 62 73 70  clOO</span>&nbsp
0be0: 3b 63 6c 61 73 73 20 61 6e 64 2f 6f 72 20 69 6e  ;class and/or in
0bf0: 73 74 61 6e 63 65 73 20 6f 66 0a 74 68 65 20 63  stances of.the c
0c00: 6c 61 73 73 2c 20 74 68 65 73 65 20 77 69 6c 6c  lass, these will
0c10: 20 6f 6e 6c 79 20 62 65 20 76 69 73 62 6c 65 20   only be visble 
0c20: 66 72 6f 6d 20 54 63 6c 2e 3c 62 72 3e 0a 3c 2f  from Tcl.<br>.</
0c30: 6c 69 3e 0a 3c 2f 75 6c 3e 0a 3c 2f 6f 6c 3e 3c  li>.</ul>.</ol><
0c40: 2f 64 69 76 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /div></blockquot
0c50: 65 3e 0a 3c 70 72 65 3e 3c 2f 70 72 65 3e 0a 0a  e>.<pre></pre>..
0c60: 5a 20 33 64 30 62 35 35 61 39 35 39 30 32 30 38  Z 3d0b55a9590208
0c70: 37 63 66 36 34 30 38 33 36 35 65 62 33 33 30 66  7cf6408365eb330f
0c80: 62 34 0a                                         b4.