Initial commit

Author: methane

MANIFEST.in

@@ -0,0 +1 @@
+include README.rst

README.rst

@@ -0,0 +1,54 @@
+pymemcache_ integration for Flask
+=================================
+
+.. _pymemcache: https://github.com/pinterest/pymemcache
+
+Initialize
+----------
+
+::
+
+    memcache = FlaskPyMemcache(app)
+
+or::
+
+    memcache = FlaskPyMemcache()
+    memcache.init_app(app)
+
+
+Configuration
+-------------
+
+Put kwargs for pymemcache to `PYMEMCACHE` in your Flask configuration.
+
+::
+
+    PYMEMCACHE = {
+        'server': ('localhost', 11211),
+        'connect_timeout': 1.0,
+        'timeout': 0.5,
+        'no_delay': True,
+    }
+
+You can use different config key with `conf_key` keyword::
+
+    session = FlaskPyMemcache(conf_key='MEMCACHE_SESSION')
+    cache = FlaskPyMemcache(conf_key='MEMCACHE_CACHE')
+
+    session.init_app(app)
+    cache.init_app(app)
+
+In addition to normal pymemcache kwargs, Flask-PyMemcache provides following
+configuration options.
+
+* `prefix` -- Add prefix to all key. (Default: b'')
+* `close_on_teardown` -- Close connection to memcached when app teardown.
+
+Use
+---
+
+::
+
+    memcache.client.set('foo', 'bar')
+
+

flask_pymemcache.py

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+"""
+pymemcache_ integration for Flask
+=================================
+
+.. _pymemcache: https://github.com/pinterest/pymemcache
+
+Initialize
+----------
+
+::
+
+    memcache = FlaskPyMemcache(app)
+
+or::
+
+    memcache = FlaskPyMemcache()
+    memcache.init_app(app)
+
+
+Configuration
+-------------
+
+Put kwargs for pymemcache to `PYMEMCACHE` in your Flask configuration.
+
+::
+
+    PYMEMCACHE = {
+        'server': ('localhost', 11211),
+        'connect_timeout': 1.0,
+        'timeout': 0.5,
+        'no_delay': True,
+    }
+
+You can use different config key with `conf_key` keyword::
+
+    session = FlaskPyMemcache(conf_key='MEMCACHE_SESSION')
+    cache = FlaskPyMemcache(conf_key='MEMCACHE_CACHE')
+
+    session.init_app(app)
+    cache.init_app(app)
+
+In addition to normal pymemcache kwargs, Flask-PyMemcache provides following
+configuration options.
+
+* `prefix` -- Add prefix to all key. (Default: b'')
+* `close_on_teardown` -- Close connection to memcached when app teardown.
+
+Use
+---
+
+::
+
+    memcache.client.set('foo', 'bar')
+
+"""
+from __future__ import absolute_import, division, print_function
+import flask
+import pymemcache
+
+
+class FlaskMemcacheClient(pymemcache.client.Client):
+    """PyMemcache client supporting prefix"""
+    def __init__(self, prefix=b'', **kwargs):
+        if not isinstance(prefix, bytes):
+            prefix = prefix.encode('ascii')
+        self.prefix = prefix
+        super(FlaskMemcacheClient, self).__init__(**kwargs)
+
+    def check_key(self, key):
+        return super(FlaskMemcacheClient, self).check_key(self.prefix + key)
+
+
+class FlaskPyMemcache(object):
+    #: :type: memcache.Client
+    client = None
+
+    def __init__(self, app=None, conf_key=None):
+        """
+        :type app: flask.Flask
+        :parm str conf_key: Key of flask config.
+        """
+        self.conf_key = conf_key
+        if app is not None:
+            self.init_app(app, conf_key)
+
+    def init_app(self, app, conf_key=None):
+        """
+        :type app: flask.Flask
+        :parm str conf_key: Key of flask config.
+        """
+        conf_key = conf_key or self.conf_key or 'MEMCACHE'
+        self.conf_key = conf_key
+        conf = app.config[conf_key]
+        if not isinstance(conf, dict):
+            raise TypeError("Flask-PyMemcache conf should be dict")
+
+        close_on_teardown = conf.pop('close_on_teardown', False)
+        client = FlaskPyMemcache(**conf)
+        app.extensions[self] = client
+
+        if close_on_teardown:
+            @app.teardown_appcontext
+            def close_connection(exc=None):
+                client.disconnect_all()
+
+    @property
+    def client(self):
+        """
+        :rtype: pymemcache.client.Client
+        """
+        return current_app.extensions[self]

setup.cfg

@@ -0,0 +1,2 @@
+[wheel]
+universal=1

setup.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, division, print_function
+
+from setuptools import setup
+
+try:
+    with open('README.rst') as f:
+        readme = f.read()
+except IOError:
+    readme = ''
+
+setup(
+    name="Flask-PyMemcache",
+    description="pymemcache integration for Flask",
+    long_description=readme,
+    install_requires=["Flask", "pymemcache>=1.2.1"],
+)

test_flask_pymemcache.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, division, print_function
+
+import pymemcache.client
+import flask
+import flask.ext.pymemcache
+
+
+def test_simple():
+    pymc = pymemcache.client.Client(('localhost', 11211))
+    memcache = flask.ext.pymemcache.FlaskPyMemcache()
+    app = flask.Flask(__name__)
+    app.config['PYMEMCACHE'] = {
+        'server': ('localhost', 11211),
+        'prefix': b'px'}
+    memcache.init_app(app)
+
+    with app.app_context():
+        memcache.client.set(b'foo', b'bar')
+        assert memcache.client.get(b'foo') == b'bar'
+
+    assert pymc.get(b'pxfoo') == b'bar'