feat: new commands robot, rebot, libdoc for robotcode.runner

Author: d-biehl

.vscode/launch.json

@@ -44,15 +44,27 @@
 			"module": "robotcode.cli",
 			"justMyCode": false,
 			"cwd": "${workspaceFolder}/tests/robotcode/language_server/robotframework/parts/data",
+			// "env": {
+			// 	"ROBOTCODE_COLOR": "1",
+			// },
 			"args": [
-				//"-v",
-				"-p",
-				"firefox",
-				//"--dry",
-				// "run",
+				"--verbose",
+				"--dry",
+				// "-p",
+				// "firefox",
+				// "--dry",
+				// "robot",
+				// "--",
+				// "--help"
 				// "tests1"
-				"config",
-				"show"
+				// "profiles",
+
+				// "show",
+				// "list",
+				// "--format",
+				// "toml"
+				"rebot",
+
 			]
 		},
 		{

docs/cli/about.md

@@ -0,0 +1,3 @@
+# About Commandline Interface
+
+TODO

docs/cli/reference.md

@@ -0,0 +1,6 @@
+::: mkdocs-click
+    :module: robotcode.cli
+    :command: robotcode
+    :prog_name: robotcode
+    :remove_ascii_art: true
+    :list_subcommands: true

etc/robot.toml.json

@@ -78,18 +78,18 @@ matrix.rf.dependencies = [
 ]
 
 [envs.lint]
-skip-install = true
-extra-dependencies = ["tomli>=2.0.0"]
+#skip-install = true
+#extra-dependencies = ["tomli>=2.0.0"]
 features = ["all"]
 
 [envs.lint.scripts]
 typing = ["mypy --install-types --non-interactive {args:.}"]
 style = ["ruff .", "black --check --diff ."]
-fmt = ["ruff --fix .", "black .", "style"]
+fmt = ["black .", "ruff --fix .", "style"]
 all = ["style", "typing"]
 
 [envs.pages]
-detached = true
+#detached = true
 dependencies = [
   "mkdocs>=1.4.2",
   "mkdocs-material",

hatch.toml

@@ -64,7 +64,7 @@ markdown_extensions:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
   - pymdownx.highlight:
-      auto_title: true
+      auto_title: false
       linenums_style: pymdownx-inline
       use_pygments: true
   - pymdownx.inlinehilite
@@ -93,6 +93,7 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
+  - mkdocs-click
 
 extra:
   consent:
@@ -114,3 +115,6 @@ nav:
   - Home: index.md
   - Features: features.md
   - Installation: installation.md
+  - CLI:
+    - About: cli/about.md
+    - Reference: cli/reference.md

mkdocs.yml

@@ -77,11 +77,11 @@
     "tomlValidation": [
       {
         "fileMatch": "robot.toml",
-        "url": "http://raw.githubusercontent.com/d-biehl/robotcode/main/etc/robot.toml.json"
+        "url": "http://localhost:8000/etc/robot.toml.json"
       },
       {
         "fileMatch": ".robot.toml",
-        "url": "http://raw.githubusercontent.com/d-biehl/robotcode/main/etc/robot.toml.json"
+        "url": "http://localhost:8000/etc/robot.toml.json"
       }
     ],
     "configurationDefaults": {
@@ -408,7 +408,7 @@
             "items": {
               "type": "string"
             },
-            "markdownDescription": "Specifies the paths where robot/robotcode should discover tests. Corresponds to the `paths` option of __robot__.",
+            "markdownDescription": "Specifies the paths where robot/robotcode should discover tests. Corresponds to the `paths` argument of __robot__.",
             "scope": "resource"
           },
           "robotcode.robot.pythonPath": {

package.json

@@ -21,6 +21,9 @@
 def analyze(
     ctx: click.Context,
 ) -> Union[str, int, None]:
-    """Analyzes a Robot Framework project."""
+    """Analyzes a Robot Framework project.
+
+    TODO: This is not implemented yet.
+    """
     click.echo("Not implemented yet")
     return 0

packages/analyze/robotcode/analyze/cli/__init__.py

@@ -179,6 +179,13 @@ def as_json(obj: Any, indent: Optional[bool] = None, compact: Optional[bool] = N
     )
 
 
+class NamedTypeError(TypeError):
+    def __init__(self, name: str, message: str) -> None:
+        super().__init__(f'Invalid value for "{name}": {message}')
+        self.name = name
+        self.message = message
+
+
 def _from_dict_with_name(
     name: str,
     value: Any,
@@ -189,8 +196,10 @@ def _from_dict_with_name(
 ) -> _T:
     try:
         return from_dict(value, types, strict=strict)
+    except NamedTypeError as e:
+        raise NamedTypeError(name + "." + e.name, e.message) from e
     except TypeError as e:
-        raise TypeError(f"Invalid value for '{name}': {e}") from e
+        raise NamedTypeError(name, str(e)) from e
 
 
 def from_dict(
@@ -315,8 +324,13 @@ def from_dict(
                     return cast(_T, v)
 
     raise TypeError(
-        f"Cant convert value <{repr(value)}> of type {type(value)} to type "
-        f"{repr(types[0]) if len(types)==1 else ' | '.join(repr(e) for e in types)}."
+        f"Cant convert value {repr(value)} of type {type(value).__name__} to type " + repr(types[0])
+        if len(types) == 1
+        else " | ".join(
+            ((getattr(e, "__name__", None) or str(e) if e is not type(None) else "None") if e is not None else "None")
+            for e in types
+        )
+        + "."
     )
 
 
@@ -449,6 +463,12 @@ def validate_types(expected_types: Union[type, Tuple[type, ...], None], value: A
 
                 return []
 
+            if t is Any:
+                return []
+
+            if isinstance(value, origin or t):
+                return []
+
             if result:
                 continue
 

packages/core/robotcode/core/dataclasses.py

@@ -1,30 +1,118 @@
 from dataclasses import dataclass
-from enum import Enum
+from enum import Enum, unique
 from pathlib import Path
-from typing import Any, Callable, List, Optional, TypeVar, cast
+from typing import IO, Any, AnyStr, Callable, Dict, List, Optional, TypeVar, Union, cast
 
 import click
 import pluggy
 
-__all__ = ["hookimpl", "ClickCommonConfig", "pass_common_config"]
+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 ClickCommonConfig:
+class CommonConfig:
     config_file: Optional[Path] = None
     profiles: Optional[List[str]] = None
     dry: bool = False
     verbose: bool = False
     colored_output: ColoredOutput = ColoredOutput.AUTO
 
 
-pass_common_config = click.make_pass_decorator(ClickCommonConfig, ensure=True)
+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)