Skip to content

Sessions ABC

pycodeloop.abc.sessions.Sessions

Bases: ABC

Import

You can import the Sessions class with:

from pycodeloop.abc.sessions import Sessions

Persist and retrieve a Session by key, so a conversation can resume across process restarts. Inject via Config(storage=...); CodeLoop.run(prompt, session_key=...) loads before and saves after each call when a storage is configured.

Source code in pycodeloop/abc/sessions.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class Sessions(ABC):
    """
    Import:
        You can import the **Sessions** class with:

            from pycodeloop.abc.sessions import Sessions

    Persist and retrieve a `Session` by key, so a conversation can
    resume across process restarts. Inject via `Config(storage=...)`;
    `CodeLoop.run(prompt, session_key=...)` loads before and saves
    after each call when a storage is configured.
    """

    @abstractmethod
    def post(self, key: str, session: Session) -> None:
        """Persist `session` under `key`, overwriting any prior value."""

    @abstractmethod
    def get(self, key: str) -> Session | None:
        """Return the session stored under `key`, or `None` if absent."""

    @abstractmethod
    def delete(self, key: str) -> None:
        """Remove the session stored under `key`. No-op if absent."""

delete(key) abstractmethod

Remove the session stored under key. No-op if absent.

Source code in pycodeloop/abc/sessions.py
31
32
33
@abstractmethod
def delete(self, key: str) -> None:
    """Remove the session stored under `key`. No-op if absent."""

get(key) abstractmethod

Return the session stored under key, or None if absent.

Source code in pycodeloop/abc/sessions.py
27
28
29
@abstractmethod
def get(self, key: str) -> Session | None:
    """Return the session stored under `key`, or `None` if absent."""

post(key, session) abstractmethod

Persist session under key, overwriting any prior value.

Source code in pycodeloop/abc/sessions.py
23
24
25
@abstractmethod
def post(self, key: str, session: Session) -> None:
    """Persist `session` under `key`, overwriting any prior value."""

pycodeloop.core.store.file_sessions.FileSessions

Bases: Sessions

Import

You can import the FileSessions class with:

from pycodeloop.core.store.file_sessions import FileSessions

Persists each Session as a JSON file under directory, one file per key — the simplest way to resume a conversation across process restarts without a database.

Parameters:

Name Type Description Default
directory str | Path

Where session files are written. Defaults to ~/.pycodeloop/sessions/.

None
Source code in pycodeloop/core/store/file_sessions.py
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class FileSessions(Sessions):
    """
    Import:
        You can import the **FileSessions** class with:

            from pycodeloop.core.store.file_sessions import FileSessions

    Persists each `Session` as a JSON file under `directory`, one file
    per key — the simplest way to resume a conversation across process
    restarts without a database.

    Args:
        directory (str | Path): Where session files are written.
            Defaults to `~/.pycodeloop/sessions/`.
    """

    def __init__(self, directory: str | Path | None = None) -> None:
        self.directory = Path(directory or Path.home() / ".pycodeloop" / "sessions")

    def _path(self, key: str) -> Path:
        return self.directory / f"{key}.json"

    def post(self, key: str, session: Session) -> None:
        self.directory.mkdir(parents=True, exist_ok=True)

        data = {
            "system_prompt": session.system_prompt,
            "cwd": session.cwd,
            "messages": [asdict(message) for message in session.messages],
        }

        self._path(key).write_text(json.dumps(data, indent=2))
        self._index(key, session)

    def _index(self, key: str, session: Session) -> None:
        """Record key/updated_at/message_count in ~/.pycodeloop/config.json
        under "sessions", so `FileSessions.list_sessions()` (and CLI
        tooling built on it) can list saved conversations without
        reading every session file."""
        sessions = default_store.get_section(_SESSIONS_SECTION)
        sessions[key] = {
            "updated_at": time.time(),
            "message_count": len(session.messages),
            "cwd": session.cwd,
        }

        default_store.set_section(_SESSIONS_SECTION, sessions)

    @staticmethod
    def list_sessions() -> dict:
        """Return the saved-session index: key -> {updated_at,
        message_count, cwd}."""
        return default_store.get_section(_SESSIONS_SECTION)

    def get(self, key: str) -> Session | None:
        path = self._path(key)

        if not path.exists():
            return None

        data = json.loads(path.read_text())

        return Session(
            system_prompt=data["system_prompt"],
            cwd=data["cwd"],
            messages=[Message(**message) for message in data["messages"]],
        )

    def delete(self, key: str) -> None:
        self._path(key).unlink(missing_ok=True)

        sessions = default_store.get_section(_SESSIONS_SECTION)
        sessions.pop(key, None)

        default_store.set_section(_SESSIONS_SECTION, sessions)

directory = Path(directory or Path.home() / '.pycodeloop' / 'sessions') instance-attribute

__init__(directory=None)

Source code in pycodeloop/core/store/file_sessions.py
33
34
def __init__(self, directory: str | Path | None = None) -> None:
    self.directory = Path(directory or Path.home() / ".pycodeloop" / "sessions")

delete(key)

