Skip to content

puepy.storage

puepy.storage

Browser Storage Module

This module provides a BrowserStorage class that interfaces with browser storage objects such as localStorage and sessionStorage. It mimics dictionary-like behavior for interacting with storage items.

Classes:

Name Description
BrowserStorage

A class that provides dictionary-like access to browser storage objects.

BrowserStorage

Provides dictionary-like interface to browser storage objects.

Attributes:

Name Type Description
target

The browser storage object (e.g., localStorage, sessionStorage).
description str

Description of the storage instance.
Source code in puepy/storage.py 
 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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
class BrowserStorage:
    """
    Provides dictionary-like interface to browser storage objects.

    Attributes:
        target: The browser storage object (e.g., localStorage, sessionStorage).
        description (str): Description of the storage instance.

    """

    class NoDefault:
        """Placeholder class for default values when no default is provided."""

        pass

    def __init__(self, target, description):
        """
        Initializes the BrowserStorage instance.

        Args:
            target: The browser storage object.
            description (str): Description of the storage instance.
        """
        self.target = target
        self.description = description

    def __getitem__(self, key):
        """
        Retrieves the value for a given key from the storage.

        Args:
            key (str): The key for the item to retrieve.

        Returns:
            The value associated with the key.

        Raises:
            KeyError: If the key does not exist in the storage.
        """
        value = self.target.getItem(key)
        if value is None:
            raise KeyError(key)
        return value

    def __setitem__(self, key, value):
        """
        Sets the value for a given key in the storage.

        Args:
            key (str): The key for the item to set.
            value: The value to associate with the key.
        """
        self.target.setItem(key, str(value))

    def __delitem__(self, key):
        """
        Deletes the item for a given key from the storage.

        Args:
            key (str): The key for the item to delete.

        Raises:
            KeyError: If the key does not exist in the storage.
        """
        if self.target.getItem(key) is None:
            raise KeyError(key)
        self.target.removeItem(key)

    def __contains__(self, key):
        """
        Checks if a key exists in the storage.

        Args:
            key (str): The key to check.

        Returns:
            bool: True if the key exists, False otherwise.
        """
        return not self.target.getItem(key) is None

    def __len__(self):
        """
        Returns the number of items in the storage.

        Returns:
            int: The number of items in the storage.
        """
        return self.target.length

    def __iter__(self):
        """
        Returns an iterator over the keys in the storage.

        Returns:
            iterator: An iterator over the keys.
        """
        return iter(self.keys())

    def items(self):
        """
        Returns an iterator over the (key, value) pairs in the storage.

        Yields:
            tuple: (key, value) pairs in the storage.
        """
        for item in Object.entries(self.target):
            yield item[0], item[1]

    def keys(self):
        """
        Returns a list of keys in the storage.

        Returns:
            list: A list of keys.
        """
        return list(Object.keys(self.target))

    def get(self, key, default=None):
        """
        Retrieves the value for a given key, returning a default value if the key does not exist.

        Args:
            key (str): The key for the item to retrieve.
            default: The default value to return if the key does not exist.

        Returns:
            The value associated with the key, or the default value.
        """
        value = self.target.getItem(key)
        if value is None:
            return default
        else:
            return value

    def clear(self):
        """
        Clears all items from the storage.
        """
        self.target.clear()

    def copy(self):
        """
        Returns a copy of the storage as a dictionary.

        Returns:
            dict: A dictionary containing all items in the storage.
        """
        return dict(self.items())

    def pop(self, key, default=NoDefault):
        """
        Removes the item with the given key from the storage and returns its value.

        Args:
            key (str): The key for the item to remove.
            default: The default value to return if the key does not exist.

        Returns:
            The value associated with the key, or the default value.

        Raises:
            KeyError: If the key does not exist and no default value is provided.
        """
        value = self.target.getItem(key)
        if value is None and default is self.NoDefault:
            raise KeyError(key)
        else:
            self.target.removeItem(key)
            return value

    def popitem(self):
        """
        Not implemented. Raises NotImplementedError.

        Raises:
            NotImplementedError: Always raised as the method is not implemented.
        """
        raise NotImplementedError("popitem not implemented")

    def reversed(self):
        """
        Not implemented. Raises NotImplementedError.

        Raises:
            NotImplementedError: Always raised as the method is not implemented.
        """
        raise NotImplementedError("reversed not implemented")

    def setdefault(self, key, default=None):
        """
        Sets the value for the key if it does not already exist in the storage.

        Args:
            key (str): The key for the item.
            default: The value to set if the key does not exist.

        Returns:
            The value associated with the key, or the default value.
        """
        if key in self:
            return self[key]
        else:
            self[key] = default
            return default

    def update(self, other):
        """
        Updates the storage with items from another dictionary or iterable of key-value pairs.

        Args:
            other: A dictionary or iterable of key-value pairs to update the storage with.
        """
        for k, v in other.items():
            self[k] = v

    def values(self):
        """
        Returns a list of values in the storage.

        Returns:
            list: A list of values.
        """
        return list(Object.values(self.target))

    def __str__(self):
        return self.description

    def __repr__(self):
        return f"<{self}>"

