[COMMENT] Added Code Comments

This commit is contained in:
fspitzba 2020-10-15 20:39:02 +02:00
parent 08a4c4d3c1
commit 7755536da1

View file

@ -4,7 +4,8 @@
# since 3.5: type hints # since 3.5: type hints
# def <name>(<args) -> <returntype>: # def <name>(<args) -> <returntype>:
import asyncio # write concurrent code (not threading. not multiprocessing) import asyncio
# write concurrent code (not threading. not multiprocessing)
# it's cooperative multitasking, no parallelism # it's cooperative multitasking, no parallelism
# coroutines: suspend execution before return and pass control to another coroutine # coroutines: suspend execution before return and pass control to another coroutine
# use await only in async functions # use await only in async functions
@ -34,13 +35,34 @@ from telepot.namedtuple import InlineKeyboardMarkup, InlineKeyboardButton
class Essen: class Essen:
""" Test Docstring """ """Class which represents a Essen-Object"""
def __init__(self, name, preis, kategorie): def __init__(self, name, preis, kategorie) -> None:
"""
Initialize a Essen-Object with given values
Parameters:
name (string): name of the meal
preis (float): price of the meal
kategorie (string): category of the meal
Returns:
None
"""
self.name = name self.name = name
self.preis = preis self.preis = preis
self.kategorie = kategorie self.kategorie = kategorie
return None
def __str__(self): def __str__(self) -> str:
"""
Formats the attribute of the Essen-Object to a string
Parameters:
None
Returns:
_ (string): formatted String of attributes
"""
if self.preis > 0: if self.preis > 0:
return str("*%s*: `%s` (%.2f €)" % (self.kategorie, self.name, self.preis)) return str("*%s*: `%s` (%.2f €)" % (self.kategorie, self.name, self.preis))
else: else:
@ -54,13 +76,15 @@ class Language(Enum):
config_filename = "config.json" config_filename = "config.json"
info_str = "*Inoffizieller Mensa-Bot der Hochschule Mittweida*\nDieser Bot versendet jeden Tag um 10 Uhr den aktuellen " \ info_str = '''
"Mensa-Speiseplan. Er wird über /start für den aktuellen Chat oder die aktuelle Gruppe gestartet, " \ *Inoffizieller Mensa-Bot der Hochschule Mittweida*\nDieser Bot versendet jeden Tag um 10 Uhr den aktuellen
"/stop beendet ihn wieder. Mit /essen, /mensa und /speiseplan (optional gefolgt von _en_ oder _de_) kann " \ Mensa-Speiseplan. Er wird über /start für den aktuellen Chat oder die aktuelle Gruppe gestartet,
"der aktuelle Speiseplan manuell abgerufen werden. Mit /settings kann (von Gruppenadmins) die Sprache " \ /stop beendet ihn wieder. Mit /essen, /mensa und /speiseplan (optional gefolgt von _en_ oder _de_) kann
"verändert werden.\n\n_Haftungsausschluss: Dieser Bot steht in keiner Verbindung mit der Hochschule " \ der aktuelle Speiseplan manuell abgerufen werden. Mit /settings kann (von Gruppenadmins) die Sprache
"Mittweida oder dem Studentenwerk Freiberg. Alle Angaben ohne Gewähr._\n\nGrafik bereitgestellt von [" \ verändert werden.\n\n_Haftungsausschluss: Dieser Bot steht in keiner Verbindung mit der Hochschule
"vecteezy.com](https://de.vecteezy.com) " Mittweida oder dem Studentenwerk Freiberg. Alle Angaben ohne Gewähr._\n\nGrafik bereitgestellt von [
vecteezy.com](https://de.vecteezy.com)
'''
status = "" status = ""
essen = [] essen = []
essen_eng = [] essen_eng = []