Autodoc

class html5_appcache.appcache_base.AppCacheManager

Main class.

_fetch_url(client, url)

Scrape a single URL and fetches assets

_get_sitemap()

Pretty ugly method that fetches the current sitemap and parses it to retrieve the list of available urls

_setup_signals()

Loads the signals for all the models declared in the appcache instances

add_appcache(appcache)

Adds the externally retrieved urls to the internal set.

appcache is a dictionary with cached, network, fallback keys

extract_urls()

Run through the cached urls and fetches assets by scraping the pages

get_cached_urls()

Create the cached urls set.

Merges the assets, the urls, removes the network urls and the external urls

See BaseAppCache.get_urls(), get_network_urls()

get_fallback_urls()

Creates the fallback urls set.

get_manifest(update=False)

Either get the manifest file out of the cache or render it and save in the cache.

get_network_urls()

Create the network urls set.

* (wildcard entry) is added when ADD_WILDCARD is True (default)

get_urls()

Retrieves the urls from the sitemap and BaseAppCache.get_urls() of the appcache instances

get_version_timestamp()

Create the timestamp according to the current time.

It tries to make it unique even for very short timeframes

reset_manifest()

Clear the cache (if clean)

setup(request, template)

Setup is required wen updating the manifest file

setup_registry()

Setup the manager bootstrapping the appcache instances

class html5_appcache.appcache_base.BaseAppCache

Base class for Appcache classes

_add_language(request, urls)

For django CMS 2.3 we need to manually add language code to the urls returned by the appcache classes

Returns:list of urls

_get_assets(request)

override this method to customize asset (images, files, javascripts, stylesheets) urls.

Returns:list of urls

_get_fallback(request)

override this method to define fallback urls.

Returns:dictionary mapping original urls to fallback

_get_network(request)

override this method to define network (non-cached) urls.

Returns:list of urls

_get_urls(request)

override this method to define cached urls.

If you use a sitemap-enabled application, it’s not normally necessary.

Returns:list of urls

get_assets(request)

Public method that return assets urls. Do not override, use _get_assets()

Returns:list of urls

get_fallback(request)

Public method that return fallback urls. Do not override, use _get_fallback()

Returns:dictionary mapping original urls to fallback

get_network(request)

Public method that return network (non-cached) urls. Do not override, use _get_network()

Returns:list of urls

get_urls(request)

Public method that return cached urls. Do not override, use _get_urls()

Returns:list of urls

signal_connector(instance, **kwargs)

You must override this method in you AppCache class.

class html5_appcache.middleware.appcache_middleware.AppCacheAssetsFromResponse

Extracts appcache assets from the rendered template.

Currently supports the following tags:

• img: extracts the data in the src attribute
• script: extracts the data in the src attribute
• link: extracts the data in the href attribute if rel==stylesheet

It supports custom data-attribute to exclude assets from caching:

• data-appcache=’noappcache’: the referenced url is added to the NETWORK section
• data-appcache=’appcache’: the referenced url is added to the CACHE section
• data-appcache-fallback=URL: the referenced url is added in the FALLBACK section, with URL as a target

handle_a(tag, attrib)

Extract assets from the a tag (only for opt-in link)

handle_img(tag, attrib)

Extract assets from the img tag

handle_link(tag, attrib)

Extract assets from the link tag (only for stylesheets)

handle_script(tag, attrib)

Extract assets from the script tag

process_response(request, response)

This method is called only if appcache_analyze parameter is attached to the querystring, to avoid overhead during normal navigation

walk_tree(tree)

Walk the DOM tree