NoDefault

Placeholder class for default values when no default is provided.

Source code in puepy/storage.py 
31
32
33
34
class NoDefault:
    """Placeholder class for default values when no default is provided."""

    pass

__contains__(key)

Checks if a key exists in the storage.

Parameters:

Name Type Description Default
key str

The key to check.

 required

Returns:

Name Type Description
bool

True if the key exists, False otherwise.
Source code in puepy/storage.py 
89
90
91
92
93
94
95
96
97
98
99
def __contains__(self, key):
    """
    Checks if a key exists in the storage.

    Args:
        key (str): The key to check.

    Returns:
        bool: True if the key exists, False otherwise.
    """
    return not self.target.getItem(key) is None

__delitem__(key)

Deletes the item for a given key from the storage.

Parameters:

Name Type Description Default
key str

The key for the item to delete.

 required

Raises:

Type Description
KeyError

If the key does not exist in the storage.
Source code in puepy/storage.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
def __delitem__(self, key):
    """
    Deletes the item for a given key from the storage.

    Args:
        key (str): The key for the item to delete.

    Raises:
        KeyError: If the key does not exist in the storage.
    """
    if self.target.getItem(key) is None:
        raise KeyError(key)
    self.target.removeItem(key)

__getitem__(key)

Retrieves the value for a given key from the storage.

Parameters:

Name Type Description Default
key str

The key for the item to retrieve.

 required

Returns:

Type Description

The value associated with the key.

Raises:

Type Description
KeyError

If the key does not exist in the storage.
Source code in puepy/storage.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __getitem__(self, key):
    """
    Retrieves the value for a given key from the storage.

    Args:
        key (str): The key for the item to retrieve.

    Returns:
        The value associated with the key.

    Raises:
        KeyError: If the key does not exist in the storage.
    """
    value = self.target.getItem(key)
    if value is None:
        raise KeyError(key)
    return value

__init__(target, description)

Initializes the BrowserStorage instance.

Parameters:

Name Type Description Default
target

The browser storage object.

 required
description str

Description of the storage instance.

 required
Source code in puepy/storage.py 
36
37
38
39
40
41
42
43
44
45
def __init__(self, target, description):
    """
    Initializes the BrowserStorage instance.

    Args:
        target: The browser storage object.
        description (str): Description of the storage instance.
    """
    self.target = target
    self.description = description

__iter__()

Returns an iterator over the keys in the storage.

Returns:

Name Type Description
iterator

An iterator over the keys.
Source code in puepy/storage.py 
110
111
112
113
114
115
116
117
def __iter__(self):
    """
    Returns an iterator over the keys in the storage.

    Returns:
        iterator: An iterator over the keys.
    """
    return iter(self.keys())

__len__()

Returns the number of items in the storage.

Returns:

Name Type Description
int

The number of items in the storage.
Source code in puepy/storage.py 
101
102
103
104
105
106
107
108
def __len__(self):
    """
    Returns the number of items in the storage.

    Returns:
        int: The number of items in the storage.
    """
    return self.target.length

__setitem__(key, value)

Sets the value for a given key in the storage.

Parameters:

Name Type Description Default
key str

The key for the item to set.

 required
value

The value to associate with the key.

 required
Source code in puepy/storage.py 
65
66
67
68
69
70
71
72
73
def __setitem__(self, key, value):
    """
    Sets the value for a given key in the storage.

    Args:
        key (str): The key for the item to set.
        value: The value to associate with the key.
    """
    self.target.setItem(key, str(value))

clear()

Clears all items from the storage.

Source code in puepy/storage.py 
155
156
157
158
159
def clear(self):
    """
    Clears all items from the storage.
    """
    self.target.clear()

copy()

Returns a copy of the storage as a dictionary.

Returns:

Name Type Description
dict

A dictionary containing all items in the storage.
Source code in puepy/storage.py 
161
162
163
164
165
166
167
168
def copy(self):
    """
    Returns a copy of the storage as a dictionary.

    Returns:
        dict: A dictionary containing all items in the storage.
    """
    return dict(self.items())

