robotcode-robot 0.68.2__py3-none-any.whl → 0.68.5__py3-none-any.whl

robotcode/robot/__version__.py

@@ -1 +1 @@
-__version__ = "0.68.2"
+__version__ = "0.68.5"

robotcode/robot/config/model.py

@@ -32,7 +32,8 @@ from robotcode.core.utils.dataclasses import (
 )
 from robotcode.core.utils.safe_eval import safe_eval
 
-EXTEND_PREFIX_LEN = len("extend_")
+EXTEND_PREFIX = "extend_"
+EXTEND_PREFIX_LEN = len(EXTEND_PREFIX)
 
 
 class Flag(str, Enum):
@@ -308,12 +309,12 @@ class BaseOptions(ValidateMixin):
             )
         return value
 
-    def add_options(self, config: "BaseOptions", combine_extras: bool = False) -> None:
+    def add_options(self, config: "BaseOptions", combine_extends: bool = False) -> None:
         type_hints = get_type_hints(type(self))
         base_field_names = [f.name for f in dataclasses.fields(self)]
 
         for f in dataclasses.fields(config):
-            if f.name.startswith("extend_"):
+            if f.name.startswith(EXTEND_PREFIX):
                 if f.name not in base_field_names:
                     continue
 
@@ -326,7 +327,7 @@ class BaseOptions(ValidateMixin):
                 if new is None:
                     continue
 
-                old_field_name = f.name if combine_extras else f.name[EXTEND_PREFIX_LEN:]
+                old_field_name = f.name if combine_extends else f.name[EXTEND_PREFIX_LEN:]
 
                 old = getattr(self, old_field_name)
                 if old is None:
@@ -352,11 +353,11 @@ class BaseOptions(ValidateMixin):
             if f.name not in base_field_names:
                 continue
 
-            if combine_extras:
-                if "extend_" + f.name in base_field_names and getattr(config, f.name, None) is not None:
-                    setattr(self, "extend_" + f.name, None)
+            if combine_extends:
+                if EXTEND_PREFIX + f.name in base_field_names and getattr(config, f.name, None) is not None:
+                    setattr(self, EXTEND_PREFIX + f.name, None)
 
-            if getattr(config, f"extend_{f.name}", None) is not None and not combine_extras:
+            if getattr(config, f"{EXTEND_PREFIX}_{f.name}", None) is not None and not combine_extends:
                 continue
 
             new = self._verified_value(f.name, getattr(config, f.name), type_hints[f.name], config)
@@ -514,6 +515,17 @@ class CommonOptions(BaseOptions):
         robot_priority=500,
         robot_short_name="i",
     )
+    legacy_output: Union[bool, Flag, None] = field(
+        description="""\
+            Create XML output file in format compatible with
+            Robot Framework 6.x and earlier.
+
+            corresponds to the `--legacyoutput` option of _robot_
+            """,
+        robot_name="legacyoutput",
+        robot_priority=500,
+        robot_is_flag=True,
+    )
     log: Optional[Union[str, StringExpression]] = field(
         description="""\
             HTML log file. Can be disabled by giving a special
@@ -929,7 +941,7 @@ class CommonOptions(BaseOptions):
 
 
 @dataclass
-class CommonExtraOptions(BaseOptions):
+class CommonExtendOptions(BaseOptions):
     """Extra common options for all _robot_ commands."""
 
     extend_excludes: Optional[List[Union[str, StringExpression]]] = field(
@@ -941,7 +953,7 @@ class CommonExtraOptions(BaseOptions):
             matched using same rules as with --include.
 
             corresponds to the `-e --exclude tag *` option of _robot_
-            """
+            """,
     )
     extend_expand_keywords: Optional[List[Union[str, NamePattern, TagPattern]]] = field(
         description="""\
@@ -959,7 +971,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--expandkeywords name:<pattern>|tag:<pattern> *` option of _robot_
-            """
+            """,
     )
     extend_flatten_keywords: Optional[
         List[
@@ -989,7 +1001,7 @@ class CommonExtraOptions(BaseOptions):
             `--removekeywords tag:<pattern>`
 
             corresponds to the `--flattenkeywords for|while|iteration|name:<pattern>|tag:<pattern> *` option of _robot_
-            """
+            """,
     )
     extend_includes: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1009,7 +1021,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `-i --include tag *` option of _robot_
-            """
+            """,
     )
     extend_metadata: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
@@ -1020,7 +1032,7 @@ class CommonExtraOptions(BaseOptions):
             as --doc. Example: --metadata Version:1.2
 
             corresponds to the `-M --metadata name:value *` option of _robot_
-            """
+            """,
     )
     extend_parse_include: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1034,7 +1046,7 @@ class CommonExtraOptions(BaseOptions):
             all files in that directory, recursively.
 
             corresponds to the `-I --parseinclude pattern *` option of _robot_
-            """
+            """,
     )
     extend_pre_rebot_modifiers: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
@@ -1045,7 +1057,7 @@ class CommonExtraOptions(BaseOptions):
             arguments the same way as with --listener.
 
             corresponds to the `--prerebotmodifier modifier *` option of _robot_
-            """
+            """,
     )
     extend_python_path: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1066,7 +1078,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `-P --pythonpath path *` option of _robot_
-            """
+            """,
     )
     extend_remove_keywords: Optional[
         List[
@@ -1121,7 +1133,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--removekeywords all|passed|for|wuks|name:<pattern>|tag:<pattern> *` option of _robot_
-            """
+            """,
     )
     extend_set_tag: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1130,7 +1142,7 @@ class CommonExtraOptions(BaseOptions):
             Sets given tag(s) to all executed tests.
 
             corresponds to the `-G --settag tag *` option of _robot_
-            """
+            """,
     )
     extend_suites: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1145,7 +1157,7 @@ class CommonExtraOptions(BaseOptions):
             selects suite `Y` only if its parent is `X`.
 
             corresponds to the `-s --suite name *` option of _robot_
-            """
+            """,
     )
     extend_tag_doc: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
@@ -1165,7 +1177,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--tagdoc pattern:doc *` option of _robot_
-            """
+            """,
     )
     extend_tag_stat_combine: Optional[List[Union[str, Dict[str, str]]]] = field(
         description="""\
@@ -1185,7 +1197,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--tagstatcombine tags:name *` option of _robot_
-            """
+            """,
     )
     extend_tag_stat_exclude: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1196,7 +1208,7 @@ class CommonExtraOptions(BaseOptions):
             similarly as --exclude is used with --include.
 
             corresponds to the `--tagstatexclude tag *` option of _robot_
-            """
+            """,
     )
     extend_tag_stat_include: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1207,7 +1219,7 @@ class CommonExtraOptions(BaseOptions):
             Given tag can be a pattern like with --include.
 
             corresponds to the `--tagstatinclude tag *` option of _robot_
-            """
+            """,
     )
     extend_tag_stat_link: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
@@ -1227,7 +1239,7 @@ class CommonExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--tagstatlink pattern:link:title *` option of _robot_
-            """
+            """,
     )
     extend_tasks: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1236,7 +1248,7 @@ class CommonExtraOptions(BaseOptions):
             Alias to --test. Especially applicable with --rpa.
 
             corresponds to the `--task name *` option of _robot_
-            """
+            """,
     )
     extend_tests: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1250,7 +1262,7 @@ class CommonExtraOptions(BaseOptions):
             in brackets.
 
             corresponds to the `-t --test name *` option of _robot_
-            """
+            """,
     )
 
 
@@ -1623,7 +1635,7 @@ class RobotOptions(BaseOptions):
 
 
 @dataclass
-class RobotExtraOptions(BaseOptions):
+class RobotExtendOptions(BaseOptions):
     """Extra options for _robot_ command."""
 
     extend_languages: Optional[List[Union[str, StringExpression]]] = field(
@@ -1635,7 +1647,7 @@ class RobotExtraOptions(BaseOptions):
             a custom language file.
 
             corresponds to the `--language lang *` option of _rebot_
-            """
+            """,
     )
     extend_listeners: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
@@ -1654,7 +1666,7 @@ class RobotExtraOptions(BaseOptions):
             ```
 
             corresponds to the `--listener listener *` option of _rebot_
-            """
+            """,
     )
     extend_parsers: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
@@ -1664,7 +1676,7 @@ class RobotExtraOptions(BaseOptions):
             arguments the same way as with --listener.
 
             corresponds to the `--parser parser *` option of _rebot_
