-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0f09377
commit 818ed36
Showing
3 changed files
with
163 additions
and
115 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import inspect | ||
|
|
||
|
|
||
| class ModuleRouter: | ||
| def __init__(self, mod): # module | ||
| self._module = mod | ||
| if self._is_valid_module(): | ||
| self.model_add_router() | ||
|
|
||
| def model_add_router(self): | ||
| if hasattr(self._module, '__routes__') and len(self._module.__routes__): | ||
| route_type, route_data = self._routing_type(route=self._module.__routes__.pop(0)) | ||
| if route_type == 'cls': | ||
| """ If it's a class it needs to extract the methods by function names | ||
| magic functions are excluded | ||
| """ | ||
| route_name, slug, cls = route_data | ||
| self.class_member_route(route=route_data, members=self.get_cls_fn_members(cls)) | ||
|
|
||
| elif route_type == 'fn': | ||
| route_name, slug, fn, methods = route_data | ||
|
|
||
| self._module.__method__.add_url_rule( | ||
| rule=slug, | ||
| endpoint=fn.__name__, | ||
| view_func=fn, | ||
| methods=methods) | ||
| self.model_add_router() | ||
|
|
||
| def _is_valid_module(self): | ||
| return hasattr(self._module, '__routes__') or hasattr(self._module, '__method__') | ||
|
|
||
| @staticmethod | ||
| def _routing_type(route): | ||
| __type = None | ||
| if isinstance(route, tuple): | ||
| if len(route) == 3 and inspect.isclass(route[2]): | ||
| __type = 'cls' | ||
| elif len(route) == 4 and inspect.isfunction(route[2]): | ||
| if isinstance(route[3], (list, tuple, set)): | ||
| __type = 'fn' | ||
| else: | ||
| raise TypeError("methods must be a list.") | ||
| else: | ||
| raise TypeError("Invalid route syntax.") | ||
| return __type, route | ||
|
|
||
| @staticmethod | ||
| def get_http_methods(names): | ||
| if isinstance(names, list): | ||
| methods = [] | ||
|
|
||
| for name in names: | ||
| if "__" not in name: | ||
| if name == "index": | ||
| methods.append('GET') | ||
| elif name == "create": | ||
| methods.append('POST') | ||
| elif name == "update": | ||
| methods.append('PUT') | ||
| elif name == "destroy": | ||
| methods.append('DELETE') | ||
| else: | ||
| methods.append('GET') | ||
|
|
||
| return methods | ||
| else: | ||
| raise TypeError("names must be a list") | ||
|
|
||
| @staticmethod | ||
| def get_cls_fn_members(cls): | ||
| return [member for member in inspect.getmembers(cls, predicate=inspect.isfunction)] | ||
|
|
||
| def class_member_route(self, route, members): | ||
| if isinstance(members, (list, set)): | ||
| if len(members): | ||
| (fn_name, fn_object) = members.pop(0) | ||
| route_name, slug, cls = route | ||
| if inspect.isfunction(fn_object): | ||
| self._module.__method__.add_url_rule( | ||
| rule=slug, | ||
| endpoint=fn_name, | ||
| view_func=fn_object, | ||
| methods=self.get_http_methods([fn_name])) | ||
| else: | ||
| raise KeyError("Member is not a function.") | ||
| self.class_member_route(route, members) | ||
| else: | ||
| raise TypeError("members must be a list.") | ||
|
|
||
| def register_route(self, app, name): | ||
| app.register_blueprint(self._module.__method__, url_prefix=self.blueprint_name(name)) | ||
|
|
||
| @staticmethod | ||
| def blueprint_name(name): | ||
|
|
||
| root_module = name.replace(".", "") | ||
|
|
||
| name = str(name).replace(root_module, "") | ||
| """ set index automatically as home page """ | ||
| if "index" in name: | ||
| name = str(name).replace("index", "") | ||
| if "routes" in name: | ||
| name = str(name).replace("routes", "") | ||
| if "module" in name: | ||
| name = str(name).replace("module", "") | ||
|
|
||
| """ remove the last . in the string it it ends with a . | ||
| for the url structure must follow the flask routing format | ||
| it should be /model/method instead of /model/method/ | ||
| """ | ||
| if name[-1:] == ".": | ||
| name = name[:-1] | ||
| http_name = str(name).replace(".", "/") | ||
|
|
||
| return http_name |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import inspect | ||
| import pkgutil | ||
| from module_router import ModuleRouter | ||
|
|
||
|
|
||
| class PackageExtractor: | ||
|
|
||
| __packages = None | ||
|
|
||
| def __init__(self, application, path): | ||
| self.path = path | ||
| self.application = application | ||
| _packages = self.__inspect_packages(packages=pkgutil.walk_packages(path, prefix="", onerror=None)) | ||
| self.extract_packages(packages=_packages) | ||
|
|
||
| @staticmethod | ||
| def __inspect_packages(packages): | ||
| if inspect.isgenerator(packages): | ||
| packages = [package for package in packages] | ||
|
|
||
| if isinstance(packages, (list, set)): | ||
| if len(packages): | ||
| return packages | ||
| else: | ||
| raise ValueError("Package does not have an item.") | ||
|
|
||
| def extract_packages(self, packages): | ||
| if len(packages): | ||
| loader, name, is_pkg = packages.pop(0) | ||
| """ if module found load module and save all attributes in the module found """ | ||
| mod = loader.find_module(name).load_module(name) | ||
|
|
||
| """ find the attribute method on each module """ | ||
| if hasattr(mod, '__method__'): | ||
| module_router = ModuleRouter(mod) | ||
|
|
||
| """ register to the blueprint if method attribute found """ | ||
| module_router.register_route(app=self.application, name=name) | ||
|
|
||
| else: | ||
| """ prompt not found notification """ | ||
| # print('{} has no module attribute method'.format(mod)) | ||
| pass | ||
| self.extract_packages(packages) | ||
|
|