memory-oc 1.0.2

A session library using redis

memory_oc

Provides methods for creating and managing sessions in body_oc projects.

Please see LICENSE for further information.

See Releases for changes from release to release.

Contents

• Module Install
• Configuration
• Methods
  • close
  • create
  • load
• Class
  • close
  • extend
  • key
  • save
  • update

Module Install

Requires

memory_oc requires python 3.10 or higher

Install via pip

pip install memory_oc

[ top / contents ]

Configuration

Memory requires the use of a config_oc config.json file. See config_oc for more info.

{
  "memory": {
    "redis": "session"
  },

  "redis": {
    "session": {
      "host": "redis.mydomain.com",
      "db": 1
    }
  }
}

The redis section lists Redis connections by name and details to connect. Then memory.redis specifies which connection to use to create the sessions on.

[ top / contents ]

Methods

Memory comes with three methods, to close, create, and load sessions.

close

Immediately closes and deletes a session from Redis.

example

import memory

# Closes the session by key
memory.close(somekey)

create

Creates a new session. Takes 3 optional arguments

Argument	Type	Description
key	str	The key to use to create the session in Redis.
ttl	unsigned integer	The time to live in seconds for the session.
data	dict	The initial data to be stored in the session.

example

import memory

# Creates a 10 minutes session
session = memory.create(ttl = 600, data = {
	'email': '[e-mail]',
	'name': 'Sam'
})

# Stores it in Redis
session.save()

# Returns the generated session key
return session.key()

load

Loads a session from a passed key.

example

import memory

# Loads the session data from Redis
session = memory.load(somekey)

# Change data
session['name'] = 'Samuel'

# Store it in Redis
session.save()

[ top / contents ]

Class

The class is what is returned from the create and load methods.

instance.close

Closes the session in Redis, making it no longer available to anyone.

example

import memory

# Load the session
session = memory.load(somekey)

# Close the session
session.close()

instance.extend

Extends the TTL of the session by the initial TTL given.

exmaple

import memory

# Load the session
session = memory.load(somekey)

# Extend the session
session.extend()

instance.key

Returns the key of the session.

example

import memory

# Create the session
session = memory.create()

# Print the key
print(session.key())

instance.save

Stores changes in Redis after updates.

example

import memory

# Load a session
session = memory.load(somekey)

# Make changes
session['name'] = 'Samuel'

# Save changes
session.save()

instance.update

Works the same as dict update() so you can store multiple keys at once

example

import memory

# Load session
session = memory.load(somekey)

# Update multiple fields
session.update({
	'name': 'Samuel',
	'phone': '[phone]'
})

# Save changes
session.save()

[ top / contents ]