Class URI

Interface to RFC3986 Universal Resource Indicator.

class URI( [path], [decode] )

more...

Summary

initInterface to RFC3986 Universal Resource Indicator.
fragmentFragment string in the uri (following path and query after a '#')
hostHost specificator
pathPath specificator
portOptional port specificator (following the host after a ':')
queryQuery string in the URI
schemeURI scheme
uriComplete URI
userInfoUser, password or account specification preceding '\@' host
decode()Decode a string to from URL encoding (static).
encode()Encode a string to URL encoding (static).
getFields()Returns fields contained in the query element into a dictionary.
setFields()Sets query fields for this uri.

Detailed description

Interface to RFC3986 Universal Resource Indicator.

This class offers an object oriented interface to access URI elements.

Setting the properties in this class immediately reflects on the related fields; for example setting the value of the uri property causes a complete re-parse of the item; setting a field as the query string will cause the uri to change.

Each update is subject to RFC3986 compliance checks, and will raise a ParseError if conformance of the URI object is broken.

Init Block

Interface to RFC3986 Universal Resource Indicator.

init URI( [path], [decode] )

pathThe URI that will be used as initial data.
decodeTrue if the path is URI encoded, and must be decoded (default).
Raises:
ParamErrorin case the inital URI is malformed.

This class offers an object oriented interface to access URI elements.

Setting the properties in this class immediately reflects on the related fields; for example setting the value of the uri property causes a complete re-parse of the item; setting a field as the query string will cause the uri to change.

Each update is subject to RFC3986 compliance checks, and will raise a ParseError if conformance of the URI object is broken.

Properties

fragment

Fragment string in the uri (following path and query after a '#')

host

Host specificator

path

Path specificator

port

Optional port specificator (following the host after a ':')

query

Query string in the URI

scheme

URI scheme

uri

Complete URI

userInfo

User, password or account specification preceding '\@' host

Methods

decode()

Decode a string to from URL encoding (static).

URI.decode( enc_string )

enc_stringThe URI/URL encoded string.
Returns:The decoded string.
Raises:
ParamErrorif the string is not a valid URI/URL encoded string.

encode()

Encode a string to URL encoding (static).

URI.encode( string )

stringThe string to be encoded.
Returns:the URL/URI encoded string.

getFields()

Returns fields contained in the query element into a dictionary.

URI.getFields( )

Returns:The fields as a dictionary of nil if the query part contains no element.
Raises:
ParamErrorif the string is not a valid URI/URL encoded string.

setFields()

Sets query fields for this uri.

URI.setFields( fields )

fieldsA dictionary of fields or nil to clear the query.
Raises:
ParamErrorif the input dictionary contains non-string values.

Made with faldoc 2.1.0