get(key, default=None)

Retrieves the value for a given key, returning a default value if the key does not exist.

Parameters:

Name Type Description Default
key str

The key for the item to retrieve.

 required
default

The default value to return if the key does not exist.

 None

Returns:

Type Description

The value associated with the key, or the default value.
Source code in puepy/storage.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def get(self, key, default=None):
    """
    Retrieves the value for a given key, returning a default value if the key does not exist.

    Args:
        key (str): The key for the item to retrieve.
        default: The default value to return if the key does not exist.

    Returns:
        The value associated with the key, or the default value.
    """
    value = self.target.getItem(key)
    if value is None:
        return default
    else:
        return value

items()

Returns an iterator over the (key, value) pairs in the storage.

Yields:

Name Type Description
tuple

(key, value) pairs in the storage.
Source code in puepy/storage.py 
119
120
121
122
123
124
125
126
127
def items(self):
    """
    Returns an iterator over the (key, value) pairs in the storage.

    Yields:
        tuple: (key, value) pairs in the storage.
    """
    for item in Object.entries(self.target):
        yield item[0], item[1]

keys()

Returns a list of keys in the storage.

Returns:

Name Type Description
list

A list of keys.
Source code in puepy/storage.py 
129
130
131
132
133
134
135
136
def keys(self):
    """
    Returns a list of keys in the storage.

    Returns:
        list: A list of keys.
    """
    return list(Object.keys(self.target))

pop(key, default=NoDefault)

Removes the item with the given key from the storage and returns its value.

Parameters:

Name Type Description Default
key str

The key for the item to remove.

 required
default

The default value to return if the key does not exist.

 NoDefault

Returns:

Type Description

The value associated with the key, or the default value.

Raises:

Type Description
KeyError

If the key does not exist and no default value is provided.
Source code in puepy/storage.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
def pop(self, key, default=NoDefault):
    """
    Removes the item with the given key from the storage and returns its value.

    Args:
        key (str): The key for the item to remove.
        default: The default value to return if the key does not exist.

    Returns:
        The value associated with the key, or the default value.

    Raises:
        KeyError: If the key does not exist and no default value is provided.
    """
    value = self.target.getItem(key)
    if value is None and default is self.NoDefault:
        raise KeyError(key)
    else:
        self.target.removeItem(key)
        return value

popitem()

Not implemented. Raises NotImplementedError.

Raises:

Type Description
NotImplementedError

Always raised as the method is not implemented.
Source code in puepy/storage.py 
191
192
193
194
195
196
197
198
def popitem(self):
    """
    Not implemented. Raises NotImplementedError.

    Raises:
        NotImplementedError: Always raised as the method is not implemented.
    """
    raise NotImplementedError("popitem not implemented")

reversed()

Not implemented. Raises NotImplementedError.

Raises:

Type Description
NotImplementedError

Always raised as the method is not implemented.
Source code in puepy/storage.py 
200
201
202
203
204
205
206
207
def reversed(self):
    """
    Not implemented. Raises NotImplementedError.

    Raises:
        NotImplementedError: Always raised as the method is not implemented.
    """
    raise NotImplementedError("reversed not implemented")

setdefault(key, default=None)

Sets the value for the key if it does not already exist in the storage.

Parameters:

Name Type Description Default
key str

The key for the item.

 required
default

The value to set if the key does not exist.

 None

Returns:

Type Description

The value associated with the key, or the default value.
Source code in puepy/storage.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
def setdefault(self, key, default=None):
    """
    Sets the value for the key if it does not already exist in the storage.

    Args:
        key (str): The key for the item.
        default: The value to set if the key does not exist.

    Returns:
        The value associated with the key, or the default value.
    """
    if key in self:
        return self[key]
    else:
        self[key] = default
        return default

update(other)

Updates the storage with items from another dictionary or iterable of key-value pairs.

Parameters:

Name Type Description Default
other

A dictionary or iterable of key-value pairs to update the storage with.

 required
Source code in puepy/storage.py 
226
227
228
229
230
231
232
233
234
def update(self, other):
    """
    Updates the storage with items from another dictionary or iterable of key-value pairs.

    Args:
        other: A dictionary or iterable of key-value pairs to update the storage with.
    """
    for k, v in other.items():
        self[k] = v

values()

Returns a list of values in the storage.

Returns:

Name Type Description
list

A list of values.
Source code in puepy/storage.py 
236
237
238
239
240
241
242
243
def values(self):
    """
    Returns a list of values in the storage.

    Returns:
        list: A list of values.
    """
    return list(Object.values(self.target))