robotcode-plugin 0.30.0__tar.gz → 0.31.0__tar.gz

{robotcode_plugin-0.30.0 → robotcode_plugin-0.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotcode-plugin
-Version: 0.30.0
+Version: 0.31.0
 Summary: Some classes for RobotCode plugin management
 Project-URL: Donate, https://github.com/sponsors/d-biehl
 Project-URL: Documentation, https://github.com/d-biehl/robotcode#readme

robotcode_plugin-0.31.0/robotcode/plugin/__init__.py

@@ -0,0 +1,118 @@
+from dataclasses import dataclass
+from enum import Enum, unique
+from pathlib import Path
+from typing import IO, Any, AnyStr, Callable, Dict, List, Optional, TypeVar, Union, cast
+
+import click
+import pluggy
+
+from robotcode.core.dataclasses import as_json
+
+__all__ = ["hookimpl", "CommonConfig", "pass_application"]
+
+F = TypeVar("F", bound=Callable[..., Any])
+hookimpl = cast(Callable[[F], F], pluggy.HookimplMarker("robotcode"))
+
+
+@unique
+class ColoredOutput(str, Enum):
+    AUTO = "auto"
+    YES = "yes"
+    NO = "no"
+
+
+@unique
+class OutputFormat(str, Enum):
+    TOML = "toml"
+    JSON = "json"
+    FLAT = "flat"
+
+    def __str__(self) -> str:
+        return self.value
+
+
+@dataclass
+class CommonConfig:
+    config_file: Optional[Path] = None
+    profiles: Optional[List[str]] = None
+    dry: bool = False
+    verbose: bool = False
+    colored_output: ColoredOutput = ColoredOutput.AUTO
+
+
+class Application:
+    def __init__(self) -> None:
+        self.config = CommonConfig()
+
+    @property
+    def colored(self) -> bool:
+        return self.config.colored_output in [ColoredOutput.AUTO, ColoredOutput.YES]
+
+    def verbose(
+        self,
+        message: Union[str, Callable[[], Any], None],
+        file: Optional[IO[AnyStr]] = None,
+        nl: bool = True,
+        err: bool = False,
+    ) -> None:
+        if self.config.verbose:
+            click.secho(
+                message() if callable(message) else message,
+                file=file,
+                nl=nl,
+                err=err,
+                color=self.colored,
+                fg="bright_black",
+            )
+
+    def warning(
+        self,
+        message: Union[str, Callable[[], Any], None],
+        file: Optional[IO[AnyStr]] = None,
+        nl: bool = True,
+        err: bool = False,
+    ) -> None:
+        click.secho(
+            f"WARNING: {message() if callable(message) else message}",
+            file=file,
+            nl=nl,
+            err=err,
+            color=self.colored,
+            fg="bright_yellow",
+        )
+
+    def print_dict(self, config: Dict[str, Any], format: OutputFormat) -> None:
+        text = None
+        if format == "toml":
+            try:
+                import tomli_w
+
+                text = tomli_w.dumps(config)
+            except ImportError:
+                self.warning("Package 'tomli_w' is required to use TOML output. Using JSON format instead.")
+                format = OutputFormat.JSON
+
+        if text is None:
+            text = as_json(config, indent=True)
+
+        if not text:
+            return
+
+        if self.colored:
+            try:
+                from rich.console import Console
+                from rich.syntax import Syntax
+
+                Console().print(Syntax(text, format, background_color="default"))
+
+                return
+            except ImportError:
+                if self.config.colored_output == ColoredOutput.YES:
+                    self.warning('Package "rich" is required to use colored output.')
+
+        click.echo(text)
+
+        return
+
+
+pass_application = click.make_pass_decorator(Application, ensure=True)

robotcode_plugin-0.31.0/robotcode/plugin/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.31.0"

robotcode_plugin-0.31.0/robotcode/plugin/click_helper.py

@@ -0,0 +1,23 @@
+from enum import Enum
+from typing import Any, Callable, Type, Union
+
+import click
+
+
+class EnumChoice(click.Choice):
+    """A click.Choice that accepts Enum values."""
+
+    def __init__(self, choices: Type[Enum], case_sensitive: bool = True) -> None:
+        super().__init__(choices, case_sensitive)  # type: ignore
+
+
+FC = Union[Callable[..., Any], click.Command]
+
+
+def add_options(*options: FC) -> FC:
+    def _add_options(func: FC) -> FC:
+        for option in reversed(options):
+            func = option(func)
+        return func
+
+    return _add_options

robotcode_plugin-0.30.0/robotcode/plugin/__init__.py

@@ -1,22 +0,0 @@
-from dataclasses import dataclass
-from pathlib import Path
-from typing import Any, Callable, List, Optional, TypeVar, cast
-
-import click
-import pluggy
-
-__all__ = ["hookimpl", "CommonConfig", "pass_common_config"]
-
-F = TypeVar("F", bound=Callable[..., Any])
-hookimpl = cast(Callable[[F], F], pluggy.HookimplMarker("robotcode"))
-
-
-@dataclass
-class CommonConfig:
-    config_file: Optional[Path] = None
-    profiles: Optional[List[str]] = None
-    dry: bool = False
-    verbose: bool = False
-
-
-pass_common_config = click.make_pass_decorator(CommonConfig, ensure=True)

robotcode_plugin-0.30.0/robotcode/plugin/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.30.0"