diff Doc/lib/liburlparse.tex @ 20996:f0b575d6feaa legacy-trunk

Document the urlsplit() and urlunsplit() functions.
author Fred Drake <fdrake@acm.org>
date Fri, 16 Nov 2001 03:22:15 +0000
parents 346dcafc878b
children 4a92c7d9d415
line wrap: on
line diff
--- a/Doc/lib/liburlparse.tex	Fri Nov 16 02:52:57 2001 +0000
+++ b/Doc/lib/liburlparse.tex	Fri Nov 16 03:22:15 2001 +0000
@@ -63,6 +63,25 @@
 an empty query (the draft states that these are equivalent).
 \end{funcdesc}
 
+\begin{funcdesc}{urlsplit}{urlstring\optional{,
+                           default_scheme\optional{, allow_fragments}}}
+This is similar to \function{urlparse()}, but does not split the
+params from the URL.  This should generally be used instead of
+\function{urlparse()} if the more recent URL syntax allowing
+parameters to be applied to each segment of the \var{path} portion of
+the URL (see \rfc{2396}).  A separate function is needed to separate
+the path segments and parameters.  This function returns a 5-tuple:
+(addressing scheme, network location, path, query, fragment
+identifier).
+\versionadded{2.2}
+\end{funcdesc}
+
+\begin{funcdesc}{urlunsplit}{tuple}
+Combine the elements of a tuple as returned by \function{urlsplit()}
+into a complete URL as a string.
+\versionadded{2.2}
+\end{funcdesc}
+
 \begin{funcdesc}{urljoin}{base, url\optional{, allow_fragments}}
 Construct a full (``absolute'') URL by combining a ``base URL''
 (\var{base}) with a ``relative URL'' (\var{url}).  Informally, this