Merge pull request #3 from CoderChen01/cjj_dev

The configuration system is initially realized.

Author: CoderChen01

opendigger_pycli/cli/__init__.py

@@ -1,10 +1,10 @@
 from .base import opendigger_cmd as opendigger
 from .base import query_cmd as query
-from .config_cmd import config
-from .display_cmd import display
-from .export_cmd import export
-from .monitor_cmd import monitor
-from .report_cmd import report
+from .commands.config_cmd import config
+from .commands.display_cmd import display
+from .commands.export_cmd import export
+from .commands.monitor_cmd import monitor
+from .commands.report_cmd import report
 
 opendigger.add_command(config)
 

opendigger_pycli/cli/base.py

@@ -1,6 +1,8 @@
 import typing as t
 
 import click
+from click_plugins import with_plugins
+from pkg_resources import iter_entry_points  # type: ignore
 
 from opendigger_pycli.console import CONSOLE
 from opendigger_pycli.console.print_base_info import (
@@ -84,7 +86,7 @@ def user(env: Environment, usernames: t.List[str]):
     if click.get_current_context().invoked_subcommand is None:
         env.vlog("[bold green]requesting users info...")
         with CONSOLE.status("[bold green]requesting users info..."):
-            env.dlog(print_user_info(usernames, env.cli_config.github_pat))
+            env.dlog(print_user_info(usernames, env.cli_config.app_keys.github_pat))
             env.vlog("[bold green]end requesting users info...")
             return
 
@@ -122,7 +124,7 @@ def repo(env: Environment, repos: t.List[t.Tuple[str, str]]):
     if click.get_current_context().invoked_subcommand is None:
         env.vlog("[bold green]fetching repos info...")
         with CONSOLE.status("[bold green]fetching repos info..."):
-            env.dlog(print_repo_info(repos, env.cli_config.github_pat))
+            env.dlog(print_repo_info(repos, env.cli_config.app_keys.github_pat))
             env.vlog("[bold green]end fetching repos info...")
         return
 
@@ -135,6 +137,7 @@ def repo(env: Environment, repos: t.List[t.Tuple[str, str]]):
     env.vlog("Set params to env")
 
 
+@with_plugins(iter_entry_points("opendigger-pycli.plugins"))  # type: ignore
 @click.group(  # type: ignore
     chain=True,
     help="Query indicators",

opendigger_pycli/config/__init__.py renamed to opendigger_pycli/cli/commands/___init__.py

@@ -7,7 +7,7 @@
 from opendigger_pycli.results.display import DisplyCMDResult
 from opendigger_pycli.utils.decorators import processor
 
-from .base import pass_environment
+from ..base import pass_environment
 
 if t.TYPE_CHECKING:
     from opendigger_pycli.console.print_indicator import SURPPORTED_DISPLAY_FORMAT_TYPE

opendigger_pycli/cli/config_cmd.py renamed to opendigger_pycli/cli/commands/config_cmd.py

@@ -2,11 +2,12 @@
 
 import click
 
-from ..utils.decorators import processor
-from .base import pass_environment
+from opendigger_pycli.utils.decorators import processor
+
+from ..base import pass_environment
 
 if t.TYPE_CHECKING:
-    from .base import Environment
+    from ..base import Environment
 
 
 @click.command("export", help="Export metrics")

opendigger_pycli/cli/display_cmd.py renamed to opendigger_pycli/cli/commands/display_cmd.py

@@ -0,0 +1,89 @@
+import configparser
+import typing as t
+from dataclasses import dataclass, fields, is_dataclass
+from pathlib import Path
+
+import click
+from rich import box
+from rich.table import Table
+
+from opendigger_pycli.datatypes import ALL_CONFIGS, AppKeyConfig, UserInfoConfig
+
+if t.TYPE_CHECKING:
+    from rich.console import Console, ConsoleOptions, RenderResult
+
+
+class OpenDiggerCliConfig:
+    app_keys: AppKeyConfig
+    user_info: UserInfoConfig
+
+    def __init__(self):
+        self.__load_config()
+
+    @property
+    def user_config_file_path(self) -> str:
+        config_dir_str = click.get_app_dir("opendigger-pycli")
+        config_dir = Path(config_dir_str)
+        user_config = config_dir / "config.ini"
+        return str(user_config)
+
+    @property
+    def default_config_file_path(self) -> str:
+        default_config = Path(__file__).parent / "default_config.ini"
+        return str(default_config)
+
+    @property
+    def config_file_paths(self) -> t.List[str]:
+        return [str(self.default_config_file_path), str(self.user_config_file_path)]
+
+    def __load_config(self):
+        parser = configparser.RawConfigParser()
+        parser.read(self.config_file_paths)
+
+        for config_dataclass in ALL_CONFIGS:
+            if not is_dataclass(config_dataclass):
+                raise TypeError(f"{config_dataclass} is not a dataclass")
+
+            setattr(self, config_dataclass.config_name, config_dataclass())
+            config_fields = fields(config_dataclass)
+            for field in config_fields:
+                data = parser.get(
+                    config_dataclass.config_name, field.name, fallback=field.default
+                )
+                setattr(getattr(self, config_dataclass.config_name), field.name, data)
+
+    def update_config(self):
+        parser = configparser.RawConfigParser()
+
+        for config_dataclass in ALL_CONFIGS:
+            if not is_dataclass(config_dataclass):
+                raise TypeError(f"{config_dataclass} is not a dataclass")
+
+            config = getattr(self, config_dataclass.config_name, config_dataclass())
+            config_fields = fields(config_dataclass)
+            for field in config_fields:
+                parser.set(
+                    config_dataclass.config_name,
+                    field.name,
+                    getattr(config, field.name),
+                )
+
+        with open(self.user_config_file_path, "w") as file:
+            parser.write(file)
+
+    def __rich_console__(
+        self, console: "Console", options: "ConsoleOptions"
+    ) -> "RenderResult":
+        yield "[b]OpenDigger Python CLI Configs:[/b]"
+        for config_dataclass in ALL_CONFIGS:
+            if not is_dataclass(config_dataclass):
+                raise TypeError(f"{config_dataclass} is not a dataclass")
+
+            table = Table(
+                "Key", "Value", title=config_dataclass.config_name, box=box.HORIZONTALS  # type: ignore
+            )
+            config = getattr(self, config_dataclass.config_name, config_dataclass())  # type: ignore
+            config_fields = fields(config_dataclass)
+            for field in config_fields:
+                table.add_row(field.name, getattr(config, field.name))
+            yield table

opendigger_pycli/cli/export_cmd.py renamed to opendigger_pycli/cli/commands/export_cmd.py

@@ -0,0 +1,7 @@
+[app_keys]
+github_pat = ""
+openai_key = ""
+
+[user_info]
+name = ""
+email = ""