feat: add shelve module

Author: wilfredinni

docs/cheatsheet/reading-and-writing-files.md

@@ -67,46 +67,3 @@ You can also iterate through the file line by line:
 # Hello world!
 # Bacon is not a vegetable.
 ```
-
-## The shelve module
-
-<base-disclaimer>
-  <base-disclaimer-title>
-    From the <a target="_blank" href="https://docs.python.org/3/library/shelve.html">Python 3 documentation</a>
-  </base-disclaimer-title>
-  <base-disclaimer-content>
-   A “shelf” is a persistent, dictionary-like object. The difference with “dbm” databases is that the values (not the keys!) in a shelf can be essentially arbitrary Python objects — anything that the pickle module can handle. This includes most class instances, recursive data types, and objects containing lots of shared sub-objects. The keys are ordinary strings.
-  </base-disclaimer-content>
-</base-disclaimer>
-
-To save variables:
-
-```python
->>> import shelve
-
->>> cats = ['Zophie', 'Pooka', 'Simon']
->>> with shelve.open('mydata') as shelf_file:
-...     shelf_file['cats'] = cats
-```
-
-To open and read variables:
-
-```python
->>> with shelve.open('mydata') as shelf_file:
-...     print(type(shelf_file))
-...     print(shelf_file['cats'])
-...
-# <class 'shelve.DbfilenameShelf'>
-# ['Zophie', 'Pooka', 'Simon']
-```
-
-Just like dictionaries, `shelf` values have `keys()` and `values()` methods that will return list-like values of the keys and values in the shelf. Since these methods return list-like values instead of true lists, you should pass them to the `list()` function to get them in list form.
-
-```python
->>> with shelve.open('mydata') as shelf_file:
-...     print(list(shelf_file.keys()))
-...     print(list(shelf_file.values()))
-...
-# ['cats']
-# [['Zophie', 'Pooka', 'Simon']]
-```

docs/modules/shelve-module.md

@@ -0,0 +1,47 @@
+---
+title: Python Shelve Module - Python Cheatsheet
+description: A “shelf” is a persistent, dictionary-like object. in a shelf can be essentially arbitrary Python objects — anything that the pickle module can handle.
+---
+
+# Python Shelve Module
+
+<base-disclaimer>
+  <base-disclaimer-title>
+    From the <a target="_blank" href="https://docs.python.org/3/library/shelve.html">Python 3 documentation</a>
+  </base-disclaimer-title>
+  <base-disclaimer-content>
+   A “shelf” is a persistent, dictionary-like object. The difference with “dbm” databases is that the values (not the keys!) in a shelf can be essentially arbitrary Python objects — anything that the pickle module can handle. This includes most class instances, recursive data types, and objects containing lots of shared sub-objects. The keys are ordinary strings.
+  </base-disclaimer-content>
+</base-disclaimer>
+
+## Save variables
+
+```python
+>>> import shelve
+
+>>> wife = ['Pretty', 'Lovely', 'Nice']
+>>> with shelve.open('mydata') as shelf_file:
+...     shelf_file['wife'] = wife
+```
+
+## Open and read variables:
+
+```python
+>>> with shelve.open('mydata') as shelf_file:
+...     print(type(shelf_file))
+...     print(shelf_file['wife'])
+...
+# <class 'shelve.DbfilenameShelf'>
+# ['Pretty', 'Lovely', 'Nice']
+```
+
+Just like dictionaries, `shelf` values have `keys()` and `values()` methods that will return list-like values of the keys and values in the shelf. Since these methods return list-like values instead of true lists, you should pass them to the `list()` function to get them in list form.
+
+```python
+>>> with shelve.open('mydata') as shelf_file:
+...     print(list(shelf_file.keys()))
+...     print(list(shelf_file.values()))
+...
+# ['wife']
+# [['Pretty', 'Lovely', 'Nice']]
+```

src/store/navigation.ts

@@ -136,6 +136,10 @@ export const useNavigationStore = defineStore('navigation', {
         name: 'Pathlib',
         path: '/modules/pathlib-module',
       },
+      {
+        name: 'Shelve',
+        path: '/modules/shelve-module',
+      },
       {
         name: 'Zipfile',
         path: '/modules/zipfile-module',