a9fff24848
The update to pylint means we were failing because open() doesn't specify the encoding everywhere. I have now specified utf-8 everywhere. This was patchy before, and is default behaviour on the Pi. There's a slim chance it will cause some issues on Windows, but that shouldn't affect anyone outside the developers. I've also ignored a couple of new spurious warnings, and explicitly ignored some unused variables.
88 lines
2.4 KiB
Python
88 lines
2.4 KiB
Python
import errno
|
|
import logging
|
|
import os
|
|
from typing import Union
|
|
|
|
from flask import Blueprint, Flask, current_app, url_for
|
|
from flask.views import View
|
|
|
|
from . import gui
|
|
|
|
__all__ = [
|
|
"gui",
|
|
"view_class_from_endpoint",
|
|
"blueprint_for_module",
|
|
"get_bool",
|
|
"list_routes",
|
|
"create_file",
|
|
"init_default_extensions",
|
|
]
|
|
|
|
|
|
def view_class_from_endpoint(endpoint: str) -> View:
|
|
return current_app.view_functions[endpoint].view_class
|
|
|
|
|
|
def blueprint_for_module(module_name: str, api_ver: int = 2, suffix: str = ""):
|
|
return Blueprint(
|
|
blueprint_name_for_module(module_name, api_ver=api_ver, suffix=suffix),
|
|
module_name,
|
|
)
|
|
|
|
|
|
def blueprint_name_for_module(module_name: str, api_ver: int = 2, suffix: str = ""):
|
|
bp_name = module_name.split(".")[-1]
|
|
return f"v{api_ver}_{bp_name}_blueprint{suffix}"
|
|
|
|
|
|
def get_bool(get_arg: Union[bool, str]):
|
|
"""Convert GET request argument string to a Python bool"""
|
|
if isinstance(get_arg, bool):
|
|
return get_arg
|
|
elif get_arg == "true" or get_arg == "True" or get_arg == "1":
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
|
|
def list_routes(app: Flask):
|
|
output = {}
|
|
for rule in app.url_map.iter_rules():
|
|
|
|
options = {}
|
|
for arg in rule.arguments:
|
|
options[arg] = "[{0}]".format(arg)
|
|
|
|
endpoint = rule.endpoint
|
|
methods = list(rule.methods)
|
|
url = url_for(rule.endpoint, **options)
|
|
line = {"endpoint": endpoint, "methods": methods}
|
|
output[url] = line
|
|
|
|
return output
|
|
|
|
|
|
def create_file(config_path: str):
|
|
if not os.path.exists(os.path.dirname(config_path)):
|
|
try:
|
|
os.makedirs(os.path.dirname(config_path))
|
|
except OSError as exc: # Guard against race condition
|
|
if exc.errno != errno.EEXIST:
|
|
raise
|
|
|
|
|
|
def init_default_extensions(extension_dir: str):
|
|
os.makedirs(extension_dir, exist_ok=True)
|
|
|
|
default_ext_path = os.path.join(extension_dir, "defaults.py")
|
|
|
|
if not os.path.isfile(default_ext_path): # If user extensions file doesn't exist
|
|
logging.warning("No extension file found at %s. Creating...", (extension_dir))
|
|
create_file(default_ext_path)
|
|
|
|
logging.info("Populating %s...", (default_ext_path))
|
|
with open(default_ext_path, "w", encoding="utf-8") as outfile:
|
|
outfile.write(_DEFAULT_EXTENSION_INIT)
|
|
|
|
|
|
_DEFAULT_EXTENSION_INIT = "from openflexure_microscope.api.default_extensions import *"
|