-            """
+            """,
     )
     extend_pre_run_modifiers: Optional[Dict[str, List[Union[str, StringExpression]]]] = field(
         description="""\
@@ -1675,7 +1687,7 @@ class RobotExtraOptions(BaseOptions):
             same way as with --listener.
 
             corresponds to the `--prerunmodifier modifier *` option of _rebot_
-            """
+            """,
     )
     extend_skip: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1685,7 +1697,7 @@ class RobotExtraOptions(BaseOptions):
             a pattern.
 
             corresponds to the `--skip tag *` option of _rebot_
-            """
+            """,
     )
     extend_skip_on_failure: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1695,7 +1707,7 @@ class RobotExtraOptions(BaseOptions):
             Tag can be a pattern
 
             corresponds to the `--skiponfailure tag *` option of _rebot_
-            """
+            """,
     )
     extend_variables: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
@@ -1715,7 +1727,7 @@ class RobotExtraOptions(BaseOptions):
             ```
 
             corresponds to the `-v --variable name:value *` option of _rebot_
-            """
+            """,
     )
     extend_variable_files: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -1733,7 +1745,7 @@ class RobotExtraOptions(BaseOptions):
             ```
 
             corresponds to the `-V --variablefile path *` option of _rebot_
-            """
+            """,
     )
 
 
@@ -1924,7 +1936,7 @@ class LibDocOptions(BaseOptions):
 
 
 @dataclass
-class LibDocExtraOptions(BaseOptions):
+class LibDocExtendOptions(BaseOptions):
     """Extra options for _libdoc_ command."""
 
     extend_python_path: Optional[List[Union[str, StringExpression]]] = field(
@@ -1935,7 +1947,7 @@ class LibDocExtraOptions(BaseOptions):
             and resources.
 
             corresponds to the `-P --pythonpath path *` option of _libdoc_
-            """
+            """,
     )
 
 
@@ -2038,7 +2050,7 @@ class TestDocOptions(BaseOptions):
 
 
 @dataclass
-class TestDocExtraOptions(BaseOptions):
+class TestDocExtendOptions(BaseOptions):
     """Extra options for _testdoc_ command."""
 
     extend_excludes: Optional[List[Union[str, StringExpression]]] = field(
@@ -2048,7 +2060,7 @@ class TestDocExtraOptions(BaseOptions):
             Exclude tests by tags.
 
             corresponds to the `-e --exclude tag *` option of _testdoc_
-            """
+            """,
     )
     extend_includes: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -2057,7 +2069,7 @@ class TestDocExtraOptions(BaseOptions):
             Include tests by tags.
 
             corresponds to the `-i --include tag *` option of _testdoc_
-            """
+            """,
     )
     extend_metadata: Optional[Dict[str, Union[str, StringExpression]]] = field(
         description="""\
@@ -2066,7 +2078,7 @@ class TestDocExtraOptions(BaseOptions):
             Set/override metadata of the top level suite.
 
             corresponds to the `-M --metadata name:value *` option of _testdoc_
-            """
+            """,
     )
     extend_set_tag: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -2075,7 +2087,7 @@ class TestDocExtraOptions(BaseOptions):
             Set given tag(s) to all test cases.
 
             corresponds to the `-G --settag tag *` option of _testdoc_
-            """
+            """,
     )
     extend_suites: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -2084,7 +2096,7 @@ class TestDocExtraOptions(BaseOptions):
             Include suites by name.
 
             corresponds to the `-s --suite name *` option of _testdoc_
-            """
+            """,
     )
     extend_tests: Optional[List[Union[str, StringExpression]]] = field(
         description="""\
@@ -2093,7 +2105,7 @@ class TestDocExtraOptions(BaseOptions):
             Include tests by name.
 
             corresponds to the `-t --test name *` option of _testdoc_
-            """
+            """,
     )
 
 
@@ -2101,22 +2113,22 @@ class TestDocExtraOptions(BaseOptions):
 
 
 @dataclass
-class RebotProfile(RebotOptions, CommonOptions, CommonExtraOptions):
+class RebotProfile(RebotOptions, CommonOptions, CommonExtendOptions):
     """Profile for _rebot_ command."""
 
 
 @dataclass
-class LibDocProfile(LibDocOptions, LibDocExtraOptions):
+class LibDocProfile(LibDocOptions, LibDocExtendOptions):
     """Profile for _libdoc_ command."""
 
 
 @dataclass
-class TestDocProfile(TestDocOptions, TestDocExtraOptions):
+class TestDocProfile(TestDocOptions, TestDocExtendOptions):
     """Profile for _testdoc_ command."""
 
 
 @dataclass
-class RobotBaseProfile(CommonOptions, CommonExtraOptions, RobotOptions, RobotExtraOptions):
+class RobotBaseProfile(CommonOptions, CommonExtendOptions, RobotOptions, RobotExtendOptions):
     """Base profile for Robot Framework."""
 
     args: Optional[List[str]] = field(
@@ -2342,7 +2354,7 @@ class RobotConfig(RobotExtraBaseProfile):
                 result = RobotBaseProfile()
 
             for f in dataclasses.fields(profile):
-                if f.name.startswith("extend_"):
+                if f.name.startswith(EXTEND_PREFIX):
                     new = self._verified_value(
                         f.name,
                         getattr(profile, f.name),
@@ -2373,7 +2385,7 @@ class RobotConfig(RobotExtraBaseProfile):
                 if f.name not in base_field_names:
                     continue
 
-                if getattr(profile, f"extend_{f.name}", None) is not None:
+                if getattr(profile, f"{EXTEND_PREFIX}_{f.name}", None) is not None:
                     continue
 
                 new = self._verified_value(