ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-25 15:41:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document parameters of ResultsRenderer classes

Browse Source
This commit is contained in:
Sajith Sasidharan 2020-06-16 09:40:37 -04:00
parent 79be795566
commit 22977352bb
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/allmydata/web/check_results.py
View File

@ -214,6 +214,9 @@ class LiteralCheckResultsRenderer(MultiFormatResource, ResultsBase):
formatArgument = "output" formatArgument = "output"
def __init__(self, client): def __init__(self, client):
"""
:param allmydata.interfaces.IStatsProducer client: stats provider.
"""
super(LiteralCheckResultsRenderer, self).__init__() super(LiteralCheckResultsRenderer, self).__init__()
self.client = client self.client = client
@ -261,9 +264,8 @@ class CheckResultsRenderer(MultiFormatResource):
def __init__(self, client, results): def __init__(self, client, results):
""" """
TODO: update these with the correct values. :param allmydata.interfaces.IStatsProducer client: stats provider.
:param allmydata.test.no_network._NoNetworkClient client: :param allmydata.interfaces.ICheckResults results: results of check/vefify operation.
:param allmydata.check_results.CheckResults results:
""" """
super(CheckResultsRenderer, self).__init__() super(CheckResultsRenderer, self).__init__()
self.client = client self.client = client
@ -327,10 +329,12 @@ class CheckAndRepairResultsRenderer(MultiFormatResource):
formatArgument = "output" formatArgument = "output"
def __init__(self, client, results): def __init__(self, client, results):
# TODO: document params """
:param allmydata.interfaces.IStatsProducer client: stats provider.
:param allmydata.interfaces.ICheckResults results: check/verify results.
"""
super(CheckAndRepairResultsRenderer, self).__init__() super(CheckAndRepairResultsRenderer, self).__init__()
self.client = client self.client = client
# TODO: use a better name
self.check_results = None self.check_results = None
if results: if results:
self.check_results = ICheckAndRepairResults(results) self.check_results = ICheckAndRepairResults(results)
@ -395,7 +399,10 @@ class DeepCheckResultsRenderer(MultiFormatResource):
formatArgument = "output" formatArgument = "output"
def __init__(self, client, monitor): def __init__(self, client, monitor):
# TODO: document params """
:param allmydata.interfaces.IStatsProducer client: stats provider.
:param allmydata.monitor.IMonitor monitor: status, progress, and cancellation provider.
"""
super(DeepCheckResultsRenderer, self).__init__() super(DeepCheckResultsRenderer, self).__init__()
self.client = client self.client = client
self.monitor = monitor self.monitor = monitor
@ -586,6 +593,10 @@ class DeepCheckAndRepairResultsRenderer(MultiFormatResource):
formatArgument = "output" formatArgument = "output"
def __init__(self, client, monitor): def __init__(self, client, monitor):
"""
:param allmydata.interfaces.IStatsProducer client: stats provider.
:param allmydata.monitor.IMonitor monitor: status, progress, and cancellation provider.
"""
self.client = client self.client = client
self.monitor = monitor self.monitor = monitor
self.children = {} self.children = {}
@ -656,7 +667,6 @@ class DeepCheckAndRepairResultsRendererElement(Element, ResultsBase, ReloadMixin
loader = XMLFile(FilePath(__file__).sibling("deep-check-and-repair-results.xhtml")) loader = XMLFile(FilePath(__file__).sibling("deep-check-and-repair-results.xhtml"))
def __init__(self, monitor): def __init__(self, monitor):
# TODO: document params
super(DeepCheckAndRepairResultsRendererElement, self).__init__() super(DeepCheckAndRepairResultsRendererElement, self).__init__()
self.monitor = monitor self.monitor = monitor