Skip to content

MemoryIO#

Warning

You need to install dependencies to use The Memory Cache.

$ pip install authx_extra

authx_extra.extra._memory.MemoryIO #

MemoryIO()

Initialize an instance of MemoryIO.

Creates a dictionary to store the session data.

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
14
15
16
17
18
19
def __init__(self) -> None:
    """Initialize an instance of MemoryIO.

    Creates a dictionary to store the session data.
    """
    self.raw_memory_store = {}

raw_memory_store instance-attribute #

raw_memory_store = {}

MemoryIO is a class that implements the IO interface for the session store.

It is used to store session data in memory.

has_session_id async #

has_session_id(session_id)
PARAMETER DESCRIPTION
session_id

TYPE: str

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
21
22
async def has_session_id(self, session_id: str) -> bool:
    return session_id in self.raw_memory_store

has_no_session_id async #

has_no_session_id(session_id)
PARAMETER DESCRIPTION
session_id

TYPE: str

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
24
25
async def has_no_session_id(self, session_id: str) -> bool:
    return session_id not in self.raw_memory_store

create_store async #

create_store(session_id)
PARAMETER DESCRIPTION
session_id

TYPE: str

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
27
28
29
30
31
32
33
async def create_store(self, session_id: str) -> dict[str, Any]:
    self.raw_memory_store[session_id] = {
        "created_at": int(time.time()),
        "store": {},
    }
    await self.save_store(session_id)
    return self.raw_memory_store.get(session_id, {}).get("store", {})

get_store async #

get_store(session_id)
PARAMETER DESCRIPTION
session_id

TYPE: str

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
35
36
37
38
39
async def get_store(self, session_id: str) -> Optional[dict[str, Any]]:
    if self.raw_memory_store.get(session_id):
        return self.raw_memory_store.get(session_id, {}).get("store")
    else:
        return None

save_store async #

save_store(session_id)
PARAMETER DESCRIPTION
session_id

TYPE: str

Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
41
42
async def save_store(self, session_id: str) -> None:
    await self.get_store(session_id)

gc async #

gc()
Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
44
45
46
async def gc(self) -> None:
    if len(self.raw_memory_store) >= 100:
        await self.cleanup_old_sessions()

cleanup_old_sessions async #

cleanup_old_sessions()
Source code in .venv/lib/python3.9/site-packages/authx_extra/extra/_memory.py 
48
49
50
51
52
53
54
55
56
async def cleanup_old_sessions(self) -> None:
    current_time = int(time.time())
    sessions_to_delete = [
        session_id
        for session_id, session_info in self.raw_memory_store.items()
        if current_time - session_info["created_at"] > 3600 * 12
    ]
    for session_id in sessions_to_delete:
        del self.raw_memory_store[session_id]