home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / python / pyhtmldoc / r / riscospath < prev    next >
Text File  |  1996-11-14  |  5KB  |  99 lines
  1. <TITLE>riscospath -- Python library reference</TITLE>
  2. Next: <A HREF="../s/swi" TYPE="Next">swi</A>  
  3. Prev: <A HREF="../r/riscos" TYPE="Prev">riscos</A>  
  4. Up: <A HREF="../r/riscos_only" TYPE="Up">RISCOS ONLY</A>  
  5. Top: <A HREF="../t/top" TYPE="Top">Top</A>  
  6. <H1>13.2. Standard Module <CODE>riscospath</CODE></H1>
  7. This module implements some useful functions on RiscOS pathnames.
  8. <P>
  9. <B>Do not import this module directly.</B>  Instead, import the
  10. module <CODE>os</CODE> and use <CODE>os.path</CODE>.
  11. <DL><DT><B>basename</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  12. Return the base name of pathname
  13. <VAR>p</VAR>.
  14. This is the second half of the pair returned by
  15. <CODE>riscospath.split(<VAR>p</VAR>)</CODE>.
  16. </DL>
  17. <DL><DT><B>commonprefix</B> (<VAR>list</VAR>) -- function of module riscospath<DD>
  18. Return the longest string that is a prefix of all strings in
  19. <VAR>list</VAR>.
  20. If
  21. <VAR>list</VAR>
  22. is empty, return the empty string (<CODE>''</CODE>).
  23. </DL>
  24. <DL><DT><B>exists</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  25. Return true if
  26. <VAR>p</VAR>
  27. refers to an existing path.
  28. </DL>
  29. <DL><DT><B>expandvars</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  30. Return the argument with environment variables expanded.  Substrings
  31. of the form `<SAMP>$<VAR>name</VAR></SAMP>' or `<SAMP>${<VAR>name</VAR>}</SAMP>' are
  32. replaced by the value of environment variable <VAR>name</VAR>.  Malformed
  33. variable names and references to non-existing variables are left
  34. unchanged.
  35. </DL>
  36. <DL><DT><B>isabs</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  37. Return true if <VAR>p</VAR> is an absolute pathname (has a dollar).
  38. </DL>
  39. <DL><DT><B>isfile</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  40. Return true if <VAR>p</VAR> is an existing file.  This includes image files.
  41. </DL>
  42. <DL><DT><B>isdir</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  43. Return true if <VAR>p</VAR> is an existing directory. This includes image files.
  44. </DL>
  45. <DL><DT><B>islink</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  46. Always returns false.
  47. </DL>
  48. <DL><DT><B>join</B> (<VAR>p</VAR>, <VAR>q</VAR>) -- function of module riscospath<DD>
  49. Join the paths
  50. <VAR>p</VAR>
  51. and
  52. <VAR>q</VAR> intelligently:
  53. If
  54. <VAR>q</VAR>
  55. is an absolute path, the return value is
  56. <VAR>q</VAR>.
  57. Otherwise, the concatenation of
  58. <VAR>p</VAR>
  59. and
  60. <VAR>q</VAR>
  61. is returned, with a full stop (<CODE>'.'</CODE>) inserted unless
  62. <VAR>p</VAR>
  63. is empty or ends in a slash.
  64. </DL>
  65. <DL><DT><B>normcase</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  66. Normalize the case of a pathname.  This converts upper case to
  67. lower case.
  68. </DL>
  69. <DL><DT><B>split</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  70. Split the pathname <VAR>p</VAR> in a pair <CODE>(<VAR>head</VAR>, <VAR>tail</VAR>)</CODE>,
  71. where <VAR>tail</VAR> is the last pathname component and <VAR>head</VAR> is
  72. everything leading up to that.  The <VAR>tail</VAR> part will never contain
  73. a full stop; if <VAR>p</VAR> ends in a full stop, <VAR>tail</VAR> will be empty.  If
  74. there is no full stop in <VAR>p</VAR>, <VAR>head</VAR> will be empty.  If <VAR>p</VAR> is
  75. empty, both <VAR>head</VAR> and <VAR>tail</VAR> are empty.  Trailing full stops are
  76. stripped from <VAR>head</VAR> unless it is the root.
  77. In nearly all cases, <CODE>join(<VAR>head</VAR>, <VAR>tail</VAR>)</CODE>
  78. equals <VAR>p</VAR>.
  79. </DL>
  80. <DL><DT><B>splitext</B> (<VAR>p</VAR>) -- function of module riscospath<DD>
  81. Split the pathname <VAR>p</VAR> in a pair <CODE>(<VAR>root</VAR>, <VAR>ext</VAR>)</CODE>
  82. such that <CODE><VAR>root</VAR> + <VAR>ext</VAR> == <VAR>p</VAR></CODE>,
  83. the last component of <VAR>root</VAR> contains no slashess,
  84. and <VAR>ext</VAR> is empty or begins with a slash.
  85. </DL>
  86. <DL><DT><B>walk</B> (<VAR>p</VAR>, <VAR>visit</VAR>, <VAR>arg</VAR>) -- function of module riscospath<DD>
  87. Calls the function <VAR>visit</VAR> with arguments
  88. <CODE>(<VAR>arg</VAR>, <VAR>dirname</VAR>, <VAR>names</VAR>)</CODE> for each directory in the
  89. directory tree rooted at <VAR>p</VAR> (including <VAR>p</VAR> itself, if it is a
  90. directory).  The argument <VAR>dirname</VAR> specifies the visited directory,
  91. the argument <VAR>names</VAR> lists the files in the directory (gotten from
  92. <CODE>riscos.listdir(<VAR>dirname</VAR>)</CODE>.
  93. The <VAR>visit</VAR> function may modify <VAR>names</VAR> to
  94. influence the set of directories visited below <VAR>dirname</VAR>, e.g., to
  95. avoid visiting certain parts of the tree.  (The object referred to by
  96. <VAR>names</VAR> must be modified in place, using <CODE>del</CODE> or slice
  97. assignment.)
  98. </DL>
  99.