[Python-checkins] commit of r41817 - in python/branches/release24-maint/Lib: macurl2path.py nturl2path.py plat-riscos/rourl2path.py urllib.py

Mon Dec 26 23:54:02 CET 2005

Author: reinhold.birkenfeld
Date: Mon Dec 26 23:54:01 2005
New Revision: 41817
Modified:
 python/branches/release24-maint/Lib/macurl2path.py
 python/branches/release24-maint/Lib/nturl2path.py
 python/branches/release24-maint/Lib/plat-riscos/rourl2path.py
 python/branches/release24-maint/Lib/urllib.py
Log:
Bug #649974 (backport): make docstrings for url2pathname consistent
Modified: python/branches/release24-maint/Lib/macurl2path.py
==============================================================================

--- python/branches/release24-maint/Lib/macurl2path.py	(original)
+++ python/branches/release24-maint/Lib/macurl2path.py	Mon Dec 26 23:54:01 2005
@@ -8,7 +8,8 @@
 __all__ = ["url2pathname","pathname2url"]
 
 def url2pathname(pathname):
- "Convert /-delimited pathname to mac pathname"
+ """OS-specific conversion from a relative URL of the 'file' scheme
+ to a file system path; not recommended for general use."""
 #
 # XXXX The .. handling should be fixed...
 #
@@ -49,7 +50,8 @@
 return urllib.unquote(rv)
 
 def pathname2url(pathname):
- "convert mac pathname to /-delimited pathname"
+ """OS-specific conversion from a file system path to a relative URL
+ of the 'file' scheme; not recommended for general use."""
 if '/' in pathname:
 raise RuntimeError, "Cannot convert pathname containing slashes"
 components = pathname.split(':')
Modified: python/branches/release24-maint/Lib/nturl2path.py
==============================================================================
--- python/branches/release24-maint/Lib/nturl2path.py	(original)
+++ python/branches/release24-maint/Lib/nturl2path.py	Mon Dec 26 23:54:01 2005
@@ -1,14 +1,12 @@
 """Convert a NT pathname to a file URL and vice versa."""
 
 def url2pathname(url):
- r"""Convert a URL to a DOS path.
-
- ///C|/foo/bar/spam.foo
-
- becomes
-
- C:\foo\bar\spam.foo
- """
+ """OS-specific conversion from a relative URL of the 'file' scheme
+ to a file system path; not recommended for general use."""
+ # e.g.
+ # ///C|/foo/bar/spam.foo
+ # becomes
+ # C:\foo\bar\spam.foo
 import string, urllib
 # Windows itself uses ":" even in URLs.
 url = url.replace(':', '|')
@@ -35,15 +33,12 @@
 return path
 
 def pathname2url(p):
- r"""Convert a DOS path name to a file url.
-
- C:\foo\bar\spam.foo
-
- becomes
-
- ///C|/foo/bar/spam.foo
- """
-
+ """OS-specific conversion from a file system path to a relative URL
+ of the 'file' scheme; not recommended for general use."""
+ # e.g.
+ # C:\foo\bar\spam.foo
+ # becomes
+ # ///C|/foo/bar/spam.foo
 import urllib
 if not ':' in p:
 # No drive specifier, just convert slashes and quote the name
Modified: python/branches/release24-maint/Lib/plat-riscos/rourl2path.py
==============================================================================
--- python/branches/release24-maint/Lib/plat-riscos/rourl2path.py	(original)
+++ python/branches/release24-maint/Lib/plat-riscos/rourl2path.py	Mon Dec 26 23:54:01 2005
@@ -11,7 +11,8 @@
 __slash_dot = string.maketrans("/.", "./")
 
 def url2pathname(url):
- "Convert URL to a RISC OS path."
+ """OS-specific conversion from a relative URL of the 'file' scheme
+ to a file system path; not recommended for general use."""
 tp = urllib.splittype(url)[0]
 if tp and tp <> 'file':
 raise RuntimeError, 'Cannot convert non-local URL to pathname'
@@ -46,7 +47,8 @@
 return '.'.join(components)
 
 def pathname2url(pathname):
- "Convert a RISC OS path name to a file url."
+ """OS-specific conversion from a file system path to a relative URL
+ of the 'file' scheme; not recommended for general use."""
 return urllib.quote('///' + pathname.translate(__slash_dot), "/$:")
 
 def test():
Modified: python/branches/release24-maint/Lib/urllib.py
==============================================================================
--- python/branches/release24-maint/Lib/urllib.py	(original)
+++ python/branches/release24-maint/Lib/urllib.py	Mon Dec 26 23:54:01 2005
@@ -50,8 +50,13 @@
 from rourl2path import url2pathname, pathname2url
 else:
 def url2pathname(pathname):
+ """OS-specific conversion from a relative URL of the 'file' scheme
+ to a file system path; not recommended for general use."""
 return unquote(pathname)
+
 def pathname2url(pathname):
+ """OS-specific conversion from a file system path to a relative URL
+ of the 'file' scheme; not recommended for general use."""
 return quote(pathname)
 
 # This really consists of two pieces:
