Last active
January 2, 2023 12:48
-
-
Save dot1mav/03efe7afcbda405fd954553516b2499f to your computer and use it in GitHub Desktop.
import blueprints auto for flask app
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import os | |
| from importlib import import_module | |
| from flask import Flask, Blueprint | |
| from typing import Optional, Union | |
| # custom type | |
| APPLICATION = Union[Flask, Blueprint] | |
| class AutoBlueprint: | |
| app: APPLICATION | |
| base_directory: str | |
| ignore_list: list | |
| blueprints_dir_name: str | |
| bp_module_name: str | |
| bp_modules: list | |
| def __init__(self, app: Optional[APPLICATION] = None, directory: str = "blueprints", module_name: str = "bp", | |
| ignore_list: Optional[list] = None) -> None: | |
| self.blueprints_dir_name = directory | |
| self.bp_module_name = module_name | |
| if ignore_list is None: | |
| self.ignore_list = [] | |
| else: | |
| self.ignore_list = ignore_list | |
| self.ignore_list.append("__pycache__") | |
| self.bp_modules = [] | |
| if app: | |
| self.init_app(app) | |
| def init_app(self, app: APPLICATION, load: bool = True) -> None: | |
| self.app = app | |
| self.base_directory = os.path.abspath(os.path.dirname(__file__)) | |
| if load: | |
| self.load_module() | |
| def load_module(self) -> None: | |
| self._load_directory() | |
| for module in self.bp_modules: | |
| try: | |
| bp = getattr(module, self.bp_module_name) | |
| self.app.register_blueprint(bp) | |
| except AttributeError as err: | |
| self.app.logger.warning(f"{err!r}") | |
| def _load_directory(self) -> None: | |
| for bp_module in os.listdir(os.path.join(self.base_directory, self.blueprints_dir_name)): | |
| bp_dir = os.path.join(self.base_directory, | |
| self.blueprints_dir_name, bp_module) | |
| if bp_module not in self.ignore_list and os.path.isdir(bp_dir): | |
| try: | |
| self.bp_modules.append(import_module(f'.{bp_module}', f'{self.app.import_name}.{self.blueprints_dir_name}')) | |
| except ModuleNotFoundError as err: | |
| self.app.logger.warning(f"{err!r}") |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment