Package elisa :: Package core :: Module media_uri :: Class MediaUri

Class MediaUri

Media URI management

An URI is structured like this:

  scheme://[user:password@]host[:port]/path[/][?params][#fragment]

This class is able to parse that and wrap access to all found attributes. When I'm parsing file:// URIs I'm allowed to replace paths like:

  ./path/to/foo

With the following:

  "%s/path/to/foo" % os.curdir

Instance Methods

__init__(self, data)
Create an Uri from various representations.

source code

path__get(self)

source code

path__set(self, value)

source code

set_params(self, values)
Set a lot of parameters at one time.

source code

set_param(self, name, value)
Set the parameter 'name' to 'value'.

source code

unquoted Unicode

get_param(self, name, default=u'')
Get the value for the parameter 'name'.

source code

dict or elisa.extern.odict.OrderedDict

get_params(self)
Get all params as a dict or elisa.extern.odict.OrderedDict (depending on what was used to create this MediaUri) source code

unicode

get_params_string(self)
Get the params as a one-line string (excluding a leading '?').

source code

del_param(self, name)
Delete the paramter with the name 'name' (and it's value), if it is found in the list of parameters.

source code

extension__get(self)

source code

filename__get(self)
Return the filename of the Uri.

source code

label__set(self, value)

source code

label__get(self)
Return a displayable string designing the Uri.

source code

parent__get(self)
Return the parent URI.

source code

MediaUri

join(self, path)
Append the given path to my path attribute

source code

unicode

__unicode__(self)
Textual representation of the URI

source code

string

__str__(self)
Byte string representation of the URI

source code

__repr__(self)
repr(x)

source code

int

__cmp__(self, other_uri)
Compare myself with another uri.

source code

__eq__(self, other_uri)

source code

__ne__(self, other_uri)

source code

__nonzero__(self)

source code

__contains__(self, component)

source code

__add__(self, path)

source code

endswith(self, character)

source code

__getslice__(self, i, j)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Instance Variables
string	path = `property(fset= path__set, fget= path__get)` the URI path, delimitted by slashes (/)
unicode	extension = `property(fget= extension__get)` the extension of the uri or empty
unicode	filename = `property(fget= filename__get)` the filename of the uri, means the part behind the last slash.
unicode or `elisa.extern.translator.Translateable`	label = `property(fset= label__set, fget= label__get)` the label for this uri (per default the same as the filename)
MediaUri	parent = `property(fget= parent__get)` the parent uri (means the last part of the path is removed)
string	fragment optional URI fragment
string	host the URI hostname
string	password the optional password
int	port URI optional port.
string	scheme the URI scheme
string	user the optional username

Properties
Inherited from `object`: `__class__`

Method Details

init(self, data)
(Constructor)

source code

Create an Uri from various representations.

Representation can be either a string containing the uri or the components of the uri stored in a dictionary.

Parameters:

data (str or dict) - An uri stored in a unicode string or described by its components (scheme, user, password, host, port, path, params, fragment), each of them being a string The only exception is the params component, which may be either a dict or an elisa.extern.ordic.OrderedDict.

Raises:

TypeError - If none of location or parts has been provided
ParseException - If the location wasn't correctly parsed

Overrides: object.__init__

set_params(self, values)

source code

Set a lot of parameters at one time. Attention: it simply overrides already existing values!

Parameters:

values (dict) - a dict or elisa.extern.odict.OrderedDict, where the parameter names are pointing to the unquoted values.

set_param(self, name, value)

source code

Set the parameter 'name' to 'value'. If this parameter is already existing it is overritten. The value shouldn't be quoted yet, because it is quoted here. That might lead to very bad parameter values!

Parameters:

name (Unicode) - the name of the paramter
value (Unicode) - unquoted value for the parameter

get_param(self, name, default=u'')

source code

Get the value for the parameter 'name'. If there is none found, return the value of 'default'. If 'default' is not set it is an empty unicode.

Parameters:

name (Unicode) - the name of the parameter
default (Unicode) - value that should be returned, if the parameter is not found (per default that is an empty Unicode)

Returns: unquoted Unicode

paramter or the value of default, if the paramter was not found

get_params(self)

source code

Get all params as a dict or elisa.extern.odict.OrderedDict (depending on what was used to create this MediaUri)

Returns: dict or elisa.extern.odict.OrderedDict: All the params as quoted key value pairs

get_params_string(self)

source code

Get the params as a one-line string (excluding a leading '?').

Returns: unicode: key1=value1&key2=value2

del_param(self, name)

source code

Delete the paramter with the name 'name' (and it's value), if it is found in the list of parameters.

Parameters:

name (Unicode) - the name of the paramter to delete

filename__get(self)

source code

Return the filename of the Uri.

Returns last path component label parameter like uri://path/to/foo then 'foo' is returned.

If there is no path, like in uri://host:port/ or in uri:// an empty unicode is returned

label__get(self)

source code

Return a displayable string designing the Uri. Return last path component if the URI has no predetermined label instance attribute set.

parent__get(self)

source code

Return the parent URI.

If the URI is like uri://path/to/foo return uri://path/to/

join(self, path)

source code

Append the given path to my path attribute

Parameters:

path (string) - the path to append at the end of my path

Returns: MediaUri

str(self)
(Informal representation operator)

source code

Byte string representation of the URI

Returns: string
Overrides: object.__str__

repr(self)
(Representation operator)

source code

repr(x)

Overrides: object.__repr__: (inherited documentation)

cmp(self, other_uri)
(Comparison operator)

source code

Compare myself with another uri.

Parameters:

other_uri (MediaUri) - The URI I'm comparing myself with

Returns: int

Raises:

TypeError - When trying to compare with non-MediaUri object

eq(self, other_uri)
(Equality operator)

source code

Raises:

TypeError - When trying to compare with non-MediaUri object

ne(self, other_uri)

source code

Raises:

TypeError - When trying to compare with non-MediaUri object

Instance Variable Details

filename

the filename of the uri, means the part behind the last slash. Could be empty!

Type:: unicode

Value:

property(fget= filename__get)

port

URI optional port. Set to 0 if not found

Type:: int

Class MediaUri

__init__(self, data) (Constructor)

set_params(self, values)

set_param(self, name, value)

get_param(self, name, default=u'')

get_params(self)

get_params_string(self)

del_param(self, name)

filename__get(self)

label__get(self)

parent__get(self)

join(self, path)

__str__(self) (Informal representation operator)

__repr__(self) (Representation operator)

__cmp__(self, other_uri) (Comparison operator)

__eq__(self, other_uri) (Equality operator)

__ne__(self, other_uri)

filename

port

init(self, data)
(Constructor)

str(self)
(Informal representation operator)

repr(self)
(Representation operator)

cmp(self, other_uri)
(Comparison operator)

eq(self, other_uri)
(Equality operator)

ne(self, other_uri)