Signed Cookie-Based HTTP sessions for Muffin framework
Project description
Muffin-Session – Signed Cookie-Based HTTP sessions for Muffin framework
Requirements
python >= 3.7
Installation
Muffin-Session should be installed using pip:
pip install muffin-session
Usage
Use it manually
from muffin import Application, ResponseHTML
from muffin_session import Plugin as Session
# Create Muffin Application
app = Application('example')
# Initialize the plugin
# As alternative: session = Session(app, **options)
session = Session()
session.setup(app, secret_key='REALLY_SECRET_KEY_FOR_SIGN_YOUR_SESSIONS')
# Use it inside your handlers
@app.route('/update')
async def update_session(request):
ses = session.load_from_request(request)
ses['var'] = 'value'
response = ResponseHTML('Session has been updated')
session.save_to_response(ses, response)
return res
@app.route('/load')
async def load_session(request):
ses = session.load_from_request(request)
return ses.get('var')Auto manage sessions (with middleware)
from muffin import Application, ResponseHTML
from muffin_session import Plugin as Session
# Create Muffin Application
app = Application('example')
# Initialize the plugin
# As alternative: session = Session(app, **options)
session = Session()
session.setup(app, secret_key='REALLY_SECRET_KEY_FOR_SIGN_YOUR_SESSIONS', auto_manage=True)
# Use it inside your handlers
@app.route('/update')
async def update_session(request):
request.session['var'] = 'value'
return 'Session has been updated'
@app.route('/load')
async def load_session(request):
return request.session.get('var')Options
Name |
Default value |
Desctiption |
secret_key |
"InsecureSecret" |
A secret code to sign sessions |
auto_manage |
False |
Load/Save sessions automatically. Session will be loaded into request.session |
cookie_name |
"session" |
Sessions’s cookie name (session) |
cookie_params |
Sessions’s cookie params ({'path': '/', 'max-age': None, 'samesite': 'lax', 'secure': False}) |
|
default_user_checker |
lambda x: True |
A function to check a logged user |
login_url |
"/login" |
An URL to redirect anonymous users (it may be a function which accept Request and returns a string) |
You are able to provide the options when you are initiliazing the plugin:
session.setup(app, secret_key='123455', cookie_name='info')Or setup it inside Muffin.Application config using the SESSION_ prefix:
SESSION_SECRET_KEY = '123455'
SESSION_COOKIE_NAME = 'info'Muffin.Application configuration options are case insensitive
Examples
from muffin import Application, ResponseHTML
from muffin_session import Plugin as Session
# Create Muffin Application
app = Application('example')
# Initialize the plugin
# As alternative: session = Session(app, **options)
session = Session()
session.setup(app, secret_key='REALLY_SECRET_KEY_FOR_SIGN_YOUR_SESSIONS', auto_manage=True)
@session.user_loader
async def load_user(ident):
"""Define your own user loader. """
return await my_database_load_user_by_id(ident)
@app.register('/session')
async def get_session(request):
""" Load session and return it as JSON. """
return dict(request.session)
@app.register('/admin')
@session.user_pass(lambda user: user.is_admin)
async def admin(request):
"""Awailable for admins only. """
return 'TOP SECRET'
@app.register('/login')
async def login(request):
"""Save user id into the current session. """
# ...
session.login(request, current_user.pk)
return 'OK'
@app.register('/logout')
async def logout(request):
""" Logout user. """
# ...
session.logout(request)
return 'OK'
@app.register('/somewhere')
async def somewhere(request):
""" Do something and leave a flash message """
# ...
request.session.clear()
return 'OK'Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-session/issues
Contributing
Development of Muffin-Session happens at: https://github.com/klen/muffin-session
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file muffin-session-1.0.0.tar.gz.
File metadata
- Download URL: muffin-session-1.0.0.tar.gz
- Upload date:
- Size: 6.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 377499a492a28528087f17457c261a9ca3f0244fb309fe171443396b19b93dd2 |
|
| MD5 | a08c2b9fe10a4cad538f836bf85b6af0 |
|
| BLAKE2b-256 | e80279bed3a40301d1bd6cf4cab699d49759e9567f5fdf3bb5a9b9207d28d125 |
File details
Details for the file muffin_session-1.0.0-py3-none-any.whl.
File metadata
- Download URL: muffin_session-1.0.0-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6349f41b9ac4b8482161cb250602a0337bfb567b315ee94d67e0155fc004c2a0 |
|
| MD5 | 78d31fec968b0c688175dfc048fb9c11 |
|
| BLAKE2b-256 | 777ed0d818ab3513785e8e842de0e9803cfa4a6b2fe7dd33520ab58450abe105 |
