Added missing docstrings. Fixed typos.

This commit is contained in:
Rodolphe Marques 2017-05-11 12:29:08 +02:00
parent eb94181e1b
commit ce414e46f3
4 changed files with 39 additions and 7 deletions

View File

@ -293,8 +293,8 @@ def get_last_voted_block_id(connection, node_pubkey):
node_pubkey (str): base58 encoded public key.
Returns:
The last block the node has voted on. If the node didn't cast
any vote then the genesis block is returned.
The last block id the node has voted on. If the node didn't cast
any vote then the genesis block id is returned.
"""
raise NotImplementedError

View File

@ -641,8 +641,24 @@ class Bigchain(object):
return self.block_election(block)['status']
def get_assets(self, asset_ids):
# TODO: write docstrings
"""
Return a list of assets that match the asset_ids
Args:
asset_ids (:obj:`list` of :obj:`str`): A list of asset_ids to
retrieve from the database.
Returs:
list: The list of assets returned from the database.
"""
return backend.query.get_assets(self.connection, asset_ids)
def write_assets(self, assets):
"""
Writes a list of assets into the database.
Args:
assets (:obj:`list` of :obj:`dict`): A list of assets to write to
the database.
"""
return backend.query.write_assets(self.connection, assets)

View File

@ -88,8 +88,22 @@ class Transaction(Transaction):
@classmethod
def from_db(cls, bigchain, tx_dict):
# TODO: write docstring
if tx_dict['operation'] in [Transaction.CREATE, Transaction.CREATE]:
"""
Helper method that reconstructs a transaction dict that was returned
from the database. It checks what asset_id to retrieve, retrieves the
asset from the asset table and reconstructs the transaction.
Args:
bigchain (:class:`~bigchaindb.Bigchain`): An instance of Bigchain
used to perform database queries.
tx_dict (:obj:`dict`): The transaction dict as returned from the
database.
Returns:
:class:`~Transaction`
"""
if tx_dict['operation'] in [Transaction.CREATE, Transaction.GENESIS]:
# TODO: Maybe replace this call to a call to get_asset_by_id
asset = list(bigchain.get_assets([tx_dict['id']]))[0]
asset.pop('id')
@ -317,12 +331,14 @@ class Block(object):
def from_db(cls, bigchain, block_dict):
"""
Helper method that reconstructs a block_dict that was returned from
the database. If checks what asset_ids to retrieve, retrieves the
the database. It checks what asset_ids to retrieve, retrieves the
assets from the assets table and reconstructs the block.
Args:
bigchain (:class:`~bigchaindb.Bigchain`): An instance of Bigchain
used to perform database queries.
block_dict(:obj:`dict`): The block dict as returned from the
database.
Returns:
:class:`~Block`

View File

@ -281,7 +281,7 @@ class TestBlockModel(object):
# decouple assets
assets_from_block, block_dict = block.decouple_assets()
# write the assets and block separatedly
# write the assets and block separately
b.write_assets(assets_from_block)
b.write_block(block)