robotcode 0.91.0__py3-none-any.whl → 0.93.0__py3-none-any.whl

robotcode/cli/__init__.py

@@ -1,6 +1,6 @@
 import logging
 from pathlib import Path
-from typing import List, Optional
+from typing import List, Literal, Optional
 
 import click
 
@@ -49,6 +49,21 @@ from .commands import config, profiles
         If not specified, the default profile is used.
         """,
 )
+@click.option(
+    "-r",
+    "--root",
+    "root",
+    type=click.Path(exists=True, path_type=Path, dir_okay=True, file_okay=False, resolve_path=True),
+    multiple=False,
+    show_envvar=True,
+    help="Specifies the root path to be used for the project. It will be automatically detected if not provided.",
+)
+@click.option(
+    "--no-vcs",
+    is_flag=True,
+    show_envvar=True,
+    help="Ignore version control system directories (e.g., .git, .hg) when detecting the project root.",
+)
 @click.option(
     "-f",
     "--format",
@@ -95,6 +110,22 @@ from .commands import config, profiles
     show_default=True,
     show_envvar=True,
 )
+@click.option(
+    "--log-format",
+    type=str,
+    help="Sets the log format. See python logging documentation for more information.",
+    default="%(name)s:%(levelname)s: %(message)s",
+    show_default=True,
+    show_envvar=True,
+)
+@click.option(
+    "--log-style",
+    type=click.Choice(["%", "{", "$"]),
+    help="Sets the log style. See python logging documentation for more information.",
+    default="%",
+    show_default=True,
+    show_envvar=True,
+)
 @click.option(
     "--log-filename",
     type=click.Path(
@@ -160,6 +191,8 @@ def robotcode(
     app: Application,
     config_files: Optional[List[Path]],
     profiles: Optional[List[str]],
+    root: Optional[Path],
+    no_vcs: bool,
     format: Optional[OutputFormat],
     dry: bool,
     verbose: bool,
@@ -167,6 +200,8 @@ def robotcode(
     pager: Optional[bool],
     log: bool,
     log_level: str,
+    log_format: str,
+    log_style: Literal["%", "{", "$"],
     log_filename: Optional[str],
     log_calls: bool,
     default_path: Optional[List[str]],
@@ -189,6 +224,8 @@ def robotcode(
     app.config.profiles = profiles
     app.config.dry = dry
     app.config.verbose = verbose
+    app.config.root = root
+    app.config.no_vcs = no_vcs
 
     if color is None:
         app.config.colored_output = ColoredOutput.AUTO
@@ -210,7 +247,8 @@ def robotcode(
 
         logging.basicConfig(
             level=log_level,
-            format="%(name)s:%(levelname)s: %(message)s",
+            format=log_format,
+            style=log_style,
             filename=log_filename,
         )
 
@@ -240,9 +278,8 @@ def robotcode(
 robotcode.add_command(config)
 robotcode.add_command(profiles)
 
-for p in PluginManager().cli_commands:
-    for c in p:
-        robotcode.add_command(c)
+for c in PluginManager.instance().cli_commands:
+    robotcode.add_command(c)
 
 
 @robotcode.command()

robotcode/cli/__version__.py

@@ -1 +1 @@
-__version__ = "0.91.0"
+__version__ = "0.93.0"

robotcode/cli/commands/config.py

@@ -2,7 +2,7 @@ import dataclasses
 import os
 from fnmatch import fnmatchcase
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Type, Union, get_args, get_origin
 
 import click
 
@@ -20,11 +20,9 @@ from robotcode.robot.config.loader import (
     load_robot_config_from_path,
 )
 from robotcode.robot.config.model import (
-    LibDocProfile,
-    RebotProfile,
+    BaseOptions,
     RobotConfig,
     RobotProfile,
-    TestDocProfile,
 )
 from robotcode.robot.config.utils import get_config_files
 
@@ -66,11 +64,21 @@ def show(app: Application, single: bool, paths: List[Path]) -> None:
     ```
     """
     try:
-        config_files, _, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+        config_files, _, _ = get_config_files(
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
+        )
 
         if single:
             for file, _ in config_files:
