|
1 | 1 | import importlib |
2 | 2 | import pkgutil |
3 | | -from typing import Dict, Type |
| 3 | +import warnings |
| 4 | +from typing import Dict, Iterable, Type |
4 | 5 |
|
5 | 6 | from commitizen.cz.base import BaseCommitizen |
6 | 7 | from commitizen.cz.conventional_commits import ConventionalCommitsCz |
7 | 8 | from commitizen.cz.customize import CustomizeCommitsCz |
8 | 9 | from commitizen.cz.jira import JiraSmartCz |
9 | 10 |
|
| 11 | + |
| 12 | +def discover_plugins(path: Iterable[str] = None) -> Dict[str, Type[BaseCommitizen]]: |
| 13 | + """Discover commitizen plugins on the path |
| 14 | + |
| 15 | + Args: |
| 16 | + path (Path, optional): If provided, 'path' should be either None or a list of paths to look for |
| 17 | + modules in. If path is None, all top-level modules on sys.path.. Defaults to None. |
| 18 | + |
| 19 | + Returns: |
| 20 | + Dict[str, Type[BaseCommitizen]]: Registry with found plugins |
| 21 | + """ |
| 22 | + plugins = {} |
| 23 | + for finder, name, ispkg in pkgutil.iter_modules(path): |
| 24 | + try: |
| 25 | + if name.startswith("cz_"): |
| 26 | + plugins[name] = importlib.import_module(name).discover_this # type: ignore |
| 27 | + except AttributeError as e: |
| 28 | + warnings.warn(UserWarning(e.args[0])) |
| 29 | + continue |
| 30 | + return plugins |
| 31 | + |
| 32 | + |
10 | 33 | registry: Dict[str, Type[BaseCommitizen]] = { |
11 | 34 | "cz_conventional_commits": ConventionalCommitsCz, |
12 | 35 | "cz_jira": JiraSmartCz, |
13 | 36 | "cz_customize": CustomizeCommitsCz, |
14 | 37 | } |
15 | | -plugins = { |
16 | | - name: importlib.import_module(name).discover_this # type: ignore |
17 | | - for finder, name, ispkg in pkgutil.iter_modules() |
18 | | - if name.startswith("cz_") |
19 | | -} |
20 | 38 |
|
21 | | -registry.update(plugins) |
| 39 | +registry.update(discover_plugins()) |
0 commit comments