Sort functions alphabetical and fill out docstrings
This commit is contained in:
@ -45,13 +45,6 @@ app = FastAPI()
|
||||
templates = Jinja2Templates(directory="templates")
|
||||
|
||||
|
||||
@cache
|
||||
@app.get("/favicon.ico", include_in_schema=False)
|
||||
async def favicon():
|
||||
"""Return favicon."""
|
||||
return FileResponse('static/favicon.ico')
|
||||
|
||||
|
||||
@app.post("/check", response_class=HTMLResponse)
|
||||
def check_feed(request: Request, feed_url: str = Form()):
|
||||
"""Check all feeds"""
|
||||
@ -65,21 +58,91 @@ def check_feed(request: Request, feed_url: str = Form()):
|
||||
return templates.TemplateResponse("feed.html", {"request": request, "feed": feed})
|
||||
|
||||
|
||||
@app.on_event('startup')
|
||||
def startup():
|
||||
"""This is called when the server starts.
|
||||
@app.post("/add")
|
||||
async def create_feed(feed_url: str = Form(), webhook_dropdown: str = Form()):
|
||||
"""
|
||||
Add a feed to the database.
|
||||
|
||||
It reads the settings file and starts the scheduler."""
|
||||
Args:
|
||||
feed_url: The feed to add.
|
||||
webhook_dropdown: The webhook to use.
|
||||
|
||||
Returns:
|
||||
dict: The feed that was added.
|
||||
"""
|
||||
logger.info(f"Add feed: {feed_url}")
|
||||
logger.info(f"Webhook: {webhook_dropdown}")
|
||||
|
||||
# Update a single feed. The feed will be updated even if updates are disabled for it.
|
||||
updated_feed = update_feed(feed_url, webhook_dropdown)
|
||||
|
||||
# Add a new feed to the database.
|
||||
added_feed = add_feed(feed_url, webhook_dropdown)
|
||||
|
||||
if updated_feed.error or added_feed.error:
|
||||
error_dict = {"error": updated_feed.error, "feed": updated_feed.feed_url, "webhook": updated_feed.webhook,
|
||||
"exception": updated_feed.exception}
|
||||
return HTTPException(status_code=500, detail=error_dict)
|
||||
|
||||
# Check if set_hook_by_name() was successful.
|
||||
if isinstance(set_hook_by_name(name=webhook_dropdown, feed_url=feed_url), ResourceNotFoundError):
|
||||
return set_hook_by_name(name=webhook_dropdown, feed_url=feed_url)
|
||||
|
||||
new_tag = reader.get_tag(feed_url, "webhook")
|
||||
logger.info(f"New tag: {new_tag}")
|
||||
return {"feed_url": str(feed_url), "status": "added"}
|
||||
|
||||
|
||||
def create_list_of_webhooks():
|
||||
"""List with webhooks."""
|
||||
logger.info("Creating list with webhooks.")
|
||||
settings = read_settings_file()
|
||||
list_of_webhooks = dict()
|
||||
for hook in settings["webhooks"]:
|
||||
logger.info(f"Webhook name: {hook} with URL: {settings['webhooks'][hook]}")
|
||||
list_of_webhooks[hook] = settings["webhooks"][hook]
|
||||
|
||||
if not settings["webhooks"]:
|
||||
logger.critical("No webhooks found in settings file.")
|
||||
sys.exit()
|
||||
for key in settings["webhooks"]:
|
||||
logger.info(f"Webhook name: {key} with URL: {settings['webhooks'][key]}")
|
||||
logger.info(f"List of webhooks: {list_of_webhooks}")
|
||||
return enum.Enum("DiscordWebhooks", list_of_webhooks)
|
||||
|
||||
scheduler = BackgroundScheduler()
|
||||
scheduler.start()
|
||||
|
||||
@cache
|
||||
@app.get("/favicon.ico", include_in_schema=False)
|
||||
async def favicon():
|
||||
"""Return favicon."""
|
||||
return FileResponse('static/favicon.ico')
|
||||
|
||||
|
||||
@app.get("/add", response_class=HTMLResponse)
|
||||
def get_add(request: Request):
|
||||
"""
|
||||
Page for adding a new feed.
|
||||
|
||||
Args:
|
||||
request: The request.
|
||||
|
||||
Returns:
|
||||
HTMLResponse: The HTML response.
|
||||
"""
|
||||
context = make_context_index(request)
|
||||
return templates.TemplateResponse("add.html", context)
|
||||
|
||||
|
||||
@app.post("/feed", response_class=HTMLResponse)
|
||||
async def get_feed(request: Request, feed_url: str = Form()):
|
||||
"""
|
||||
Get a feed by URL.
|
||||
|
||||
Args:
|
||||
request: The request.
|
||||
feed_url: The feed to add.
|
||||
|
||||
Returns:
|
||||
HTMLResponse: The HTML response.
|
||||
"""
|
||||
logger.info(f"Get feed: {feed_url}")
|
||||
feed = reader.get_feed(feed_url)
|
||||
return templates.TemplateResponse("feed.html", {"request": request, "feed": feed})
|
||||
|
||||
|
||||
@app.get("/", response_class=HTMLResponse)
|
||||
@ -148,84 +211,21 @@ async def remove_feed(request: Request, feed_url: str = Form()):
|
||||
return templates.TemplateResponse("index.html", {"request": request, "feed": feed})
|
||||
|
||||
|
||||
@app.post("/feed", response_class=HTMLResponse)
|
||||
async def get_feed(request: Request, feed_url: str = Form()):
|
||||
"""
|
||||
Get a feed by URL.
|
||||
@app.on_event('startup')
|
||||
def startup():
|
||||
"""This is called when the server starts.
|
||||
|
||||
Args:
|
||||
request: The request.
|
||||
feed_url: The feed to add.
|
||||
|
||||
Returns:
|
||||
HTMLResponse: The HTML response.
|
||||
"""
|
||||
logger.info(f"Get feed: {feed_url}")
|
||||
feed = reader.get_feed(feed_url)
|
||||
return templates.TemplateResponse("feed.html", {"request": request, "feed": feed})
|
||||
|
||||
|
||||
def create_list_of_webhooks():
|
||||
"""List with webhooks."""
|
||||
logger.info("Creating list with webhooks.")
|
||||
It reads the settings file and starts the scheduler."""
|
||||
settings = read_settings_file()
|
||||
list_of_webhooks = dict()
|
||||
for hook in settings["webhooks"]:
|
||||
logger.info(f"Webhook name: {hook} with URL: {settings['webhooks'][hook]}")
|
||||
list_of_webhooks[hook] = settings["webhooks"][hook]
|
||||
|
||||
logger.info(f"List of webhooks: {list_of_webhooks}")
|
||||
return enum.Enum("DiscordWebhooks", list_of_webhooks)
|
||||
if not settings["webhooks"]:
|
||||
logger.critical("No webhooks found in settings file.")
|
||||
sys.exit()
|
||||
for key in settings["webhooks"]:
|
||||
logger.info(f"Webhook name: {key} with URL: {settings['webhooks'][key]}")
|
||||
|
||||
|
||||
@app.post("/add")
|
||||
async def create_feed(feed_url: str = Form(), webhook_dropdown: str = Form()):
|
||||
"""
|
||||
Add a feed to the database.
|
||||
|
||||
Args:
|
||||
feed_url: The feed to add.
|
||||
webhook_dropdown: The webhook to use.
|
||||
|
||||
Returns:
|
||||
dict: The feed that was added.
|
||||
"""
|
||||
logger.info(f"Add feed: {feed_url}")
|
||||
logger.info(f"Webhook: {webhook_dropdown}")
|
||||
|
||||
# Update a single feed. The feed will be updated even if updates are disabled for it.
|
||||
updated_feed = update_feed(feed_url, webhook_dropdown)
|
||||
|
||||
# Add a new feed to the database.
|
||||
added_feed = add_feed(feed_url, webhook_dropdown)
|
||||
|
||||
if updated_feed.error or added_feed.error:
|
||||
error_dict = {"error": updated_feed.error, "feed": updated_feed.feed_url, "webhook": updated_feed.webhook,
|
||||
"exception": updated_feed.exception}
|
||||
return HTTPException(status_code=500, detail=error_dict)
|
||||
|
||||
# Check if set_hook_by_name() was successful.
|
||||
if isinstance(set_hook_by_name(name=webhook_dropdown, feed_url=feed_url), ResourceNotFoundError):
|
||||
return set_hook_by_name(name=webhook_dropdown, feed_url=feed_url)
|
||||
|
||||
new_tag = reader.get_tag(feed_url, "webhook")
|
||||
logger.info(f"New tag: {new_tag}")
|
||||
return {"feed_url": str(feed_url), "status": "added"}
|
||||
|
||||
|
||||
@app.get("/add", response_class=HTMLResponse)
|
||||
def get_add(request: Request):
|
||||
"""
|
||||
Page for adding a new feed.
|
||||
|
||||
Args:
|
||||
request: The request.
|
||||
|
||||
Returns:
|
||||
HTMLResponse: The HTML response.
|
||||
"""
|
||||
context = make_context_index(request)
|
||||
return templates.TemplateResponse("add.html", context)
|
||||
scheduler = BackgroundScheduler()
|
||||
scheduler.start()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
Reference in New Issue
Block a user