robotcode-robot 0.83.0__py3-none-any.whl → 0.83.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- __version__ = "0.83.0"
1
+ __version__ = "0.83.2"
@@ -418,10 +418,14 @@ class CommonOptions(BaseOptions):
418
418
  console_colors: Optional[Literal["auto", "on", "ansi", "off"]] = field(
419
419
  description="""\
420
420
  Use colors on console output or not.
421
- auto: use colors when output not redirected (default)
422
- on: always use colors
423
- ansi: like `on` but use ANSI colors also on Windows
424
- off: disable colors altogether
421
+
422
+ **auto:** use colors when output not redirected (default)
423
+
424
+ **on:** always use colors
425
+
426
+ **ansi:** like `on` but use ANSI colors also on Windows
427
+
428
+ **off:** disable colors altogether
425
429
 
426
430
  corresponds to the `-C --consolecolors auto|on|ansi|off` option of _robot_
427
431
  """,
@@ -480,28 +484,25 @@ class CommonOptions(BaseOptions):
480
484
  robot_name="expandkeywords",
481
485
  robot_priority=500,
482
486
  )
483
- flatten_keywords: Optional[
484
- List[
485
- Union[
486
- str,
487
- Literal["for", "while", "iteration"],
488
- NamePattern,
489
- TagPattern,
490
- ]
491
- ]
492
- ] = field(
487
+ flatten_keywords: Optional[List[Union[str, Literal["for", "while", "iteration"], NamePattern, TagPattern]]] = field(
493
488
  description="""\
494
489
  Flattens matching keywords in the generated log file.
495
490
  Matching keywords get all log messages from their
496
491
  child keywords and children are discarded otherwise.
497
- for: flatten FOR loops fully
498
- while: flatten WHILE loops fully
499
- iteration: flatten FOR/WHILE loop iterations
500
- foritem: deprecated alias for `iteration`
501
- name:<pattern>: flatten matched keywords using same
492
+
493
+ **for:** flatten FOR loops fully
494
+
495
+ **while:** flatten WHILE loops fully
496
+
497
+ **iteration:** flatten FOR/WHILE loop iterations
498
+
499
+ **foritem:** deprecated alias for `iteration`
500
+
501
+ **name:\\<pattern>:** flatten matched keywords using same
502
502
  matching rules as with
503
503
  `--removekeywords name:<pattern>`
504
- tag:<pattern>: flatten matched keywords using same
504
+
505
+ **tag:\\<pattern>:** flatten matched keywords using same
505
506
  matching rules as with
506
507
  `--removekeywords tag:<pattern>`
507
508
 
@@ -665,28 +666,26 @@ class CommonOptions(BaseOptions):
665
666
  robot_priority=500,
666
667
  robot_short_name="P",
667
668
  )
668
- remove_keywords: Optional[
669
- List[
670
- Union[
671
- str,
672
- Literal["all", "passed", "for", "wuks"],
673
- NamePattern,
674
- TagPattern,
675
- ]
676
- ]
677
- ] = field(
678
- description="""\
669
+ remove_keywords: Optional[List[Union[str, Literal["all", "passed", "for", "wuks"], NamePattern, TagPattern]]] = (
670
+ field(
671
+ description="""\
679
672
  Remove keyword data from the generated log file.
680
673
  Keywords containing warnings are not removed except
681
674
  in the `all` mode.
682
- all: remove data from all keywords
683
- passed: remove data only from keywords in passed
675
+
676
+ **all:** remove data from all keywords
677
+
678
+ **passed:** remove data only from keywords in passed
684
679
  test cases and suites
685
- for: remove passed iterations from for loops
686
- while: remove passed iterations from while loops
687
- wuks: remove all but the last failing keyword
680
+
681
+ **for:** remove passed iterations from for loops
682
+
683
+ **while:** remove passed iterations from while loops
684
+
685
+ **wuks:** remove all but the last failing keyword
688
686
  inside `BuiltIn.Wait Until Keyword Succeeds`
689
- name:<pattern>: remove data from keywords that match
687
+
688
+ **name:\\<pattern>:** remove data from keywords that match
690
689
  the given pattern. The pattern is matched
691
690
  against the full name of the keyword (e.g.
692
691
  'MyLib.Keyword', 'resource.Second Keyword'),
@@ -701,7 +700,8 @@ class CommonOptions(BaseOptions):
701
700
  ```
702
701
 
703
702
 
704
- tag:<pattern>: remove data from keywords that match
703
+
704
+ **tag:\\<pattern>:** remove data from keywords that match
705
705
  the given pattern. Tags are case and space
706
706
  insensitive and patterns can contain `*`,
707
707
  `?` and `[]` wildcards. Tags and patterns
@@ -717,8 +717,9 @@ class CommonOptions(BaseOptions):
717
717
 
718
718
  corresponds to the `--removekeywords all|passed|for|wuks|name:<pattern>|tag:<pattern> *` option of _robot_
719
719
  """,
720
- robot_name="removekeywords",
721
- robot_priority=500,
720
+ robot_name="removekeywords",
721
+ robot_priority=500,
722
+ )
722
723
  )
723
724
  report: Optional[Union[str, StringExpression]] = field(
724
725
  description="""\
@@ -990,14 +991,7 @@ class CommonExtendOptions(BaseOptions):
990
991
  """,
991
992
  )
992
993
  extend_flatten_keywords: Optional[
993
- List[
994
- Union[
995
- str,
996
- Literal["for", "while", "iteration"],
997
- NamePattern,
998
- TagPattern,
999
- ]
1000
- ]
994
+ List[Union[str, Literal["for", "while", "iteration"], NamePattern, TagPattern]]
1001
995
  ] = field(
1002
996
  description="""\
1003
997
  Appends entries to the --flattenkeywords option.
@@ -1005,14 +999,20 @@ class CommonExtendOptions(BaseOptions):
1005
999
  Flattens matching keywords in the generated log file.
1006
1000
  Matching keywords get all log messages from their
1007
1001
  child keywords and children are discarded otherwise.
1008
- for: flatten FOR loops fully
1009
- while: flatten WHILE loops fully
1010
- iteration: flatten FOR/WHILE loop iterations
1011
- foritem: deprecated alias for `iteration`
1012
- name:<pattern>: flatten matched keywords using same
1002
+
1003
+ **for:** flatten FOR loops fully
1004
+
1005
+ **while:** flatten WHILE loops fully
1006
+
1007
+ **iteration:** flatten FOR/WHILE loop iterations
1008
+
1009
+ **foritem:** deprecated alias for `iteration`
1010
+
1011
+ **name:\\<pattern>:** flatten matched keywords using same
1013
1012
  matching rules as with
1014
1013
  `--removekeywords name:<pattern>`
1015
- tag:<pattern>: flatten matched keywords using same
1014
+
1015
+ **tag:\\<pattern>:** flatten matched keywords using same
1016
1016
  matching rules as with
1017
1017
  `--removekeywords tag:<pattern>`
1018
1018
 
@@ -1097,14 +1097,7 @@ class CommonExtendOptions(BaseOptions):
1097
1097
  """,
1098
1098
  )
1099
1099
  extend_remove_keywords: Optional[
1100
- List[
1101
- Union[
1102
- str,
1103
- Literal["all", "passed", "for", "wuks"],
1104
- NamePattern,
1105
- TagPattern,
1106
- ]
1107
- ]
1100
+ List[Union[str, Literal["all", "passed", "for", "wuks"], NamePattern, TagPattern]]
1108
1101
  ] = field(
1109
1102
  description="""\
1110
1103
  Appends entries to the --removekeywords option.
@@ -1112,14 +1105,20 @@ class CommonExtendOptions(BaseOptions):
1112
1105
  Remove keyword data from the generated log file.
1113
1106
  Keywords containing warnings are not removed except
1114
1107
  in the `all` mode.
1115
- all: remove data from all keywords
1116
- passed: remove data only from keywords in passed
1108
+
1109
+ **all:** remove data from all keywords
1110
+
1111
+ **passed:** remove data only from keywords in passed
1117
1112
  test cases and suites
1118
- for: remove passed iterations from for loops
1119
- while: remove passed iterations from while loops
1120
- wuks: remove all but the last failing keyword
1113
+
1114
+ **for:** remove passed iterations from for loops
1115
+
1116
+ **while:** remove passed iterations from while loops
1117
+
1118
+ **wuks:** remove all but the last failing keyword
1121
1119
  inside `BuiltIn.Wait Until Keyword Succeeds`
1122
- name:<pattern>: remove data from keywords that match
1120
+
1121
+ **name:\\<pattern>:** remove data from keywords that match
1123
1122
  the given pattern. The pattern is matched
1124
1123
  against the full name of the keyword (e.g.
1125
1124
  'MyLib.Keyword', 'resource.Second Keyword'),
@@ -1134,7 +1133,8 @@ class CommonExtendOptions(BaseOptions):
1134
1133
  ```
1135
1134
 
1136
1135
 
1137
- tag:<pattern>: remove data from keywords that match
1136
+
1137
+ **tag:\\<pattern>:** remove data from keywords that match
1138
1138
  the given pattern. Tags are case and space
1139
1139
  insensitive and patterns can contain `*`,
1140
1140
  `?` and `[]` wildcards. Tags and patterns
@@ -1289,11 +1289,15 @@ class RobotOptions(BaseOptions):
1289
1289
  console: Optional[Literal["verbose", "dotted", "skipped", "quiet", "none"]] = field(
1290
1290
  description="""\
1291
1291
  How to report execution on the console.
1292
- verbose: report every suite and test (default)
1293
- dotted: only show `.` for passed test, `s` for
1292
+
1293
+ **verbose:** report every suite and test (default)
1294
+
1295
+ **dotted:** only show `.` for passed test, `s` for
1294
1296
  skipped tests, and `F` for failed tests
1295
- quiet: no output except for errors and warnings
1296
- none: no output whatsoever
1297
+
1298
+ **quiet:** no output except for errors and warnings
1299
+
1300
+ **none:** no output whatsoever
1297
1301
 
1298
1302
  corresponds to the `--console type` option of _robot_
1299
1303
  """,
@@ -1481,7 +1485,8 @@ class RobotOptions(BaseOptions):
1481
1485
  output files after the test execution and XML outputs
1482
1486
  can also be further processed with Rebot tool. Can be
1483
1487
  disabled by giving a special value `NONE`.
1484
- Default: output.xml
1488
+
1489
+ **Default:** output.xml
1485
1490
 
1486
1491
  corresponds to the `-o --output file` option of _robot_
1487
1492
  """,
@@ -1523,10 +1528,14 @@ class RobotOptions(BaseOptions):
1523
1528
  randomize: Optional[Union[str, Literal["all", "suites", "tests", "none"]]] = field(
1524
1529
  description="""\
1525
1530
  Randomizes the test execution order.
1526
- all: randomizes both suites and tests
1527
- suites: randomizes suites
1528
- tests: randomizes tests
1529
- none: no randomization (default)
1531
+
1532
+ **all:** randomizes both suites and tests
1533
+
1534
+ **suites:** randomizes suites
1535
+
1536
+ **tests:** randomizes tests
1537
+
1538
+ **none:** no randomization (default)
1530
1539
  Use syntax `VALUE:SEED` to give a custom random seed.
1531
1540
  The seed must be an integer.
1532
1541
 
@@ -1806,7 +1815,8 @@ class RebotOptions(BaseOptions):
1806
1815
  description="""\
1807
1816
  When combining results, merge outputs together
1808
1817
  instead of putting them under a new top level suite.
1809
- Example: rebot --merge orig.xml rerun.xml
1818
+
1819
+ **Example:** rebot --merge orig.xml rerun.xml
1810
1820
 
1811
1821
  corresponds to the `-R --merge` option of _rebot_
1812
1822
  """,
@@ -2284,7 +2294,7 @@ class RobotProfile(RobotExtendBaseProfile):
2284
2294
 
2285
2295
  Examples:
2286
2296
  ```toml
2287
- # alway disabled
2297
+ # always disabled
2288
2298
  enabled = false
2289
2299
  ```
2290
2300
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: robotcode-robot
3
- Version: 0.83.0
3
+ Version: 0.83.2
4
4
  Summary: Support classes for RobotCode for handling Robot Framework projects.
5
5
  Project-URL: Homepage, https://robotcode.io
6
6
  Project-URL: Donate, https://opencollective.com/robotcode
@@ -26,7 +26,7 @@ Classifier: Topic :: Utilities
26
26
  Classifier: Typing :: Typed
27
27
  Requires-Python: >=3.8
28
28
  Requires-Dist: platformdirs<4.2.0,>=3.2.0
29
- Requires-Dist: robotcode-core==0.83.0
29
+ Requires-Dist: robotcode-core==0.83.2
30
30
  Requires-Dist: robotframework>=4.1.0
31
31
  Requires-Dist: tomli>=1.1.0; python_version < '3.11'
32
32
  Description-Content-Type: text/markdown
@@ -1,9 +1,9 @@
1
1
  robotcode/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- robotcode/robot/__version__.py,sha256=FwfsRG64Uncan1BBCrMrXMKjMO1MhfWoBbdMOZk1GnU,23
2
+ robotcode/robot/__version__.py,sha256=BysijwUtRGyTEaFK1XP_-VQUzLcWjUdfiT4EBdErGhs,23
3
3
  robotcode/robot/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
4
4
  robotcode/robot/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
5
5
  robotcode/robot/config/loader.py,sha256=LpGqJAdysvVSZpccW-Il52xn9RMBBb9X94emlBY7zCc,6077
6
- robotcode/robot/config/model.py,sha256=LReuQ0Z8zYEYW9XLjnyR2hSUn8upbWzbh8VTTBIRQig,88642
6
+ robotcode/robot/config/model.py,sha256=yD1jaZoT5oK43bVmeIZK75vrDJRYXru8rtuxrTlxXNA,88392
7
7
  robotcode/robot/config/utils.py,sha256=c_WZg39DJgM6kXcAH_h-v68qhf1eStJ0TslTawaJoZw,2827
8
8
  robotcode/robot/diagnostics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  robotcode/robot/diagnostics/document_cache_helper.py,sha256=XLOqPl88Rbo_01pt8Zx2jMH38m5kvoOnASNDoe8BK_0,22292
@@ -23,7 +23,7 @@ robotcode/robot/utils/robot_path.py,sha256=qKBh1cEnReBBLKkWu4gB9EzM-scAwE4xJc1m6
23
23
  robotcode/robot/utils/stubs.py,sha256=6-DMI_CQVJHDgG13t-zINKGCRb_Q7MQPm0_AkfhAEvE,748
24
24
  robotcode/robot/utils/variables.py,sha256=fEl8S37lb_mD4hn2MZRAlkiuLGBjAOeZVK0r2o2CfPw,742
25
25
  robotcode/robot/utils/visitor.py,sha256=uYLqEhGPmzWKWI3SSrmCaYMwtKvNShvbiPZ4b3FavX8,3241
26
- robotcode_robot-0.83.0.dist-info/METADATA,sha256=_kprBQcNZ56FfZmGxvdmL06T6OygxEiVq_jyUd7HrE8,2240
27
- robotcode_robot-0.83.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
28
- robotcode_robot-0.83.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
29
- robotcode_robot-0.83.0.dist-info/RECORD,,
26
+ robotcode_robot-0.83.2.dist-info/METADATA,sha256=PikDo1yffdVRYyIwizMOo4T0WPLN8SNJ2FI7K3tADU0,2240
27
+ robotcode_robot-0.83.2.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
28
+ robotcode_robot-0.83.2.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
29
+ robotcode_robot-0.83.2.dist-info/RECORD,,