innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Fixed #18718 - Documented django.utils.encoding.filepath_to_uri

This commit is contained in:
Tim Graham 2012-12-16 14:34:41 -05:00
parent bf14aed3cc
commit 507c081484
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
django/utils/encoding.py
View File

@ -216,7 +216,7 @@ def iri_to_uri(iri):
return quote(force_bytes(iri), safe=b"/#%[]=:;$&()+,!?*@'~") return quote(force_bytes(iri), safe=b"/#%[]=:;$&()+,!?*@'~")
def filepath_to_uri(path): def filepath_to_uri(path):
"""Convert an file system path to a URI portion that is suitable for """Convert a file system path to a URI portion that is suitable for
inclusion in a URL. inclusion in a URL.
We are assuming input is either UTF-8 or unicode already. We are assuming input is either UTF-8 or unicode already.

12
docs/ref/utils.txt
View File

@ -305,6 +305,18 @@ The functions defined in this module share the following properties:
Returns an ASCII string containing the encoded result. Returns an ASCII string containing the encoded result.
.. function:: filepath_to_uri(path)
Convert a file system path to a URI portion that is suitable for inclusion
in a URL. The path is assumed to be either UTF-8 or unicode.
This method will encode certain characters that would normally be
recognized as special characters for URIs. Note that this method does not
encode the ' character, as it is a valid character within URIs. See
``encodeURIComponent()`` JavaScript function for more details.
Returns an ASCII string containing the encoded result.
``django.utils.feedgenerator`` ``django.utils.feedgenerator``
============================== ==============================