Docs for URL.__format__

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description


<type 'builtin_function_or_method'>


default object formatter


Attributes


URL.__format__.__call__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__call__(...) <==> x(...)

URL.__format__.__class__ <type 'type'> extends (<type 'object'>,) belongs to class <type 'type'>
<attribute '__doc__' of 'builtin_function_or_method' objects>

URL.__format__.__cmp__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__cmp__(y) <==> cmp(x,y)

URL.__format__.__delattr__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__delattr__('name') <==> del x.name

URL.__format__.__doc__ <type 'str'> belongs to class <type 'str'>
str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

URL.__format__.__eq__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__eq__(y) <==> x==y

URL.__format__.__format__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
default object formatter

URL.__format__.__ge__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__ge__(y) <==> x>=y

URL.__format__.__getattribute__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__getattribute__('name') <==> x.name

URL.__format__.__gt__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__gt__(y) <==> x>y

URL.__format__.__hash__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__hash__() <==> hash(x)

URL.__format__.__init__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__init__(...) initializes x; see help(type(x)) for signature

URL.__format__.__le__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__le__(y) <==> x<=y

URL.__format__.__lt__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__lt__(y) <==> x<y

URL.__format__.__module__ <type 'NoneType'> belongs to class <type 'NoneType'>

URL.__format__.__name__ <type 'str'> belongs to class <type 'str'>
str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

URL.__format__.__ne__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__ne__(y) <==> x!=y

URL.__format__.__new__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
T.__new__(S, ...) -> a new object with type S, a subtype of T

URL.__format__.__reduce__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
helper for pickle

URL.__format__.__reduce_ex__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
helper for pickle

URL.__format__.__repr__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__repr__() <==> repr(x)

URL.__format__.__self__ <type 'function'> belongs to class <type 'function'>
generates a url '/a/c/f' corresponding to application a, controller c and function f. If r=request is passed, a, c, f are set, respectively, to r.application, r.controller, r.function. The more typical usage is: URL('index') that generates a url for the index function within the present application and controller. Args: a: application (default to current if r is given) c: controller (default to current if r is given) f: function (default to current if r is given) r: request (optional) args: any arguments (optional). Additional "path" elements vars: any variables (optional). Querystring elements anchor: anchorname, without # (optional) extension: force an extension hmac_key: key to use when generating hmac signature (optional) hash_vars: which of the vars to include in our hmac signature True (default) - hash all vars, False - hash none of the vars, iterable - hash only the included vars ['key1','key2'] salt: salt hashing with this string user_signature: signs automatically the URL in such way that only the user can access the URL (use with `URL.verify` or `auth.requires_signature()`) scheme: URI scheme (True, 'http' or 'https', etc); forces absolute URL (optional) host: string to force absolute URL with host (True means http_host) port: optional port number (forces absolute URL) encode_embedded_slash: encode slash characters included in args url_encode: encode characters included in vars Raises: SyntaxError: when no application, controller or function is available or when a CRLF is found in the generated url Examples: >>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'], ... vars={'p':1, 'q':2}, anchor='1')) '/a/c/f/x/y/z?p=1&q=2#1' >>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'], ... vars={'p':(1,3), 'q':2}, anchor='1')) '/a/c/f/x/y/z?p=1&p=3&q=2#1' >>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'], ... vars={'p':(3,1), 'q':2}, anchor='1')) '/a/c/f/x/y/z?p=3&p=1&q=2#1' >>> str(URL(a='a', c='c', f='f', anchor='1+2')) '/a/c/f#1%2B2' >>> str(URL(a='a', c='c', f='f', args=['x', 'y', 'z'], ... vars={'p':(1,3), 'q':2}, anchor='1', hmac_key='key')) '/a/c/f/x/y/z?p=1&p=3&q=2&_signature=a32530f0d0caa80964bb92aad2bedf8a4486a31f#1' >>> str(URL(a='a', c='c', f='f', args=['w/x', 'y/z'])) '/a/c/f/w/x/y/z' >>> str(URL(a='a', c='c', f='f', args=['w/x', 'y/z'], encode_embedded_slash=True)) '/a/c/f/w%2Fx/y%2Fz' >>> str(URL(a='a', c='c', f='f', args=['%(id)d'], url_encode=False)) '/a/c/f/%(id)d' >>> str(URL(a='a', c='c', f='f', args=['%(id)d'], url_encode=True)) '/a/c/f/%25%28id%29d' >>> str(URL(a='a', c='c', f='f', vars={'id' : '%(id)d' }, url_encode=False)) '/a/c/f?id=%(id)d' >>> str(URL(a='a', c='c', f='f', vars={'id' : '%(id)d' }, url_encode=True)) '/a/c/f?id=%25%28id%29d' >>> str(URL(a='a', c='c', f='f', anchor='%(id)d', url_encode=False)) '/a/c/f#%(id)d' >>> str(URL(a='a', c='c', f='f', anchor='%(id)d', url_encode=True)) '/a/c/f#%25%28id%29d'

URL.__format__.__setattr__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__setattr__('name', value) <==> x.name = value

URL.__format__.__sizeof__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
__sizeof__() -> int size of object in memory, in bytes

URL.__format__.__str__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__str__() <==> str(x)

URL.__format__.__subclasshook__ <type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'>
Abstract classes can override this to customize issubclass(). This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).