57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
|
||
|
||
<a id="daisy"></a>
|
||
|
||
# Daisy
|
||
|
||
### *class* Daisy.Daisy.Daisy(filepath: str, templates: dict = {}, template: bool = False, prefillDict: bool = False)
|
||
|
||
Base class for Daisy data representation
|
||
|
||
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/Components/daisy.py)
|
||
|
||
#### filepath
|
||
|
||
Path to file representation on disk
|
||
|
||
* **Type:**
|
||
str
|
||
|
||
#### msg
|
||
|
||
In memory representation
|
||
|
||
* **Type:**
|
||
dict
|
||
|
||
#### get()
|
||
|
||
Get record dictionary from memory
|
||
|
||
* **Returns:**
|
||
**self.msg**
|
||
* **Return type:**
|
||
dict
|
||
|
||
#### read(decrypt: bool = False, decryptKey=False)
|
||
|
||
Read record from disk to memory
|
||
|
||
* **Parameters:**
|
||
* **decrypt** (*bool*) – Whether to decrypt record
|
||
* **decryptKey** – Key to decrypt record
|
||
|
||
#### sublist()
|
||
|
||
Lists contents of directory if object is a directory, otherwise return None
|
||
|
||
#### write(override=False, encrypt: bool = False, encryptKey=None, recur: bool = False)
|
||
|
||
Write record to disk
|
||
|
||
* **Parameters:**
|
||
* **override** – Either false or a dictionary of values to set on the record
|
||
* **encrypt** (*bool*) – Whether to encrypt the record (TODO)
|
||
* **encryptKey** – Key to encrypt record with, or None if not set
|
||
* **recur** (*bool*) – Whether to recursively handle keys
|