URL reference: web2py function

18482 views
0 comments
loading...

the most important functions in web2py

URL function generates internal URL paths for the actions and the static files.

Here is an example:

URL('f')

is mapped into

/[application]/[controller]/f

Notice that the output of the URL function depends on the name of the current application, the calling controller, and other parameters. web2py supports URL mapping and reverse URL mapping. URL mapping allows you to redefine the format of external URLs. If you use the URL function to generate all the internal URLs, then additions or changes to URL mappings will prevent broken links within the web2py application.

You can also use the URL function to generate URLs to actions in other controllers and other applications:

URL('a', 'c', 'f', args=['x', 'y'], vars=dict(z='t'))

is mapped into

/a/c/f/x/y?z=t

It is also possible to specify application, controller and function using named arguments:

URL(a='a', c='c', f='f')

If the application name a is missing the current app is assumed.

URL('c', 'f')

If the controller name c is missing, the current one is assumed.

URL('f')

Instead of passing the name of a controller function it is also possible to pass the function itself

URL(f)

For the reasons mentioned above, you should always use the URL function to generate URLs of static files for your applications. Static files are stored in the application's static subfolder (that's where they go when uploaded using the administrative interface). web2py provides a virtual 'static' controller whose job is to retrieve files from the static subfolder, determine their content-type, and stream the file to the client. The following example generates the URL for the static file "image.png":

URL('static', 'image.png')

is mapped into

/[application]/static/image.png

If the static file is in a subfolder within the static folder, you can include the subfolder(s) as part of the filename. For example, to generate:

/[application]/static/images/icons/arrow.png

one should use:

URL('static', 'images/icons/arrow.png')

You do not need to encode/escape the args and vars arguments; this is done automatically for you.

URL()

Attributes / Arguments

args

You can pass additional parameters to the URL function, i.e., extra terms in the URL path (args) and URL query variables (vars).

The args attributes are automatically parsed, decoded, and finally stored in request.args by web2py.

If args contains only one element, there is no need to pass it in a list.

URL('f', args=['x', 'y'], vars=dict(z='t'))
# is mapped into
>> /[application]/[controller]/f/x/y?z=t

vars

The vars are parsed, decoded, and then stored in request.vars. args and vars provide the basic mechanism by which web2py exchanges information with the client's browser.

URL('f', args=['x', 'y'], vars=dict(z='t'))

extension

By default, the extension corresponding to the current request (which can be found in request.extension) is appended to the function, unless request.extension is html, the default.

This can be overridden by explicitly including an extension as part of the function name URL(f='name.ext') or with the extension argument:

The current extension can be explicitly suppressed:

URL(..., extension='css')
URL(..., extension=False)

scheme scheme=False

By default, URL generates relative URLs. However, you can also generate absolute URLs by specifying the scheme and host arguments (this is useful, for example, when inserting URLs in email messages):

You can automatically include the scheme and host of the current request by simply setting the arguments to True.

URL(..., scheme='http', host='www.mysite.com')

URL(..., scheme=True, host=True)

host host=False

By default, URL generates relative URLs. However, you can also generate absolute URLs by specifying the scheme and host arguments (this is useful, for example, when inserting URLs in email messages):

You can automatically include the scheme and host of the current request by simply setting the arguments to True.

URL(..., scheme='http', host='www.mysite.com')

URL(..., scheme=True, host=True)

hmac_key

The key for signing the URL (a string).

KEY = 'mykey'

def one():
    return dict(link=URL('two', vars=dict(a=123), hmac_key=KEY))

def two():
    if not URL.verify(request, hmac_key=KEY): raise HTTP(403)
    # do something
    return locals()

@auth.requires_login()
def one():
    return dict(link=URL('two', vars=dict(a=123), user_signature=True)

@auth.requires_signature()
def two():
    # do something
    return locals()

Sources / Reference

" web2py Book Chapter 4: The core" is licensed under Creative Common License BY-NC-ND 3.0

Comments

Access Control
- auth
  - enable_record_version
  - settings
- Authentication
  - Actions
Apps
- Charts
  - Highcharts
- CMS
  - TinyWebsite
- Images
  - Gallery
custom attributes
Database Abstraction Layer
Forms
- CRUD()
- Custom forms
  - begin
  - comment
  - deletable
  - dspval
  - end
  - inpval
  - label
  - linkto
  - submit
  - widget
- FORM()
- SQLFORM()
- SQLFORM.factory
Grids
- grid
- smartgrid
Hosting
- Pythonanywhere
  - SSL Setup
Modules
- images module
Payment Systems
Plugins
Services
URL
Validators
- CLEANUP
- CRYPT
- IS_ALPHANUMERIC
- IS_DATE
- IS_DATETIME
- IS_DATETIME_IN_RANGE
- IS_DATE_IN_RANGE
- IS_DECIMAL_IN_RANGE
- IS_EMAIL
- IS_EMPTY_OR
- IS_EQUAL_TO
- IS_EXPR
- IS_FLOAT_IN_RANGE
- IS_IMAGE
- IS_INT_IN_RANGE
- IS_IN_DB
- IS_IN_SET
- IS_IPV4
- IS_LENGTH
- IS_LIST_OF
- IS_LOWER
- IS_MATCH
- IS_NOT_EMPTY
- IS_NOT_IN_DB
- IS_NULL_OR
- IS_SLUG
- IS_STRONG
- IS_TIME
- IS_UPLOAD_FILENAME
- IS_UPPER
- IS_URL
Views
- Helpers
  - A
  - B
  - BEAUTIFY
  - BODY
  - BR
  - CAT
  - CENTER
  - CODE
  - COL
  - COLGROUP
  - DIV
  - EM
  - embed64
  - FIELDSET
  - FORM
  - H1
  - HTML
  - INPUT
  - MENU
  - TAG
  - XHTML
  - XML
  - xmlescape
Widgets

URL web2py function

the most important functions in web2py

Attributes / Arguments

args

vars

extension

scheme scheme=False

host host=False

hmac_key

salt

hash_vars hash_vars=True

user_signature user_signature=False

Sources / Reference

Comments