def __init__(self,
api_key,
secret=None,
username=None,
token=None,
format='etree',
store_token=True,
cache=False):
"""Construct a new FlickrAPI instance for a given API key
and secret.
api_key
The API key as obtained from Flickr.
secret
The secret belonging to the API key.
username
Used to identify the appropriate authentication token for a
certain user.
token
If you already have an authentication token, you can give
it here. It won't be stored on disk by the FlickrAPI instance.
format
The response format. Use either "xmlnode" or "etree" to get a parsed
response, or use any response format supported by Flickr to get an
unparsed response from method calls. It's also possible to pass the
``format`` parameter on individual calls.
store_token
Disables the on-disk token cache if set to False (default is True).
Use this to ensure that tokens aren't read nor written to disk, for
example in web applications that store tokens in cookies.
cache
Enables in-memory caching of FlickrAPI calls - set to ``True`` to
use. If you don't want to use the default settings, you can
instantiate a cache yourself too:
>>> f = FlickrAPI(api_key='123')
>>> f.cache = SimpleCache(timeout=5, max_entries=100)
"""
self.api_key = api_key
self.secret = secret
self.default_format = format
self.__handler_cache = {}
if token:
# Use a memory-only token cache
self.token_cache = SimpleTokenCache()
self.token_cache.token = token
elif not store_token:
# Use an empty memory-only token cache
self.token_cache = SimpleTokenCache()
else:
# Use a real token cache
self.token_cache = TokenCache(api_key, username)
if cache:
self.cache = SimpleCache()
else:
self.cache = None
def __init__(self,
api_key,
secret,
username=None,
token=None,
format='etree',
store_token=True,
cache=False,
token_cache_location=None,
timeout=None):
"""Construct a new FlickrAPI instance for a given API key
and secret.
api_key
The API key as obtained from Flickr.
secret
The secret belonging to the API key.
username
Used to identify the appropriate authentication token for a
certain user.
token
If you already have an authentication token, you can give
it here. It won't be stored on disk by the FlickrAPI instance.
format
The response format. Use either "xmlnode" or "etree" to get a parsed
response, or use any response format supported by Flickr to get an
unparsed response from method calls. It's also possible to pass the
``format`` parameter on individual calls.
store_token
Disables the on-disk token cache if set to False (default is True).
Use this to ensure that tokens aren't read nor written to disk, for
example in web applications that store tokens in cookies.
cache
Enables in-memory caching of FlickrAPI calls - set to ``True`` to
use. If you don't want to use the default settings, you can
instantiate a cache yourself too:
>>> f = FlickrAPI(u'123', u'123')
>>> f.cache = SimpleCache(timeout=5, max_entries=100)
token_cache_location
If not None, determines where the authentication tokens are stored.
timeout
Optional request timeout as float in seconds.
"""
self.default_format = format
self._handler_cache = {}
if isinstance(api_key, six.binary_type):
api_key = api_key.decode('ascii')
if isinstance(secret, six.binary_type):
secret = secret.decode('ascii')
if token:
assert isinstance(token, auth.FlickrAccessToken)
# Use a memory-only token cache
self.token_cache = tokencache.SimpleTokenCache()
self.token_cache.token = token
elif not store_token:
# Use an empty memory-only token cache
self.token_cache = tokencache.SimpleTokenCache()
else:
# Use a real token cache
self.token_cache = tokencache.OAuthTokenCache(
api_key, username or '', path=token_cache_location)
self.flickr_oauth = auth.OAuthFlickrInterface(api_key,
secret,
self.token_cache,
default_timeout=timeout)
if cache:
self.cache = SimpleCache()
else:
self.cache = None