rattail/rattail-tempmon
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve docstrings for some model attributes

Browse source
This commit is contained in:
Lance Edgar 2018-10-06 17:39:54 -05:00
parent 85e8ed9832
commit 440abf2b56
1 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
rattail_tempmon/db/model.py
View file

@ -70,15 +70,25 @@ class Client(Base):
Any arbitrary notes for the client. Any arbitrary notes for the client.
""") """)
enabled = sa.Column(sa.Boolean(), nullable=False, default=False) enabled = sa.Column(sa.Boolean(), nullable=False, default=False, doc="""
online = sa.Column(sa.Boolean(), nullable=False, default=False) Whether the client should be considered enabled (active). If set, the
client will be expected to take readings (but only for "enabled" probes)
and the server will monitor them to ensure they are within the expected
range etc.
""")
online = sa.Column(sa.Boolean(), nullable=False, default=False, doc="""
Whether the client is known to be online currently. When a client takes
readings, it will mark itself as online. If the server notices that the
readings have stopped, it will mark the client as *not* online.
""")
archived = sa.Column(sa.Boolean(), nullable=False, default=False, doc=""" archived = sa.Column(sa.Boolean(), nullable=False, default=False, doc="""
Flag indicating this client is "archived". This typically means that the Flag indicating this client is "archived". This typically means that the
client itself no longer exists etc. but that the configuration for it client itself no longer exists but that the configuration for it should be
should be retained, e.g. to be used as a reference later etc. Note that retained, to be used as a reference later etc. Note that "archiving" a
"archiving" a client is different from "disabling" it; the latter being client is different from "disabling" it; i.e. disabling is temporary and
more temporary. archiving is more for the long term.
""") """)
def __str__(self): def __str__(self):
@ -124,8 +134,19 @@ class Probe(Base):
good_temp_max = sa.Column(sa.Integer(), nullable=False) good_temp_max = sa.Column(sa.Integer(), nullable=False)
critical_temp_min = sa.Column(sa.Integer(), nullable=False) critical_temp_min = sa.Column(sa.Integer(), nullable=False)
critical_temp_max = sa.Column(sa.Integer(), nullable=False) critical_temp_max = sa.Column(sa.Integer(), nullable=False)
therm_status_timeout = sa.Column(sa.Integer(), nullable=False)
status_alert_timeout = sa.Column(sa.Integer(), nullable=False) therm_status_timeout = sa.Column(sa.Integer(), nullable=False, doc="""
Number of minutes the temperature is allowed to be "high" before the first
"high temp" email alert is sent. This is typically meant to account for
the length of the defrost cycle. Note that this does *not* affect the
"critical temp" emails; those are sent as soon as critical temp is reached.
""")
status_alert_timeout = sa.Column(sa.Integer(), nullable=False, doc="""
Number of minutes between successive "high/critical temp" emails. These
alerts will continue to be sent until the temperature returns to normal
range.
""")
notes = sa.Column(sa.Text(), nullable=True, doc=""" notes = sa.Column(sa.Text(), nullable=True, doc="""
Any arbitrary notes for the probe. Any arbitrary notes for the probe.