summaryrefslogtreecommitdiff
path: root/persistent_state.py
blob: 1607b5edbfe7d8f14b19ab7e08f9356d94668eab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
#!/usr/bin/env python3

import pickle
from typing import Any, Mapping

import file_utils


class PersistentState(object):
    """
    An object that behaves like a persistent hash map; it can be
    accessed to store key-value pairs but also saved to disk and read
    back from disk easily.

    """
    def __init__(self, filename: str, *, max_age_sec: int = None):
        self.filename = filename
        if file_utils.does_file_exist(self.filename):
            if max_age_sec is not None:
                age = file_utils.get_file_mtime_age_seconds(self.filename)
                if age < max_age_sec:
                    self.state = self.load()
                else:
                    self.state = {}
            else:
                self.state = self.load()
        else:
            self.state = {}

    def __getitem__(self, key: str) -> Any:
        return self.state.get(key, "")

    def __setitem__(self, key: str, value: Any):
        self.state[key] = value

    def __delitem__(self, key: str):
        del self.state[key]

    def __iter__(self):
        return iter(self.state)

    def __len__(self):
        return len(self.state)

    def save(self) -> None:
        with open(self.filename, 'wb') as f:
            pickle.dump(self.state, f, pickle.HIGHEST_PROTOCOL)

    def load(self) -> Mapping[str, Any]:
        with open(self.filename, 'rb') as f:
            return(pickle.load(f))