Caches Package

AWSS3 Module

class TileCache.Caches.AWSS3.AWSS3(access_key, secret_access_key, use_tms_paths='False', **kwargs)

Bases: TileCache.Cache.Cache

attemptLock(tile)

delete(tile)

deleteObject(key)

get(tile)

getBotoKey(key)

getKey(tile)

getLockName(tile)

getObject(key)

import_error = 'Problem importing S3 support library. You must have either boto or the Amazon S3 library.\nErrors:\n * %s'

keys(options={})

set(tile, data)

setObject(key, data)

unlock(tile)

Disk Module

class TileCache.Caches.Disk.Disk(base=None, umask='002', **kwargs)

Bases: TileCache.Cache.Cache

access(path, type='read')

attemptLock(tile)

delete(tile)

get(tile)

getKey(tile)

makedirs(path, hide_dir_exists=True)

set(tile, data)

unlock(tile)

GoogleDisk Module

Provides a subclass of Disk Cache which saves in a simple z/x/y.extension, with Y=0 being the top of the map, and heading down. This tile layout makes for generation of tiles that is friendly to Google/OSM, and the opposite of TMS. This is useful for pre-generating tiles for Google Maps which are going to be used offline. This allows one to use TileCache in a gdal2tiles-like setup, using the cache to write out a directory which can be used in other places.

Note that ext3 (a common Linux filesystem) will not support more than 32000 files in a directory, so if you plan to store a whole world at z15 or greater, you should not use this cache class. (The Disk.py file is designed for this use case.)

>>> from TileCache.Layer import Layer, Tile
>>> l = Layer("test")
>>> t = Tile(l, 14, 18, 12)
>>> c = GoogleDisk("/tmp/tilecache")
>>> c.getKey(t)
'/tmp/tilecache/test/12/14/4077.png'

class TileCache.Caches.GoogleDisk.GoogleDisk(base=None, umask='002', **kwargs)

Bases: TileCache.Caches.Disk.Disk

getKey(tile)

MBTiles Module

class TileCache.Caches.MBTiles.MBTiles(base=None, ext=None, umask='002', **kwargs)

Bases: TileCache.Cache.Cache

get(tile)

Memcached Module

class TileCache.Caches.Memcached.Memcached(servers=['127.0.0.1:11211'], **kwargs)

Bases: TileCache.Cache.Cache

attemptLock(tile)

delete(tile)

get(tile)

getKey(tile)

set(tile, data)

unlock(tile)

S3 Module

class TileCache.Caches.S3.AWSAuthConnection(aws_access_key_id, aws_secret_access_key, is_secure=True, server='s3.amazonaws.com', port=None, calling_format=2)

check_bucket_exists(bucket)

create_bucket(bucket, headers={})

create_located_bucket(bucket, location=None, headers={})

delete(bucket, key, headers={})

delete_bucket(bucket, headers={})

get(bucket, key, headers={})

get_acl(bucket, key, headers={})

get_bucket_acl(bucket, headers={})

get_bucket_location(bucket)

get_bucket_logging(bucket, headers={})

list_all_my_buckets(headers={})

list_bucket(bucket, options={}, headers={})

put(bucket, key, object, headers={})

put_acl(bucket, key, acl_xml_document, headers={})

put_bucket_acl(bucket, acl_xml_document, headers={})

put_bucket_logging(bucket, logging_xml_doc, headers={})

class TileCache.Caches.S3.Bucket(name='', creation_date='')

class TileCache.Caches.S3.CallingFormat

PATH = 1

SUBDOMAIN = 2

VANITY = 3

static build_url_base(protocol, server, port, bucket, calling_format)

class TileCache.Caches.S3.CommonPrefixEntry

class TileCache.Caches.S3.GetResponse(http_response)

Bases: TileCache.Caches.S3.Response

get_aws_metadata(headers)

class TileCache.Caches.S3.ListAllMyBucketsHandler

Bases: xml.sax.handler.ContentHandler

characters(content)

endElement(name)

startElement(name, attrs)

class TileCache.Caches.S3.ListAllMyBucketsResponse(http_response)

Bases: TileCache.Caches.S3.Response

class TileCache.Caches.S3.ListBucketHandler

Bases: xml.sax.handler.ContentHandler

characters(content)

endElement(name)

startElement(name, attrs)

class TileCache.Caches.S3.ListBucketResponse(http_response)

Bases: TileCache.Caches.S3.Response

class TileCache.Caches.S3.ListEntry(key='', last_modified=None, etag='', size=0, storage_class='', owner=None)

class TileCache.Caches.S3.Location

DEFAULT = None

EU = 'EU'

class TileCache.Caches.S3.LocationHandler

Bases: xml.sax.handler.ContentHandler

characters(content)

endElement(name)

startElement(name, attrs)

class TileCache.Caches.S3.LocationResponse(http_response)

Bases: TileCache.Caches.S3.Response

class TileCache.Caches.S3.Owner(id='', display_name='')

class TileCache.Caches.S3.QueryStringAuthGenerator(aws_access_key_id, aws_secret_access_key, is_secure=True, server='s3.amazonaws.com', port=None, calling_format=2)

DEFAULT_EXPIRES_IN = 60

create_bucket(bucket, headers={})

delete(bucket, key, headers={})

delete_bucket(bucket, headers={})

generate_url(method, bucket='', key='', query_args={}, headers={})

get(bucket, key, headers={})

get_acl(bucket, key='', headers={})

get_bucket_acl(bucket, headers={})

get_bucket_logging(bucket, headers={})

list_all_my_buckets(headers={})

list_bucket(bucket, options={}, headers={})

make_bare_url(bucket, key='')

put(bucket, key, object, headers={})

put_acl(bucket, key, acl_xml_document, headers={})

put_bucket_acl(bucket, acl_xml_document, headers={})

put_bucket_logging(bucket, logging_xml_doc, headers={})

set_expires(expires)

set_expires_in(expires_in)

class TileCache.Caches.S3.Response(http_response)

class TileCache.Caches.S3.S3Object(data, metadata={})

TileCache.Caches.S3.canonical_string(method, bucket='', key='', query_args={}, headers={}, expires=None)

TileCache.Caches.S3.encode(aws_secret_access_key, str, urlencode=False)

TileCache.Caches.S3.merge_meta(headers, metadata)

TileCache.Caches.S3.query_args_hash_to_string(query_args)

Test Module

class TileCache.Caches.Test.Test(timeout=30.0, stale_interval=300.0, readonly=False, expire=False, sendfile=False, **kwargs)

Bases: TileCache.Cache.Cache

A Cache class which does not cache anything: useful for testing during development, or any other setup where TileCache should not cache data. In general, using this with metatiles is very slow, and not recommended.

attemptLock(tile)

get(tile)

getKey(tile)

set(tile, data)

unlock(tile)