From 9369a228414cb4fbe68ed95d0552446ae559a14a Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Sun, 22 Mar 2020 19:16:08 -0500 Subject: [PATCH] correct updateblockinfo docstring and format --- src/coredb/blockmetadb/updateblockinfo.py | 38 ++++++++++++----------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/src/coredb/blockmetadb/updateblockinfo.py b/src/coredb/blockmetadb/updateblockinfo.py index 516201f9..41a67cca 100644 --- a/src/coredb/blockmetadb/updateblockinfo.py +++ b/src/coredb/blockmetadb/updateblockinfo.py @@ -1,9 +1,12 @@ -''' - Onionr - Private P2P Communication +"""Onionr - Private P2P Communication. - Update block information in the metadata database by a field name -''' -''' +Update block information in the metadata database by a field name +""" +import sqlite3 + +from .. import dbfiles +from etc import onionrvalues +""" This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or @@ -16,30 +19,29 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . -''' -import sqlite3 -from .. import dbfiles -from etc import onionrvalues +""" + + def update_block_info(hash, key, data): - ''' - sets info associated with a block + """set info associated with a block hash - the hash of a block dateReceived - the date the block was recieved, not necessarily when it was created - decrypted - if we can successfully decrypt the block (does not describe its current state) + decrypted - if we can successfully decrypt the block dataType - data type of the block dataFound - if the data has been found for the block dataSaved - if the data has been saved for the block - sig - optional signature by the author (not optional if author is specified) - author - multi-round partial sha3-256 hash of authors public key + sig - defunct + author - defunct dateClaimed - timestamp claimed inside the block, only as trustworthy as the block author is expire - expire date for a block - ''' + """ if key not in ('dateReceived', 'decrypted', 'dataType', 'dataFound', - 'dataSaved', 'sig', 'author', 'dateClaimed', 'expire'): + 'dataSaved', 'sig', 'author', 'dateClaimed', 'expire'): raise ValueError('Key must be in the allowed list') - conn = sqlite3.connect(dbfiles.block_meta_db, timeout=onionrvalues.DATABASE_LOCK_TIMEOUT) + conn = sqlite3.connect(dbfiles.block_meta_db, + timeout=onionrvalues.DATABASE_LOCK_TIMEOUT) c = conn.cursor() args = (data, hash) # Unfortunately, not really possible to prepare this statement @@ -47,4 +49,4 @@ def update_block_info(hash, key, data): conn.commit() conn.close() - return True \ No newline at end of file + return True