Commit 53b40d75 authored by Tim Graham's avatar Tim Graham
Browse files

[1.5.X] Fixed #18718 - Documented django.utils.encoding.filepath_to_uri 

Backport of 507c0814 from master
parent 06b5f5fc

django/utils/encoding.py

+1 −1
Original line number Diff line number Diff line
@@ -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.

docs/ref/utils.txt

+12 −0
Original line number Diff line number Diff line
@@ -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``

==============================