robotcode-robot 1.8.0__tar.gz → 1.9.0__tar.gz

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotcode-robot
-Version: 1.8.0
+Version: 1.9.0
 Summary: Support classes for RobotCode for handling Robot Framework projects.
 Project-URL: Homepage, https://robotcode.io
 Project-URL: Donate, https://opencollective.com/robotcode
@@ -10,7 +10,6 @@ Project-URL: Issues, https://github.com/robotcodedev/robotcode/issues
 Project-URL: Source, https://github.com/robotcodedev/robotcode
 Author-email: Daniel Biehl <dbiehl@live.de>
 License: Apache-2.0
-License-File: LICENSE.txt
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Robot Framework
 Classifier: Framework :: Robot Framework :: Tool
@@ -26,7 +25,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
 Requires-Dist: platformdirs<4.4.0,>=3.2.0
-Requires-Dist: robotcode-core==1.8.0
+Requires-Dist: robotcode-core==1.9.0
 Requires-Dist: robotframework>=4.1.0
 Requires-Dist: tomli>=1.1.0; python_version < '3.11'
 Description-Content-Type: text/markdown
@@ -41,7 +40,9 @@ Description-Content-Type: text/markdown
 
 ## Introduction
 
-Support classes for [RobotCode](https://robotcode.io) for handling Robot Framework projects.
+Robot Framework project handling and integration utilities for [RobotCode](https://robotcode.io).
+
+This package is part of the [RobotCode](https://robotcode.io) project. The complete source code is available at [github.com/robotcodedev/robotcode](https://github.com/robotcodedev/robotcode).
 
 ## Installation
 
@@ -49,6 +50,20 @@ Support classes for [RobotCode](https://robotcode.io) for handling Robot Framewo
 pip install robotcode-robot
 ```
 
+## Documentation
+
+For comprehensive documentation, please visit [robotcode.io](https://robotcode.io).
+
+## Security
+
+For security concerns, please refer to our [Security Policy](https://github.com/robotcodedev/robotcode/security/policy).
+
 ## License
 
 `robotcode-robot` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
+
+## Support
+
+- 📖 [Documentation](https://robotcode.io)
+- 💬 [Discussions](https://github.com/robotcodedev/robotcode/discussions)
+- 🐛 [Issues](https://github.com/robotcodedev/robotcode/issues)

robotcode_robot-1.9.0/README.md

@@ -0,0 +1,37 @@
+# robotcode-robot
+
+[![PyPI - Version](https://img.shields.io/pypi/v/robotcode-robot.svg)](https://pypi.org/project/robotcode-robot)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode-robot.svg)](https://pypi.org/project/robotcode-robot)
+[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE.txt)
+
+-----
+
+## Introduction
+
+Robot Framework project handling and integration utilities for [RobotCode](https://robotcode.io).
+
+This package is part of the [RobotCode](https://robotcode.io) project. The complete source code is available at [github.com/robotcodedev/robotcode](https://github.com/robotcodedev/robotcode).
+
+## Installation
+
+```console
+pip install robotcode-robot
+```
+
+## Documentation
+
+For comprehensive documentation, please visit [robotcode.io](https://robotcode.io).
+
+## Security
+
+For security concerns, please refer to our [Security Policy](https://github.com/robotcodedev/robotcode/security/policy).
+
+## License
+
+`robotcode-robot` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
+
+## Support
+
+- 📖 [Documentation](https://robotcode.io)
+- 💬 [Discussions](https://github.com/robotcodedev/robotcode/discussions)
+- 🐛 [Issues](https://github.com/robotcodedev/robotcode/issues)

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
   "robotframework>=4.1.0",
   "tomli>=1.1.0; python_version < '3.11'",
   "platformdirs>=3.2.0,<4.4.0",
-  "robotcode-core==1.8.0",
+  "robotcode-core==1.9.0",
 ]
 dynamic = ["version"]
 

robotcode_robot-1.9.0/src/robotcode/robot/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.9.0"

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/src/robotcode/robot/config/model.py

@@ -366,7 +366,7 @@ class RobotBaseOptions(BaseOptions):
         )
 
         def append_name(field: "dataclasses.Field[Any]", add_flag: Optional[str] = None) -> None:
-            if "robot_short_name" in field.metadata:
+            if "robot_short_name" in field.metadata and not add_flag:
                 result.append(f"-{field.metadata['robot_short_name']}")
             elif "robot_name" in field.metadata:
                 result.append(f"--{'no' if add_flag else ''}{field.metadata['robot_name']}")
@@ -697,9 +697,9 @@ class CommonOptions(RobotBaseOptions):
             **passed:** remove data only from keywords in passed
             test cases and suites
 
-            **for:** remove passed iterations from for loops
+            **for:** remove passed iterations from FOR loops
 
-            **while:** remove passed iterations from while loops
+            **while:** remove passed iterations from WHILE loops
 
             **wuks:** remove all but the last failing keyword
             inside `BuiltIn.Wait Until Keyword Succeeds`
@@ -847,7 +847,6 @@ class CommonOptions(RobotBaseOptions):
             pattern. Documentation is shown in `Test Details` and
             also as a tooltip in `Statistics by Tag`. Pattern can
             use `*`, `?` and `[]` as wildcards like --test.
-            Documentation can contain formatting like --doc.
 
             Examples:
 
@@ -1130,9 +1129,9 @@ class CommonExtendOptions(RobotBaseOptions):
             **passed:** remove data only from keywords in passed
             test cases and suites
 
-            **for:** remove passed iterations from for loops
+            **for:** remove passed iterations from FOR loops
 
-            **while:** remove passed iterations from while loops
+            **while:** remove passed iterations from WHILE loops
 
             **wuks:** remove all but the last failing keyword
             inside `BuiltIn.Wait Until Keyword Succeeds`
@@ -1202,7 +1201,6 @@ class CommonExtendOptions(RobotBaseOptions):
             pattern. Documentation is shown in `Test Details` and
             also as a tooltip in `Statistics by Tag`. Pattern can
             use `*`, `?` and `[]` as wildcards like --test.
-            Documentation can contain formatting like --doc.
 
             Examples:
 
@@ -1862,7 +1860,6 @@ class RebotOptions(RobotBaseOptions):
             Processes output also if the top level suite is
             empty. Useful e.g. with --include/--exclude when it
             is not an error that there are no matches.
-            Use --skiponfailure when starting execution instead.
 
             corresponds to the `--processemptysuite` option of _rebot_
             """,
@@ -1944,7 +1941,7 @@ class LibDocOptions(RobotBaseOptions):
     quiet: Union[bool, Flag, None] = field(
         description="""\
             Do not print the path of the generated output file
-            to the console. New in RF 4.0.
+            to the console.
 
             corresponds to the `--quiet` option of _libdoc_
             """,
@@ -1959,7 +1956,7 @@ class LibDocOptions(RobotBaseOptions):
             documentation format and HTML means converting
             documentation to HTML. The default is RAW with XML
             spec files and HTML with JSON specs and when using
-            the special LIBSPEC format. New in RF 4.0.
+            the special LIBSPEC format.
 
             corresponds to the `-s --specdocformat RAW|HTML` option of _libdoc_
             """,

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/src/robotcode/robot/diagnostics/document_cache_helper.py

@@ -532,6 +532,11 @@ class DocumentsCacheHelper:
             self.analysis_config.cache.ignore_arguments_for_library + cache_config.ignore_arguments_for_library,
             self.analysis_config.robot.global_library_search_order + analysis_config.global_library_search_order,
             cache_base_path,
+            load_library_timeout=(
+                analysis_config.load_library_timeout
+                if analysis_config.load_library_timeout is not None
+                else self.analysis_config.robot.load_library_timeout
+            ),
         )
 
         result.libraries_changed.add(self._on_libraries_changed)

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/src/robotcode/robot/diagnostics/imports_manager.py

@@ -96,8 +96,9 @@ RESOURCE_EXTENSIONS = (
 REST_EXTENSIONS = (".rst", ".rest")
 
 
-LOAD_LIBRARY_TIME_OUT = 10
-COMPLETE_LIBRARY_IMPORT_TIME_OUT = COMPLETE_RESOURCE_IMPORT_TIME_OUT = COMPLETE_VARIABLES_IMPORT_TIME_OUT = 5
+DEFAULT_LOAD_LIBRARY_TIMEOUT: int = 10
+ENV_LOAD_LIBRARY_TIMEOUT_VAR = "ROBOTCODE_LOAD_LIBRARY_TIMEOUT"
+COMPLETE_LIBRARY_IMPORT_TIMEOUT = COMPLETE_RESOURCE_IMPORT_TIMEOUT = COMPLETE_VARIABLES_IMPORT_TIMEOUT = 5
 
 
 class _EntryKey:
@@ -514,6 +515,7 @@ class ImportsManager:
         ignore_arguments_for_library: List[str],
         global_library_search_order: List[str],
         cache_base_path: Optional[Path],
+        load_library_timeout: Optional[int] = None,
     ) -> None:
         super().__init__()
 
@@ -590,6 +592,45 @@ class ImportsManager:
 
         self._diagnostics: List[Diagnostic] = []
 
+        # precedence: explicit config (arg) > environment variable > default
+        if load_library_timeout is None:
+            env_value = os.environ.get(ENV_LOAD_LIBRARY_TIMEOUT_VAR)
+            if env_value is not None:
+                try:
+                    load_library_timeout = int(env_value)
+                except ValueError:
+                    self._logger.warning(
+                        lambda: (
+                            "Invalid value for "
+                            f"{ENV_LOAD_LIBRARY_TIMEOUT_VAR}={env_value!r}, using default "
+                            f"{DEFAULT_LOAD_LIBRARY_TIMEOUT}"
+                        ),
+                        context_name="imports",
+                    )
+                    load_library_timeout = DEFAULT_LOAD_LIBRARY_TIMEOUT
+            else:
+                load_library_timeout = DEFAULT_LOAD_LIBRARY_TIMEOUT
+
+        # enforce sane lower bound
+        if load_library_timeout <= 0:
+            self._logger.warning(
+                lambda: (
+                    "Configured load_library_timeout "
+                    f"{load_library_timeout} is not > 0, fallback to {DEFAULT_LOAD_LIBRARY_TIMEOUT}"
+                ),
+                context_name="imports",
+            )
+            load_library_timeout = DEFAULT_LOAD_LIBRARY_TIMEOUT
+
+        self.load_library_timeout = load_library_timeout
+
+        self._logger.critical(lambda: f"Using LoadLibrary timeout of {self.load_library_timeout} seconds")
+
+        self._logger.trace(
+            lambda: f"Using load_library_timeout={self.load_library_timeout} (config/env/default)",
+            context_name="imports",
+        )
+
     def __del__(self) -> None:
         try:
             if self._executor is not None:
@@ -1266,10 +1307,16 @@ class ImportsManager:
                     base_dir,
                     self.get_resolvable_command_line_variables(),
                     variables,
-                ).result(LOAD_LIBRARY_TIME_OUT)
+                ).result(self.load_library_timeout)
 
             except TimeoutError as e:
-                raise RuntimeError(f"Timeout loading library {name}({args!r})") from e
+                raise RuntimeError(
+                    f"Loading library {name!r} with args {args!r} (working_dir={working_dir!r}, base_dir={base_dir!r}) "
+                    f"timed out after {self.load_library_timeout} seconds. "
+                    "The library may be slow or blocked during import. "
+                    "If required, increase the timeout by setting the ROBOTCODE_LOAD_LIBRARY_TIMEOUT "
+                    "environment variable."
+                ) from e
 
         except (SystemExit, KeyboardInterrupt):
             raise
@@ -1438,10 +1485,17 @@ class ImportsManager:
                     base_dir,
                     self.get_resolvable_command_line_variables() if resolve_command_line_vars else None,
                     variables,
-                ).result(LOAD_LIBRARY_TIME_OUT)
+                ).result(self.load_library_timeout)
 
             except TimeoutError as e:
-                raise RuntimeError(f"Timeout loading library {name}({args!r})") from e
+                raise RuntimeError(
+                    f"Loading variables {name!r} with args {args!r} (working_dir={working_dir!r}, "
+                    f"base_dir={base_dir!r}) "
+                    f"timed out after {self.load_library_timeout} seconds. "
+                    "The variables may be slow or blocked during import. "
+                    "If required, increase the timeout by setting the ROBOTCODE_LOAD_LIBRARY_TIMEOUT "
+                    "environment variable."
+                ) from e
 
         except (SystemExit, KeyboardInterrupt):
             raise
@@ -1608,7 +1662,7 @@ class ImportsManager:
             base_dir,
             self.get_resolvable_command_line_variables(),
             variables,
-        ).result(COMPLETE_LIBRARY_IMPORT_TIME_OUT)
+        ).result(COMPLETE_LIBRARY_IMPORT_TIMEOUT)
 
     def complete_resource_import(
         self,
@@ -1623,7 +1677,7 @@ class ImportsManager:
             base_dir,
             self.get_resolvable_command_line_variables(),
             variables,
-        ).result(COMPLETE_RESOURCE_IMPORT_TIME_OUT)
+        ).result(COMPLETE_RESOURCE_IMPORT_TIMEOUT)
 
     def complete_variables_import(
         self,
@@ -1638,7 +1692,7 @@ class ImportsManager:
             base_dir,
             self.get_resolvable_command_line_variables(),
             variables,
-        ).result(COMPLETE_VARIABLES_IMPORT_TIME_OUT)
+        ).result(COMPLETE_VARIABLES_IMPORT_TIMEOUT)
 
     def resolve_variable(
         self,

{robotcode_robot-1.8.0 → robotcode_robot-1.9.0}/src/robotcode/robot/diagnostics/workspace_config.py

@@ -55,6 +55,9 @@ class CacheConfig(ConfigBase):
 @dataclass
 class AnalysisRobotConfig(ConfigBase):
     global_library_search_order: List[str] = field(default_factory=list)
+    # Timeout in seconds for loading libraries and variable files during analysis. If None, fallback to env var
+    # ROBOTCODE_LOAD_LIBRARY_TIMEOUT or default (10).
+    load_library_timeout: Optional[int] = None
 
 
 @config_section("robotcode.analysis.diagnosticModifiers")

robotcode_robot-1.8.0/LICENSE.txt

@@ -1,73 +0,0 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-
-     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
-
-     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
-
-     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
-
-     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
-
-     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

robotcode_robot-1.8.0/README.md

@@ -1,21 +0,0 @@
-# robotcode-robot
-
-[![PyPI - Version](https://img.shields.io/pypi/v/robotcode-robot.svg)](https://pypi.org/project/robotcode-robot)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode-robot.svg)](https://pypi.org/project/robotcode-robot)
-[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE.txt)
-
------
-
-## Introduction
-
-Support classes for [RobotCode](https://robotcode.io) for handling Robot Framework projects.
-
-## Installation
-
-```console
-pip install robotcode-robot
-```
-
-## License
-
-`robotcode-robot` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

robotcode_robot-1.8.0/src/robotcode/robot/__version__.py

@@ -1 +0,0 @@
-__version__ = "1.8.0"