aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2025-12-17 14:14:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improves docstrings

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-04-17 18:03:12 +02:00
parent eea12a695e
commit 2e6095971d
7 changed files with 25 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
teos/builder.py
View File

@@ -1,13 +1,13 @@
class Builder:
"""
The :class:`Builder` class is in charge of reconstructing data loaded from the database and build the data
structures of the :obj:`Watcher <teos.watcher.Watcher>` and the :obj:`Responder <teos.responder.Responder>`.
The :class:`Builder` class is in charge of reconstructing data loaded from the appointments database and build the
data structures of the :obj:`Watcher <teos.watcher.Watcher>` and the :obj:`Responder <teos.responder.Responder>`.
"""
@staticmethod
def build_appointments(appointments_data):
"""
Builds an appointments dictionary (``uuid: ExtendedAppointment``) and a locator_uuid_map (``locator: uuid``)
Builds an appointments dictionary (``uuid:ExtendedAppointment``) and a locator_uuid_map (``locator:uuid``)
given a dictionary of appointments from the database.
Args:
@@ -43,7 +43,7 @@ class Builder:
@staticmethod
def build_trackers(tracker_data):
"""
Builds a tracker dictionary (``uuid: TransactionTracker``) and a tx_tracker_map (``penalty_txid: uuid``) given
Builds a tracker dictionary (``uuid:TransactionTracker``) and a tx_tracker_map (``penalty_txid:uuid``) given
a dictionary of trackers from the database.
Args:
@@ -85,8 +85,8 @@ class Builder:
:mod:`Responder <teos.responder.Responder>` using backed up data.
Args:
block_queue (:obj:`Queue`): a ``Queue``
missed_blocks (:obj:`list`): list of block hashes missed by the Watchtower (do to a crash or shutdown).
block_queue (:obj:`Queue`): a ``Queue``.
missed_blocks (:obj:`list`): list of block hashes missed by the Watchtower (due to a crash or shutdown).
Returns:
:obj:`Queue`: A ``Queue`` containing all the missed blocks hashes.