Module web

Returns an image tag for the specified 'source'

Examples:

>>> image_tag("xml.png")
'<img alt="Xml" src="/resources/images/xml.png" />'

Parameters:

• source - The source URL of the image. The URL is prepended with "[appname]/resources/images" unless it begins with "http://"
• alt - The image's alt tag. Defaults to the image's filename (title cased)
• size - The image's size, specified as XxY. "30x25" becomes width="30", height="25". "x60" becomes height="60". Optional.

Returns a link tag allowing browsers and news readers to auto-detect RSS or ATOM feeds for the current page.

Parameters:

• source - The URL of the feed. It is prepended with the application name unless it is already there
• type - The extension or the mime-type of the feed. If the extension is provided, the mime-type is guessed. Defaults to rss.

Returns script include tags for the specified sources.

Parameters:

• sources - Each source's URL path is prepended with "[appname]/resources/js" unless the full path is specified.
• options - Additional attributes to added to the script tag.

  Specify the keyword argument ``defer=True`` to enable the script defer attribute.

  >>>print javascript_include_tag('myapp.js', 'myotherapp.js') <script src="/resources/js/myapp.js" type="text/javascript"></script> <script src="/resources/js/myotherapp.js" type="text/javascript"></script>

Returns a javascript tag with the 'content' inside.

Parameters:

• content - The content to put inside the script tag. Example:

  >>> javascript_tag("alert('This is an Alert')")
  '<script type="text/javascript">\n//<![CDATA[\nalert(\'This is an Alert\')\n//]]>\n</script>'

Create a link of the given 'name' using a URL created by the set of 'options'.

Parameters:

• url - The url to link to.

  If 'confirm' is passed in html_options, the link is guarded by a confirm popup with the value as question.

  If 'popup'=True is passed, then the link opens in a popup window.

Returns a link that will trigger a javascript 'function' using the onclick handler and return false afterwards.

Example:

       >>>link_to_function("Greeting", "alert('Hello World!')")
       <a href="#" onclick="alert('Hello World!'); return false;">Greeting</a>

Parameters:

• name - The content of the link tag
• function - The javascript function call

Returns a button that will trigger a javascript 'function' using the onclick handler and return false afterwards.

Example:

       >>>button_to_function("Greeting", "alert('Hello World!')")
       <input type="button" value="Greeting" onclick="alert('Hello World!'); " />

Parameters:

• name - The content of the link tag.
• function - The javascript function call.

Truncate a string to a limited number of characters

Parameters:

• text - The string to truncate
• length - The maximum length of the string. Defaults to 30. Includes truncate_string.
• truncate_string - The suffix to use when truncating a string. Default: "..."

Highlight a phrase in text

Parameters:

• text - The text in which to look for phrases.
• phrase - The phrase to look for
• className - The class name to use to do highlighting. Defaults to "highlight"

Convert all email addresses in text to mailto: links

Parameters:

• text - The text to convert

Convert all urls in text to href links

Parameters:

• text - The text to convert
• href_options - The additional attributes to add to the a tag.

Turns all urls and email addresses into clickable links.

Example:

       auto_link("Go to http://www.planetpython.com and say hello to guido@python.org")
       'Go to <a href="http://www.planetpython.com">http://www.planetpython.com</a> and say hello to <a href="mailto:guido@python.org">guido@python.org</a>'   

Parameters:

• text - The text to convert
• href_options - The additional attributes to add to the a tag.

Formats a 'number' into a currency string.

Parameters:

• number - The number to convert
• precision - Indicates the level of precision. Defaults to 2
• unit - Sets the currency type. Defaults to "$". Use &pound; for GBP.
• separator - Used to set what the unit separation should be. Defaults to "."
• delimiter - The delimiter character to use. Defaults to ","

  Examples:

  >>> number_to_currency(1234567890.50, unit="£", separator=",", delimiter="")
  '£1234567890,50'

Formats a 'number' into a percentage string

Parameters:

• number - The number as a float between 0 and 1.

Format the value like a 'human-readable' file size (i.e. 13 KB, 4.1 MB, 102 bytes, etc).

Parameters:

• value - The number in bytes.

Format the value into human readable time.

Parameters:

• value - The number in seconds.

Return from_time in human readable format. e.g. If from_time is a few minutes before to_time, The string is "A few minutes ago". If if it is after to_time, then the string is "In a few minutes."

Parameters:

• from_time - The timestamp to convert
• to_time - The reference timestamp. Defaults to the current time.

HTML-escape a string or object

This converts any non-string objects passed into it to strings (actually, using ``unicode()``). All values returned are non-unicode strings (using ``&#num;`` entities for all non-ASCII characters).

None is treated specially, and returns the empty string.

Escapes a given string without affecting existing escaped entities.

>>> escape_once("1 < 2 &amp; 3")
'1 &lt; 2 &amp; 3'

Creates select options from 'container' which can be a (list, tuple, dict) If container is a list or tuple, then the text is the first element in the entry and the value is the second element. If it is a dictionary, then the key is the text and the value is the value.

Creates a table with property names/keys in the left column and property values in the right column.

Example:

       property_list(p.getObject("root"))

Parameters:

• container - The dictionary like object containing property name-value pairs
• html_options - Additional attributes to be added to the table tag.

Create a property list from a list of dictionaries where each dictionary contains a key-value pair.

Parameters:

• container - The list of dictionaries
• name_key - The key of the property name (or property name-value tuple)
• value_key - The key of the property value (If this is none, then param_key must point to a tuple)
• html_options - Additional attributes to add to the table tag.

Create a property list from a list of objects where each object contains a key-value pair.

Parameters:

• container - The list of objects
• name_attr - The name of the attribute which contains the property name (or property name-value tuple)
• value_attr - The name of the attribute which contains the property value (If this is none, then value_attr must point to a tuple)
• html_options - Additional attributes to add to the table tag.

AUTO_LINK_RE

Value:

re.compile(r""" ( # leading text <\w+.*?>| # leading HTML tag, or [^=!:'"/]| # leading punctuation, or ^ # beginning of line ) ( (?:https?://)| # protocol spec, or ...