diff options
| author | Tim Graham <timograham@gmail.com> | 2012-12-16 14:34:41 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2012-12-16 14:40:10 -0500 |
| commit | 53b40d75b787b1f76e08aa078de88bae6473a3fc (patch) | |
| tree | 928e220ad9e4f04748fe8e1c5e34105d82de0b5e | |
| parent | 06b5f5fcb6db2fc20e2d455a34f3f4b0293cfd8c (diff) | |
[1.5.X] Fixed #18718 - Documented django.utils.encoding.filepath_to_uri
Backport of 507c081484 from master
| -rw-r--r-- | django/utils/encoding.py | 2 | ||||
| -rw-r--r-- | docs/ref/utils.txt | 12 |
2 files changed, 13 insertions, 1 deletions
diff --git a/django/utils/encoding.py b/django/utils/encoding.py index b0872471c2..15215849b2 100644 --- a/django/utils/encoding.py +++ b/django/utils/encoding.py @@ -216,7 +216,7 @@ def iri_to_uri(iri): return quote(force_bytes(iri), safe=b"/#%[]=:;$&()+,!?*@'~") 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. We are assuming input is either UTF-8 or unicode already. diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index bd3898172a..2f12c3a96c 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -305,6 +305,18 @@ The functions defined in this module share the following properties: 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`` ============================== |