-                config = load_robot_config_from_path(file)
+                config = load_robot_config_from_path(
+                    file,
+                    extra_tools={k: v for k, v in PluginManager.instance().tool_config_classes},
+                    verbose_callback=app.verbose,
+                )
                 click.secho(f"File: {file}")
                 app.print_data(
                     config,
@@ -80,7 +88,11 @@ def show(app: Application, single: bool, paths: List[Path]) -> None:
 
             return
 
-        config = load_robot_config_from_path(*config_files)
+        config = load_robot_config_from_path(
+            *config_files,
+            extra_tools={k: v for k, v in PluginManager.instance().tool_config_classes},
+            verbose_callback=app.verbose,
+        )
 
         app.print_data(
             config,
@@ -117,7 +129,13 @@ def files(app: Application, paths: List[Path], user: bool = False) -> None:
     """
 
     try:
-        config_files, _, discovered_by = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+        config_files, _, discovered_by = get_config_files(
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
+        )
 
         result: Dict[str, Any] = {"files": [{"path": str(file), "type": type} for file, type in config_files]}
 
@@ -147,7 +165,7 @@ def files(app: Application, paths: List[Path], user: bool = False) -> None:
     required=False,
 )
 @pass_application
-def root(app: Application, paths: List[Path]) -> None:
+def root(app: Application, paths: Tuple[Path, ...]) -> None:
     """\
     Searches for the root folder of the project and prints them.
 
@@ -162,7 +180,9 @@ def root(app: Application, paths: List[Path]) -> None:
     ```
     """
 
-    root_folder, discovered_by = find_project_root(*(paths or []))
+    root_folder, discovered_by = find_project_root(
+        *(paths or []), root_folder=app.config.root, no_vcs=app.config.no_vcs
+    )
 
     if root_folder is None and (app.config.output_format is None or app.config.output_format == OutputFormat.TEXT):
         raise click.ClickException("Cannot detect root folder. 😥")
@@ -193,55 +213,51 @@ def info(app: Application) -> None:
     """Shows informations about possible configuration settings."""
 
 
-def get_config_fields() -> Dict[str, Dict[str, str]]:
-    result = {}
-    for field in dataclasses.fields(RobotConfig):
-        field_name_encoded = encode_case_for_field_name(RobotConfig, field)
-        result[field_name_encoded] = {
-            "type": str(field.type),
-            "description": field.metadata.get("description", "").strip(),
-        }
+def type_to_str(t: Union[Type[Any], str]) -> str:
+    if isinstance(t, str):
+        return f"'{t}'"
+
+    origin = get_origin(t)
+    if origin is None:
+        return t.__name__
+
+    if origin is Union:
+        return " | ".join(type_to_str(a) for a in get_args(t))
 
-    for field in dataclasses.fields(RobotProfile):
-        field_name_encoded = encode_case_for_field_name(RobotProfile, field)
-        if field_name_encoded in result:
+    return f"{origin.__name__}[{', '.join(type_to_str(a) for a in get_args(t))}]"
+
+
+def _get_config_fields_for_type(
+    prefix: str, cls: Type[Any], filter: Optional[Callable[[str], bool]] = None
+) -> Dict[str, Dict[str, str]]:
+    result = {}
+    for field in dataclasses.fields(cls):
+        field_name_encoded = encode_case_for_field_name(cls, field)
+        if filter and not filter(field_name_encoded):
             continue
 
-        result["[profile]." + field_name_encoded] = {
-            "type": str(field.type),
+        result[prefix + field_name_encoded] = {
+            "type": type_to_str(field.type),
             "description": field.metadata.get("description", "").strip(),
         }
+        args = get_args(field.type)
 
-    for field in dataclasses.fields(RebotProfile):
-        field_name_encoded = encode_case_for_field_name(RebotProfile, field)
-        result["rebot." + field_name_encoded] = {
-            "type": str(field.type),
-            "description": field.metadata.get("description", "").strip(),
-        }
+        p = f"{prefix}{'' if prefix[-1]=='.' else '.'}" if prefix else ""
+        for a in args:
+            origin = get_origin(a)
+            if origin is None and issubclass(a, BaseOptions):
+                result.update(_get_config_fields_for_type(f"{p}{field_name_encoded}.", a, filter))
+    return result
 
-    for field in dataclasses.fields(LibDocProfile):
-        field_name_encoded = encode_case_for_field_name(LibDocProfile, field)
-        result["libdoc." + field_name_encoded] = {
-            "type": str(field.type),
-            "description": field.metadata.get("description", "").strip(),
-        }
 
-    for field in dataclasses.fields(TestDocProfile):
-        field_name_encoded = encode_case_for_field_name(TestDocProfile, field)
-        result["testdoc." + field_name_encoded] = {
-            "type": str(field.type),
-            "description": field.metadata.get("description", "").strip(),
-        }
+def get_config_fields() -> Dict[str, Dict[str, str]]:
+    result = {}
+    result.update(_get_config_fields_for_type("", RobotConfig))
 
-    for entry in PluginManager().config_classes:
-        for s, cls in entry:
-            if dataclasses.is_dataclass(cls):
-                for field in dataclasses.fields(cls):
-                    field_name_encoded = encode_case_for_field_name(TestDocProfile, field)
-                    result[f"{s}." + field_name_encoded] = {
-                        "type": str(field.type),
-                        "description": field.metadata.get("description", "").strip(),
-                    }
+    result.update(_get_config_fields_for_type("[profile].", RobotProfile, lambda x: x not in result))
+    for entry in PluginManager.instance().tool_config_classes:
+        if dataclasses.is_dataclass(entry.config_class):
+            result.update(_get_config_fields_for_type(f"tool.{entry.tool_name}.", entry.config_class))
 
     return {k: v for k, v in sorted(result.items(), key=lambda item: item[0])}
 
@@ -275,7 +291,15 @@ def list(app: Application, name: Optional[List[str]] = None) -> None:
                 result.append(field)
 
     if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:
-        app.echo_via_pager(os.linesep.join(result))
+
+        def output() -> Iterable[str]:
+            for r in result:
+                yield r + os.linesep
+
+            yield os.linesep
+            yield f"Total: {len(result)}"
+
+        app.echo_via_pager(output())
     else:
         app.print_data({"names": result})
 

robotcode/cli/commands/profiles.py

@@ -40,9 +40,11 @@ def profiles() -> None:
 def show(app: Application, no_evaluate: bool, paths: List[Path]) -> None:
     """Shows the given profile configuration."""
     try:
-        config_files, _, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+        config_files, _, _ = get_config_files(
+            paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+        )
 
-        config = load_robot_config_from_path(*config_files).combine_profiles(
+        config = load_robot_config_from_path(*config_files, verbose_callback=app.verbose).combine_profiles(
             *(app.config.profiles or []), verbose_callback=app.verbose, error_callback=app.error
         )
 
@@ -73,9 +75,15 @@ def list(app: Application, paths: List[Path], show_hidden: bool = False, sort_by
     """Lists the defined profiles in the current configuration."""
 
     try:
-        config_files, _, discovered_by = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+        config_files, _, discovered_by = get_config_files(
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
+        )
 
-        config = load_robot_config_from_path(*config_files)
+        config = load_robot_config_from_path(*config_files, verbose_callback=app.verbose)
 
         _, selected_profiles, enabled_names = config.combine_profiles_ex(
             *(app.config.profiles or []), verbose_callback=app.verbose, error_callback=app.error

{robotcode-0.91.0.dist-info → robotcode-0.93.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotcode
-Version: 0.91.0
+Version: 0.93.0
 Summary: Command line interface for RobotCode
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -33,33 +33,36 @@ Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
-Requires-Dist: robotcode-core==0.91.0
-Requires-Dist: robotcode-plugin==0.91.0
-Requires-Dist: robotcode-robot==0.91.0
+Requires-Dist: robotcode-core==0.93.0
+Requires-Dist: robotcode-plugin==0.93.0
+Requires-Dist: robotcode-robot==0.93.0
 Provides-Extra: all
 Requires-Dist: docutils; extra == 'all'
 Requires-Dist: pyyaml>=5.4; extra == 'all'
 Requires-Dist: rich; extra == 'all'
-Requires-Dist: robotcode-analyze==0.91.0; extra == 'all'
-Requires-Dist: robotcode-debugger==0.91.0; extra == 'all'
-Requires-Dist: robotcode-language-server==0.91.0; extra == 'all'
-Requires-Dist: robotcode-runner==0.91.0; extra == 'all'
+Requires-Dist: robotcode-analyze==0.93.0; extra == 'all'
+Requires-Dist: robotcode-debugger==0.93.0; extra == 'all'
+Requires-Dist: robotcode-language-server==0.93.0; extra == 'all'
+Requires-Dist: robotcode-repl==0.93.0; extra == 'all'
+Requires-Dist: robotcode-runner==0.93.0; extra == 'all'
 Requires-Dist: robotframework-robocop>=2.0.0; extra == 'all'
 Requires-Dist: robotframework-tidy>=2.0.0; extra == 'all'
 Provides-Extra: analyze
-Requires-Dist: robotcode-analyze==0.91.0; extra == 'analyze'
+Requires-Dist: robotcode-analyze==0.93.0; extra == 'analyze'
 Provides-Extra: colored
 Requires-Dist: rich; extra == 'colored'
 Provides-Extra: debugger
-Requires-Dist: robotcode-debugger==0.91.0; extra == 'debugger'
+Requires-Dist: robotcode-debugger==0.93.0; extra == 'debugger'
 Provides-Extra: languageserver
-Requires-Dist: robotcode-language-server==0.91.0; extra == 'languageserver'
+Requires-Dist: robotcode-language-server==0.93.0; extra == 'languageserver'
 Provides-Extra: lint
 Requires-Dist: robotframework-robocop>=2.0.0; extra == 'lint'
+Provides-Extra: repl
+Requires-Dist: robotcode-repl==0.93.0; extra == 'repl'
 Provides-Extra: rest
 Requires-Dist: docutils; extra == 'rest'
 Provides-Extra: runner
-Requires-Dist: robotcode-runner==0.91.0; extra == 'runner'
+Requires-Dist: robotcode-runner==0.93.0; extra == 'runner'
 Provides-Extra: tidy
 Requires-Dist: robotframework-tidy>=2.0.0; extra == 'tidy'
 Provides-Extra: yaml

robotcode-0.93.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+robotcode/cli/__init__.py,sha256=davaLdB53bWWMqm4BMmjktKlL0AyzOuMObZbNbmhiQE,8226
+robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
+robotcode/cli/__version__.py,sha256=W-KEJT0wpRrG8XJ2aDG4NSyzaUucgZR9y6mwfCTlku4,23
+robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
+robotcode/cli/commands/config.py,sha256=84gG4LrIynfPbEQkQDYA3ZClg50ck32NZyUvAWw9g6w,10479
+robotcode/cli/commands/profiles.py,sha256=GAyNsnz4vvybkEfktFTjDm-L4zkcntXZtBt385U9oRo,5897
+robotcode-0.93.0.dist-info/METADATA,sha256=eKwu6UpIwPOazyU3KKtC1bj4TQ23OzHM7CT8Rpdcs-0,6758
+robotcode-0.93.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+robotcode-0.93.0.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
+robotcode-0.93.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+robotcode-0.93.0.dist-info/RECORD,,

robotcode-0.91.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-robotcode/cli/__init__.py,sha256=6c-evRLgJ0NR08YvynBQzKxAesAbXB0fnrzZ7MvBDM0,7115
-robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
-robotcode/cli/__version__.py,sha256=RBon26SFk4Bs08h0XAmTYW8lrYs3N9ihifF9r6VT4Vc,23
-robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
-robotcode/cli/commands/config.py,sha256=fCXhxsotQJl3vMSWpCEM-zwV-tST7sZBH7T-5v9j5EU,10061
-robotcode/cli/commands/profiles.py,sha256=HUCsNMaK75AVSG_A6F1I209xtQH2AICaoLcqpIO7Vjs,5660
-robotcode-0.91.0.dist-info/METADATA,sha256=IW1fsf7rm_4v9JmF4IWn6BhvmxyTOSqjctFnqROtVuA,6628
-robotcode-0.91.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-robotcode-0.91.0.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
-robotcode-0.91.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
-robotcode-0.91.0.dist-info/RECORD,,