Reorganize import for better support for optional rich dependency (#420)

Author: bhirsz

docs/releasenotes/3.3.rst

@@ -30,3 +30,7 @@ English language is supported by default.
 * Updated NormalizeSectionHeaderName transformer to work with translated headers
 * Updated MergeAndOrderSections to not merge language: <lang> header with other comment sections
 * Sections with only language: <lang> marker and less than ``section_lines`` empty lines will be not transformed by NormalizeNewLines
+
+Other
+-----
+* Reorganized our imports to better support optional rich dependency (#419)

robotidy/api.py

@@ -3,13 +3,8 @@
 """
 from typing import Optional
 
-from robotidy.app import Robotidy
-from robotidy.cli import TransformType, find_and_read_config, validate_regex
+from robotidy import app, disablers, files, skip, transformers, utils
 from robotidy.config import Config, FormattingConfig
-from robotidy.disablers import RegisterDisablers
-from robotidy.files import DEFAULT_EXCLUDES
-from robotidy.skip import SkipConfig
-from robotidy.utils import ROBOT_VERSION
 
 
 def get_skip_config(config):
@@ -25,7 +20,7 @@ def get_skip_config(config):
     skip_timeout = config.get("skip_timeout", False)
     skip_return = config.get("skip_return", False)
     skip_tags = config.get("skip_tags", False)
-    return SkipConfig(
+    return skip.SkipConfig(
         documentation=skip_documentation,
         return_values=skip_return_values,
         keyword_call=skip_keyword_call,
@@ -61,20 +56,20 @@ def get_formatting_config(config, kwargs):
 def get_robotidy(src: str, output: Optional[str], **kwargs):
     # TODO Refactor - Config should be read in one place both for API and CLI
     # TODO Remove kwargs usage - other SDKs are not using this feature
-    config = find_and_read_config((src,))
+    config = files.find_and_read_config((src,))
     config = {k: str(v) if not isinstance(v, (list, dict)) else v for k, v in config.items()}
-    converter = TransformType()
-    transformers = [converter.convert(tr, None, None) for tr in config.get("transform", ())]
+    converter = transformers.TransformType()
+    transformer_list = [converter.convert(tr, None, None) for tr in config.get("transform", ())]
     configurations = [converter.convert(c, None, None) for c in config.get("configure", ())]
     formatting_config = get_formatting_config(config, kwargs)
     exclude = config.get("exclude", None)
     extend_exclude = config.get("extend_exclude", None)
-    exclude = validate_regex(exclude if exclude is not None else DEFAULT_EXCLUDES)
-    extend_exclude = validate_regex(extend_exclude)
+    exclude = utils.validate_regex(exclude if exclude is not None else files.DEFAULT_EXCLUDES)
+    extend_exclude = utils.validate_regex(extend_exclude)
     global_skip = get_skip_config(config)
     language = config.get("language", None)
     configuration = Config(
-        transformers=transformers,
+        transformers=transformer_list,
         transformers_config=configurations,
         skip=global_skip,
         src=(),
@@ -88,11 +83,11 @@ def get_robotidy(src: str, output: Optional[str], **kwargs):
         check=False,
         output=output,
         force_order=False,
-        target_version=ROBOT_VERSION.major,
+        target_version=utils.ROBOT_VERSION.major,
         color=False,
         language=language,
     )
-    return Robotidy(config=configuration)
+    return app.Robotidy(config=configuration)
 
 
 def transform_model(model, root_dir: str, output: Optional[str] = None, **kwargs) -> Optional[str]:
@@ -106,7 +101,7 @@ def transform_model(model, root_dir: str, output: Optional[str] = None, **kwargs
     :return: The transformed model converted to string or None if no transformation took place.
     """
     robotidy_class = get_robotidy(root_dir, output, **kwargs)
-    disabler_finder = RegisterDisablers(
+    disabler_finder = disablers.RegisterDisablers(
         robotidy_class.config.formatting.start_line, robotidy_class.config.formatting.end_line
     )
     disabler_finder.visit(model)

robotidy/app.py

@@ -8,33 +8,21 @@
 except ImportError:  # Fails on vendored-in LSP plugin
     import click
 
-    escape = None
-
 from robot.api import get_model
 from robot.errors import DataError
 
+from robotidy import utils
 from robotidy.config import Config
 from robotidy.disablers import RegisterDisablers
-from robotidy.utils import (
-    ModelWriter,
-    StatementLinesCollector,
-    decorate_diff_with_color,
-    escape_rich_markup,
-    rf_supports_lang,
-)
-
-try:
-    from robotidy.rich_console import console
-except ImportError:  # Fails on vendored-in LSP plugin
-    console = None
+from robotidy.rich_console import console
 
 
 class Robotidy:
     def __init__(self, config: Config):
         self.config = config
 
     def get_model(self, source):
-        if rf_supports_lang():
+        if utils.rf_supports_lang():
             return get_model(source, lang=self.config.language)
         return get_model(source)
 
@@ -73,11 +61,11 @@ def transform_files(self):
         return 1
 
     def transform(self, model, disablers):
-        old_model = StatementLinesCollector(model)
+        old_model = utils.StatementLinesCollector(model)
         for transformer in self.config.transformers:
             setattr(transformer, "disablers", disablers)  # set dynamically to allow using external transformers
             transformer.visit(model)
-        new_model = StatementLinesCollector(model)
+        new_model = utils.StatementLinesCollector(model)
         return new_model != old_model, old_model, new_model
 
     @staticmethod
@@ -91,7 +79,7 @@ def print_to_stdout(self, collected_lines):
     def save_model(self, source, model):
         if self.config.overwrite:
             output = self.config.output or model.source
-            ModelWriter(output=output, newline=self.get_line_ending(source)).write(model)
+            utils.ModelWriter(output=output, newline=self.get_line_ending(source)).write(model)
 
     def get_line_ending(self, path: str):
         if self.config.formatting.line_sep == "auto":
@@ -108,8 +96,8 @@ def get_line_ending(self, path: str):
     def output_diff(
         self,
         path: str,
-        old_model: StatementLinesCollector,
-        new_model: StatementLinesCollector,
+        old_model: utils.StatementLinesCollector,
+        new_model: utils.StatementLinesCollector,
     ):
         if not self.config.show_diff:
             return
@@ -119,8 +107,8 @@ def output_diff(
         if not lines:
             return
         if self.config.color:
-            output = decorate_diff_with_color(lines)
+            output = utils.decorate_diff_with_color(lines)
         else:
-            output = escape_rich_markup(lines)
+            output = utils.escape_rich_markup(lines)
         for line in output:
             console.print(line, end="", highlight=False, soft_wrap=True)

robotidy/cli.py

@@ -1,30 +1,23 @@
 import os
 import re
 import sys
-import textwrap
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Pattern, Tuple, Union
 
-import rich_click as click
+try:
+    import rich_click as click
 
-from robotidy import skip
-from robotidy.app import Robotidy
+    RICH_PRESENT = True
+except ImportError:  # Fails on vendored-in LSP plugin
+    import click
+
+    RICH_PRESENT = False
+
+from robotidy import app, decorators, exceptions, files, skip, utils, version
 from robotidy.config import Config, FormattingConfig
-from robotidy.decorators import catch_exceptions
-from robotidy.files import DEFAULT_EXCLUDES, find_and_read_config, read_pyproject_config
 from robotidy.rich_console import console
-from robotidy.transformers import load_transformers
-from robotidy.utils import ROBOT_VERSION, RecommendationFinder, TargetVersion, split_args_from_name_or_path
-from robotidy.version import __version__
-
-click.rich_click.USE_RICH_MARKUP = True
-click.rich_click.USE_MARKDOWN = True
-click.rich_click.STYLE_OPTION = "bold sky_blue3"
-click.rich_click.STYLE_SWITCH = "bold sky_blue3"
-click.rich_click.STYLE_METAVAR = "bold white"
-click.rich_click.STYLE_OPTION_DEFAULT = "grey37"
-click.rich_click.STYLE_OPTIONS_PANEL_BORDER = "grey66"
-click.rich_click.STYLE_USAGE = "magenta"
+from robotidy.transformers import TransformType, load_transformers
+
 CLI_OPTIONS_LIST = [
     {
         "name": "Run only selected transformers",
@@ -62,21 +55,23 @@
         "options": ["--target-version", "--language", "--verbose", "--color", "--output", "--version", "--help"],
     },
 ]
-click.rich_click.OPTION_GROUPS = {
-    "robotidy": CLI_OPTIONS_LIST,
-    "python -m robotidy": CLI_OPTIONS_LIST,
-}
 
-
-CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+if RICH_PRESENT:
+    click.rich_click.USE_RICH_MARKUP = True
+    click.rich_click.USE_MARKDOWN = True
+    click.rich_click.STYLE_OPTION = "bold sky_blue3"
+    click.rich_click.STYLE_SWITCH = "bold sky_blue3"
+    click.rich_click.STYLE_METAVAR = "bold white"
+    click.rich_click.STYLE_OPTION_DEFAULT = "grey37"
+    click.rich_click.STYLE_OPTIONS_PANEL_BORDER = "grey66"
+    click.rich_click.STYLE_USAGE = "magenta"
+    click.rich_click.OPTION_GROUPS = {
+        "robotidy": CLI_OPTIONS_LIST,
+        "python -m robotidy": CLI_OPTIONS_LIST,
+    }
 
 
-class TransformType(click.ParamType):
-    name = "transform"
-
-    def convert(self, value, param, ctx):
-        name, args = split_args_from_name_or_path(value.replace(" ", ""))
-        return name, args
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
 
 def parse_opt(opt):
@@ -91,17 +86,17 @@ def validate_config_options(params, config):
     allowed = {parse_opt(opt) for param in params for opt in param.opts}
     for conf in config:
         if conf not in allowed:
-            rec_finder = RecommendationFinder()
+            rec_finder = utils.RecommendationFinder()
             similar = rec_finder.find(conf, list(allowed))
             raise click.NoSuchOption(conf, possibilities=similar)
 
 
 def read_config(ctx: click.Context, param: click.Parameter, value: Optional[str]) -> Optional[str]:
     # if --config was not used, try to find pyproject.toml or robotidy.toml file
     if value:
-        config = read_pyproject_config(value)
+        config = files.read_pyproject_config(value)
     else:
-        config = find_and_read_config(ctx.params["src"] or (str(Path(".").resolve()),))
+        config = files.find_and_read_config(ctx.params["src"] or (str(Path(".").resolve()),))
     if not config:
         return
     # Sanitize the values to be Click friendly. For more information please see:
@@ -123,7 +118,7 @@ def validate_regex_callback(
     param: click.Parameter,
     value: Optional[str],
 ) -> Optional[Pattern]:
-    return validate_regex(value)
+    return utils.validate_regex(value)
 
 
 def validate_target_version(
@@ -132,22 +127,16 @@ def validate_target_version(
     value: Optional[str],
 ) -> Optional[int]:
     if value is None:
-        return ROBOT_VERSION.major
-    version = TargetVersion[value.upper()].value
-    if version > ROBOT_VERSION.major:
+        return utils.ROBOT_VERSION.major
+    version = utils.TargetVersion[value.upper()].value
+    if version > utils.ROBOT_VERSION.major:
         raise click.BadParameter(
-            f"Target Robot Framework version ({version}) should not be higher than installed version ({ROBOT_VERSION})."
+            f"Target Robot Framework version ({version}) should not be higher than "
+            f"installed version ({utils.ROBOT_VERSION})."
         )
     return version
 
 
-def validate_regex(value: Optional[str]) -> Optional[Pattern]:
-    try:
-        return re.compile(value) if value is not None else None
-    except re.error:
-        raise click.BadParameter("Not a valid regular expression")
-
-
 def csv_list_type(ctx: click.Context, param: Union[click.Option, click.Parameter], value: Optional[str]) -> List[str]:
     if not value:
         return []
@@ -161,6 +150,7 @@ def print_transformer_docs(transformer):
     console.print(md)
 
 
+@decorators.optional_rich
 def print_description(name: str, target_version: int):
     transformers = load_transformers(None, {}, allow_disabled=True, target_version=target_version)
     transformer_by_names = {transformer.name: transformer for transformer in transformers}
@@ -170,13 +160,14 @@ def print_description(name: str, target_version: int):
     elif name in transformer_by_names:
         print_transformer_docs(transformer_by_names[name])
     else:
-        rec_finder = RecommendationFinder()
+        rec_finder = utils.RecommendationFinder()
         similar = rec_finder.find_similar(name, transformer_by_names.keys())
         click.echo(f"Transformer with the name '{name}' does not exist.{similar}")
         return 1
     return 0
 
 
+@decorators.optional_rich
 def print_transformers_list(target_version: int):
     from rich.table import Table
 
@@ -232,7 +223,7 @@ def print_transformers_list(target_version: int):
         " excluded on recursive searches. An empty value means no paths are excluded."
         " Use forward slashes for directories on all platforms."
     ),
-    show_default=f"{DEFAULT_EXCLUDES}",
+    show_default=f"{files.DEFAULT_EXCLUDES}",
 )
 @click.option(
     "--extend-exclude",
@@ -388,7 +379,7 @@ def print_transformers_list(target_version: int):
 @click.option(
     "--target-version",
     "-tv",
-    type=click.Choice([v.name.lower() for v in TargetVersion], case_sensitive=False),
+    type=click.Choice([v.name.lower() for v in utils.TargetVersion], case_sensitive=False),
     callback=validate_target_version,
     help="Only enable transformers supported in set target version",
     show_default="installed Robot Framework version",
@@ -413,9 +404,9 @@ def print_transformers_list(target_version: int):
 @skip.return_option
 @skip.tags_option
 @skip.block_comments_option
-@click.version_option(version=__version__, prog_name="robotidy")
+@click.version_option(version=version.__version__, prog_name="robotidy")
 @click.pass_context
-@catch_exceptions
+@decorators.catch_exceptions
 def cli(
     ctx: click.Context,
     transform: List[Tuple[str, List]],
@@ -476,7 +467,7 @@ def cli(
             sys.exit(1)
 
     if exclude is None:
-        exclude = re.compile(DEFAULT_EXCLUDES)
+        exclude = re.compile(files.DEFAULT_EXCLUDES)
 
     if config and verbose:
         click.echo(f"Loaded {config} configuration file")
@@ -533,6 +524,6 @@ def cli(
         color=color,
         language=language,
     )
-    tidy = Robotidy(config=config)
+    tidy = app.Robotidy(config=config)
     status = tidy.transform_files()
     sys.exit(status)