Source code in pycodeloop/core/store/file_sessions.py
85
86
87
88
89
90
91
def delete(self, key: str) -> None:
    self._path(key).unlink(missing_ok=True)

    sessions = default_store.get_section(_SESSIONS_SECTION)
    sessions.pop(key, None)

    default_store.set_section(_SESSIONS_SECTION, sessions)

get(key)

Source code in pycodeloop/core/store/file_sessions.py
71
72
73
74
75
76
77
78
79
80
81
82
83
def get(self, key: str) -> Session | None:
    path = self._path(key)

    if not path.exists():
        return None

    data = json.loads(path.read_text())

    return Session(
        system_prompt=data["system_prompt"],
        cwd=data["cwd"],
        messages=[Message(**message) for message in data["messages"]],
    )

list_sessions() staticmethod

Return the saved-session index: key -> {updated_at, message_count, cwd}.

Source code in pycodeloop/core/store/file_sessions.py
65
66
67
68
69
@staticmethod
def list_sessions() -> dict:
    """Return the saved-session index: key -> {updated_at,
    message_count, cwd}."""
    return default_store.get_section(_SESSIONS_SECTION)

post(key, session)

Source code in pycodeloop/core/store/file_sessions.py
39
40
41
42
43
44
45
46
47
48
49
def post(self, key: str, session: Session) -> None:
    self.directory.mkdir(parents=True, exist_ok=True)

    data = {
        "system_prompt": session.system_prompt,
        "cwd": session.cwd,
        "messages": [asdict(message) for message in session.messages],
    }

    self._path(key).write_text(json.dumps(data, indent=2))
    self._index(key, session)

pycodeloop.core.store.sqlite_sessions.SqliteSessions

Bases: Sessions

Session storage backed by SQLAlchemy models in a single SQLite file. Defaults to ~/.pycodeloop/pycodeloop.db, next to config.json — a generic, app-wide database file, not sessions-only, so other features can add their own tables to it later.

Source code in pycodeloop/core/store/sqlite_sessions.py
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
class SqliteSessions(Sessions):
    """Session storage backed by SQLAlchemy models in a single SQLite
    file. Defaults to `~/.pycodeloop/pycodeloop.db`, next to `config.json`
    — a generic, app-wide database file, not sessions-only, so other
    features can add their own tables to it later."""

    def __init__(self, path: str | Path | None = None) -> None:
        self.path = Path(path or Path.home() / ".pycodeloop" / "pycodeloop.db")
        self.path.parent.mkdir(parents=True, exist_ok=True)

        self._engine = create_engine(f"sqlite:///{self.path}")
        Base.metadata.create_all(self._engine)
        self._session_factory = sessionmaker(bind=self._engine)
        self._migrate_legacy_messages()
        self._migrate_images_column()

    def _db(self) -> OrmSession:
        return self._session_factory()

    def _migrate_images_column(self) -> None:
        """`create_all()` only creates missing tables, not missing
        columns on an existing one — add `images` for databases created
        before message attachments existed."""
        with self._engine.connect() as conn:
            columns = {
                row[1] for row in conn.execute(text("PRAGMA table_info(messages)"))
            }
        if "images" in columns:
            return

        with self._engine.begin() as conn:
            conn.execute(text("ALTER TABLE messages ADD COLUMN images VARCHAR"))

    def _migrate_legacy_messages(self) -> None:
        """One-time backfill from the old single-blob `sessions.messages`
        column (pre-normalization) into the `messages` table, then drop
        that column — it's `NOT NULL` in the old schema, so leaving it
        behind would break every future insert."""
        with self._engine.connect() as conn:
            columns = {
                row[1] for row in conn.execute(text("PRAGMA table_info(sessions)"))
            }
        if "messages" not in columns:
            return

        with self._engine.connect() as conn:
            rows = conn.execute(
                text("SELECT key, messages FROM sessions WHERE messages IS NOT NULL")
            ).fetchall()

        if rows:
            with self._db() as db:
                for key, blob in rows:
                    already_migrated = (
                        db.query(MessageRecord)
                        .filter(MessageRecord.session_key == key)
                        .first()
                        is not None
                    )
                    if already_migrated:
                        continue

                    try:
                        items = json.loads(blob)
                    except (TypeError, ValueError):
                        continue

                    for position, item in enumerate(items):
                        db.add(
                            MessageRecord(
                                session_key=key,
                                position=position,
                                role=item.get("role", ""),
                                content=str(item.get("content", "")),
                                tool_call_id=item.get("tool_call_id"),
                                tool_calls=(
                                    json.dumps(item["tool_calls"])
                                    if item.get("tool_calls")
                                    else None
                                ),
                            )
                        )
                db.commit()

        with self._engine.begin() as conn:
            conn.execute(text("ALTER TABLE sessions DROP COLUMN messages"))

    def post(self, key: str, session: Session) -> None:
        with self._db() as db:
            record = db.get(SessionRecord, key)

            if record is None:
                record = SessionRecord(key=key)
                db.add(record)

            record.system_prompt = session.system_prompt
            record.cwd = session.cwd
            record.updated_at = time.time()
            record.message_count = len(session.messages)

            db.query(MessageRecord).filter(MessageRecord.session_key == key).delete()
            for position, message in enumerate(session.messages):
                db.add(
                    MessageRecord(
                        session_key=key,
                        position=position,
                        role=message.role,
                        content=str(message.content),
                        tool_call_id=message.tool_call_id,
                        tool_calls=(
                            json.dumps(message.tool_calls)
                            if message.tool_calls
                            else None
                        ),
                        images=(json.dumps(message.images) if message.images else None),
                    )
                )

            db.commit()

    def get(self, key: str) -> Session | None:
        with self._db() as db:
            record = db.get(SessionRecord, key)

            if record is None:
                return None

            rows = (
                db.query(MessageRecord)
                .filter(MessageRecord.session_key == key)
                .order_by(MessageRecord.position)
                .all()
            )

            return Session(
                system_prompt=record.system_prompt,
                cwd=record.cwd,
                messages=[
                    Message(
                        role=row.role,
                        content=row.content,
                        tool_call_id=row.tool_call_id,
                        tool_calls=(
                            json.loads(row.tool_calls) if row.tool_calls else None
                        ),
                        images=json.loads(row.images) if row.images else None,
                    )
                    for row in rows
                ],
            )

    def delete(self, key: str) -> None:
        with self._db() as db:
            record = db.get(SessionRecord, key)

            if record is not None:
                db.delete(record)

            db.query(MessageRecord).filter(MessageRecord.session_key == key).delete()
            db.commit()

    def list_sessions(self) -> dict:
        """key -> {updated_at, message_count, cwd}"""
        with self._db() as db:
            records = db.query(SessionRecord).all()

        return {
            r.key: {
                "updated_at": r.updated_at,
                "message_count": r.message_count,
                "cwd": r.cwd,
            }
            for r in records
        }

