From b31213c55c8d704c049c2d9b112a8feb65887523 Mon Sep 17 00:00:00 2001 From: schdwlk Date: Wed, 8 Apr 2020 19:45:05 +0200 Subject: [PATCH] Updated __init__ comments --- communicator.py | 3 ++- consumerlocator.py | 9 ++++----- messagesender.py | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/communicator.py b/communicator.py index 027d0d8..c3f8298 100644 --- a/communicator.py +++ b/communicator.py @@ -21,7 +21,8 @@ class Communicator: """ def __init__(self, currentconsumer: str, uuid: str): - """Initialize object + """**Constructor:** + Initializes the object. :param consumerlocator: the current consumer's IP address as a string :param uuid: string typed UUID. diff --git a/consumerlocator.py b/consumerlocator.py index 1e08348..b2fc4af 100644 --- a/consumerlocator.py +++ b/consumerlocator.py @@ -8,7 +8,6 @@ import datetime from communicator import Communicator import os - __author__ = "@dscharnitzky" __copyright__ = "Copyright 2020, GoldenPogácsa Team" __module_name__ = "consumerlocator" @@ -23,13 +22,13 @@ class ConsumerLocator: """ def __init__(self, uuid: str, communicator: Communicator): - """Initializes the object. + """**Constructor:** + Initializes the object. Gets the known consumer's IP address from the PRODUCER_KNOWNCONSUMER envar. - :param str uuid: Not used - :param communicator: the :class:'communicator.Communicator' instance that will be used for the low level - communication. + :param uuid: Not used + :param communicator: the :class:'communicator.Communicator' instance that will be used for the low level communication. """ self.consumerlist = [{"Host": KNOWNCONSUMER, "State": True, "LastOk": datetime.datetime.now()}] self.currentconsumer = self.consumerlist[0] diff --git a/messagesender.py b/messagesender.py index 3c46e91..a7ea607 100644 --- a/messagesender.py +++ b/messagesender.py @@ -24,7 +24,8 @@ class MessageSender: """ def __init__(self, communicator: Communicator): - """Initializes the object. + """**Constructor:** + Initializes the object. :param communicator: an instance of :class:`communicator.Communicator`. """