path = Path(path or Path.home() / '.pycodeloop' / 'pycodeloop.db') instance-attribute

__init__(path=None)

Source code in pycodeloop/core/store/sqlite_sessions.py
26
27
28
29
30
31
32
33
34
def __init__(self, path: str | Path | None = None) -> None:
    self.path = Path(path or Path.home() / ".pycodeloop" / "pycodeloop.db")
    self.path.parent.mkdir(parents=True, exist_ok=True)

    self._engine = create_engine(f"sqlite:///{self.path}")
    Base.metadata.create_all(self._engine)
    self._session_factory = sessionmaker(bind=self._engine)
    self._migrate_legacy_messages()
    self._migrate_images_column()

delete(key)

Source code in pycodeloop/core/store/sqlite_sessions.py
171
172
173
174
175
176
177
178
179
def delete(self, key: str) -> None:
    with self._db() as db:
        record = db.get(SessionRecord, key)

        if record is not None:
            db.delete(record)

        db.query(MessageRecord).filter(MessageRecord.session_key == key).delete()
        db.commit()

get(key)

Source code in pycodeloop/core/store/sqlite_sessions.py
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def get(self, key: str) -> Session | None:
    with self._db() as db:
        record = db.get(SessionRecord, key)

        if record is None:
            return None

        rows = (
            db.query(MessageRecord)
            .filter(MessageRecord.session_key == key)
            .order_by(MessageRecord.position)
            .all()
        )

        return Session(
            system_prompt=record.system_prompt,
            cwd=record.cwd,
            messages=[
                Message(
                    role=row.role,
                    content=row.content,
                    tool_call_id=row.tool_call_id,
                    tool_calls=(
                        json.loads(row.tool_calls) if row.tool_calls else None
                    ),
                    images=json.loads(row.images) if row.images else None,
                )
                for row in rows
            ],
        )

list_sessions()

key -> {updated_at, message_count, cwd}

Source code in pycodeloop/core/store/sqlite_sessions.py
181
182
183
184
185
186
187
188
189
190
191
192
193
def list_sessions(self) -> dict:
    """key -> {updated_at, message_count, cwd}"""
    with self._db() as db:
        records = db.query(SessionRecord).all()

    return {
        r.key: {
            "updated_at": r.updated_at,
            "message_count": r.message_count,
            "cwd": r.cwd,
        }
        for r in records
    }

post(key, session)

Source code in pycodeloop/core/store/sqlite_sessions.py
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def post(self, key: str, session: Session) -> None:
    with self._db() as db:
        record = db.get(SessionRecord, key)

        if record is None:
            record = SessionRecord(key=key)
            db.add(record)

        record.system_prompt = session.system_prompt
        record.cwd = session.cwd
        record.updated_at = time.time()
        record.message_count = len(session.messages)

        db.query(MessageRecord).filter(MessageRecord.session_key == key).delete()
        for position, message in enumerate(session.messages):
            db.add(
                MessageRecord(
                    session_key=key,
                    position=position,
                    role=message.role,
                    content=str(message.content),
                    tool_call_id=message.tool_call_id,
                    tool_calls=(
                        json.dumps(message.tool_calls)
                        if message.tool_calls
                        else None
                    ),
                    images=(json.dumps(message.images) if message.images else None),
                )
            )

        db.commit()