robotframework 7.4.1__tar.gz → 7.5b1__tar.gz

{robotframework-7.4.1 → robotframework-7.5b1}/INSTALL.rst

@@ -302,6 +302,14 @@ version.
    C:\>py -3.11 -m robot --version
    Robot Framework 7.0 (Python 3.11.7 on win32)
 
+Dependencies
+------------
+
+Robot Framework core functionality has no mandatory dependencies other than
+Python and its standard library. Some individual features may require optional
+dependencies to be installed, though. What dependencies are needed is always
+explained in the relevant documentation.
+
 Virtual environments
 --------------------
 

{robotframework-7.4.1 → robotframework-7.5b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework
-Version: 7.4.1
+Version: 7.5b1
 Summary: Generic automation framework for acceptance testing and robotic process automation (RPA)
 Home-page: https://robotframework.org
 Download-URL: https://pypi.org/project/robotframework
@@ -10,7 +10,7 @@ License: Apache License 2.0
 Project-URL: Source, https://github.com/robotframework/robotframework
 Project-URL: Issue Tracker, https://github.com/robotframework/robotframework/issues
 Project-URL: Documentation, https://robotframework.org/robotframework
-Project-URL: Release Notes, https://github.com/robotframework/robotframework/blob/master/doc/releasenotes/rf-7.4.1.rst
+Project-URL: Release Notes, https://github.com/robotframework/robotframework/blob/master/doc/releasenotes/rf-7.5b1.rst
 Project-URL: Slack, http://slack.robotframework.org
 Keywords: robotframework automation testautomation rpa testing acceptancetesting atdd bdd
 Platform: any

{robotframework-7.4.1 → robotframework-7.5b1}/pyproject.toml

@@ -27,7 +27,7 @@ order-by-type = false
 # module/package API are excluded. For details about multiline modes see:
 # https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html
 multi_line_output = 5
-extend_skip = ["__init__.py", "src/robot/api/parsing.py"]
+extend_skip = ["__init__.py", "src/robot/api/console.py", "src/robot/api/parsing.py"]
 combine_as_imports = true
 order_by_type = false
 line_length = 88

{robotframework-7.4.1 → robotframework-7.5b1}/setup.py

@@ -6,7 +6,7 @@ from setuptools import find_packages, setup
 
 # Version number typically updated by running `invoke set-version <version>`.
 # Run `invoke --help set-version` or see tasks.py for details.
-VERSION = "7.4.1"
+VERSION = "7.5b1"
 with open(join(dirname(abspath(__file__)), "README.rst")) as f:
     LONG_DESCRIPTION = f.read()
     base_url = "https://github.com/robotframework/robotframework/blob/master"

{robotframework-7.4.1 → robotframework-7.5b1}/src/robot/api/__init__.py

@@ -33,6 +33,9 @@ Currently exposed APIs are:
 * :mod:`.interfaces` module containing optional base classes that can be used
   when creating libraries and other extensions. New in Robot Framework 6.1.
 
+* :mod:`.console` module exposing built-in console loggers that external loggers
+  can extend. New in Robot Framework 7.5.
+
 * :mod:`.types` module with types exposed for libraries and other extensions.
   New in Robot Framework 7.4.
 

robotframework-7.5b1/src/robot/api/console.py

@@ -0,0 +1,41 @@
+#  Copyright 2008-2015 Nokia Networks
+#  Copyright 2016-     Robot Framework Foundation
+#
+#  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.
+
+"""This module exposes built-in console loggers that external loggers can extend.
+
+Module contents:
+
+- :class:`~.BaseConsole` base class.
+- :class:`~.VerboseConsole` that implements ``--console verbose``.
+- :class:`~.DottedConsole` that implements ``--console dotted``.
+- :class:`~.QuietConsole` that implements ``--console quiet``.
+- :class:`~.NoneConsole` that implements ``--console none``.
+- :attr:`~.ResultFile` that can be used in type hints when overriding
+  the ``result_file`` hook method.
+
+These classes are implemented elsewhere, but external tools should always import
+them via :mod:`robot.api.console`.
+
+New in Robot Framework 7.5.
+"""
+
+from robot.output import ResultFile as ResultFile
+from robot.output.console import (
+    BaseConsole as BaseConsole,
+    DottedConsole as DottedConsole,
+    NoneConsole as NoneConsole,
+    QuietConsole as QuietConsole,
+    VerboseConsole as VerboseConsole,
+)

{robotframework-7.4.1 → robotframework-7.5b1}/src/robot/api/deco.py

@@ -24,7 +24,7 @@ KeywordDecorator = Callable[[K], K]
 LibraryDecorator = Callable[[L], L]
 Scope = Literal["GLOBAL", "SUITE", "TEST", "TASK"]
 Converter = Union[Callable[[Any], Any], Callable[[Any, Any], Any]]
-DocFormat = Literal["ROBOT", "HTML", "TEXT", "REST"]
+DocFormat = Literal["ROBOT", "MARKDOWN", "HTML", "TEXT", "REST"]
 
 
 def not_keyword(func: F) -> F:
@@ -58,18 +58,18 @@ def keyword(func: K, /) -> K: ...
 
 @overload
 def keyword(
-    name: "str|None" = None,
+    name: "str | None" = None,
     tags: Sequence[str] = (),
-    types: "TypeHints|None" = (),
+    types: "TypeHints | None" = (),
 ) -> KeywordDecorator: ...
 
 
 @not_keyword
 def keyword(
-    name: "K|str|None" = None,
+    name: "K | str | None" = None,
     tags: Sequence[str] = (),
-    types: "TypeHints|None" = (),
-) -> "K|KeywordDecorator":
+    types: "TypeHints | None" = (),
+) -> "K | KeywordDecorator":
     """Decorator to set custom name, tags and argument types to keywords.
 
     This decorator creates ``robot_name``, ``robot_tags`` and ``robot_types``
@@ -129,24 +129,24 @@ def library(cls: L, /) -> L: ...
 
 @overload
 def library(
-    scope: "Scope|None" = None,
-    version: "str|None" = None,
-    converters: "dict[type, Converter]|None" = None,
-    doc_format: "DocFormat|None" = None,
-    listener: "Any|None" = None,
+    scope: "Scope | None" = None,
+    version: "str | None" = None,
+    converters: "dict[type, Converter] | None" = None,
+    doc_format: "DocFormat | None" = None,
+    listener: "Any | None" = None,
     auto_keywords: bool = False,
 ) -> LibraryDecorator: ...
 
 
 @not_keyword
 def library(
-    scope: "L|Scope|None" = None,
-    version: "str|None" = None,
-    converters: "dict[type, Converter]|None" = None,
-    doc_format: "DocFormat|None" = None,
-    listener: "Any|None" = None,
+    scope: "L | Scope | None" = None,
+    version: "str | None" = None,
+    converters: "dict[type, Converter] | None" = None,
+    doc_format: "DocFormat | None" = None,
+    listener: "Any | None" = None,
     auto_keywords: bool = False,
-) -> "L|LibraryDecorator":
+) -> "L | LibraryDecorator":
     """Class decorator to control keyword discovery and other library settings.
 
     Disables automatic keyword detection by setting class attribute

{robotframework-7.4.1 → robotframework-7.5b1}/src/robot/api/interfaces.py

@@ -54,6 +54,7 @@ else:
     UnionType = type
 
 from robot import result, running
+from robot.output import ResultFile as ResultFile
 from robot.running import TestDefaults as TestDefaults, TestSuite
 
 # Type aliases used by DynamicLibrary and HybridLibrary.
@@ -76,7 +77,7 @@ TypeHint = Union[
 ]  # fmt: skip
 TypeHints = Union[
     Mapping[str, TypeHint],    # Types by name.
-    Sequence["TypeHint|None"]  # Types by position.
+    Sequence["TypeHint | None"]  # Types by position.
 ]  # fmt: skip
 Tags = Sequence[str]
 Source = str
@@ -118,7 +119,7 @@ class DynamicLibrary(ABC):
         """
         raise NotImplementedError
 
-    def get_keyword_documentation(self, name: Name) -> "Documentation|None":
+    def get_keyword_documentation(self, name: Name) -> "Documentation | None":
         """Optional method to return keyword documentation.
 
         The first logical line of keyword documentation is shown in
@@ -136,7 +137,7 @@ class DynamicLibrary(ABC):
         """
         return None
 
-    def get_keyword_arguments(self, name: Name) -> "Arguments|None":
+    def get_keyword_arguments(self, name: Name) -> "Arguments | None":
         """Optional method to return keyword's argument specification.
 
         Returned information is used during execution for argument validation.
@@ -179,7 +180,7 @@ class DynamicLibrary(ABC):
         """
         return None
 
-    def get_keyword_types(self, name: Name) -> "TypeHints|None":
+    def get_keyword_types(self, name: Name) -> "TypeHints | None":
         """Optional method to return keyword's type specification.
 
         Type information is used for automatic argument conversion during
@@ -212,7 +213,7 @@ class DynamicLibrary(ABC):
         """
         return None
 
-    def get_keyword_tags(self, name: Name) -> "Tags|None":
+    def get_keyword_tags(self, name: Name) -> "Tags | None":
         """Optional method to return keyword's tags.
 
         Tags are shown in the execution log and in documentation generated by
@@ -223,7 +224,7 @@ class DynamicLibrary(ABC):
         """
         return None
 
-    def get_keyword_source(self, name: Name) -> "Source|None":
+    def get_keyword_source(self, name: Name) -> "Source | None":
         """Optional method to return keyword's source path and line number.
 
         Source information is used by IDEs to provide navigation from
@@ -337,7 +338,7 @@ class OptionalKeywordAttributes(TypedDict, total=False):
     """
 
     # FOR / ITERATION with FOR
-    variables: "list[str]|dict[str, str]"
+    variables: "list[str] | dict[str, str]"
     flavor: str
     values: "list[str]"  # Also RETURN
     # WHILE and IF
@@ -364,7 +365,7 @@ class StartKeywordAttributes(OptionalKeywordAttributes):
     assign: "list[str]"
     tags: "list[str]"
     source: str
-    lineno: "int|None"
+    lineno: "int | None"
     status: str
     starttime: str
 
@@ -400,7 +401,7 @@ class LibraryAttributes(TypedDict):
     args: "list[str]"
     originalname: str
     source: str
-    importer: "str|None"
+    importer: "str | None"
 
 
 class ResourceAttributes(TypedDict):
@@ -410,7 +411,7 @@ class ResourceAttributes(TypedDict):
     """
 
     source: str
-    importer: "str|None"
+    importer: "str | None"
 
 
 class VariablesAttributes(TypedDict):
@@ -421,7 +422,7 @@ class VariablesAttributes(TypedDict):
 
     args: "list[str]"
     source: str
-    importer: "str|None"
+    importer: "str | None"
 
 
 class ListenerV2:
@@ -480,37 +481,41 @@ class ListenerV2:
         """Called after a variable file has been imported."""
 
     def output_file(self, path: str):
-        """Called after the output file has been created.
+        """Called when the output file is ready.
 
-        ``path`` is an absolute path to the output file or
-        a string ``None`` if creating the output file is disabled.
+        :param path: An absolute path to the output file or
+            a string ``None`` if creating the output file is disabled.
         """
 
     def log_file(self, path: str):
-        """Called after the log file has been created.
+        """Called when the log file is ready.
+
+        :param path: An absolute path to the log file.
 
-        ``path`` is an absolute path to the log file.
         Not called if creating the log file is disabled.
         """
 
     def report_file(self, path: str):
-        """Called after the report file has been created.
+        """Called when the report file is ready.
+
+        :param path: An absolute path to the report file.
 
-        ``path`` is an absolute path to the report file.
         Not called if creating the report file is disabled.
         """
 
     def xunit_file(self, path: str):
-        """Called after the xunit compatible output file has been created.
+        """Called when the xunit compatible output file is ready.
+
+        :param path: An absolute path to the xunit file.
 
-        ``path`` is an absolute path to the xunit file.
         Only called if creating the xunit file is enabled.
         """
 
     def debug_file(self, path: str):
-        """Called after the debug file has been created.
+        """Called when the debug file is ready.
+
+        :param path: An absolute path to the debug file.
 
-        ``path`` is an absolute path to the debug file.
         Only called if creating the debug file is enabled.
         """
 
@@ -985,40 +990,78 @@ class ListenerV3:
         the imported variable file.
         """
 
-    def output_file(self, path: "Path|None"):
-        """Called after the output file has been created.
+    def result_file(self, kind: ResultFile, path: Path):
+        """Called, by default, when a result file like output or log is ready.
+
+        :param kind: The result file type.
+        :param path: An absolute path to the result file.
+
+        Not called if a more specific result file related method like
+        :meth:`output_file` or :meth:`log_file` has been implemented or
+        when creating a result file is disabled.
+
+        New in Robot Framework 7.5.
+        """
+
+    def output_file(self, path: "Path | None"):
+        """Called when the output file is ready.
 
-        ``path`` is an absolute path to the output file or
-        ``None`` if creating the output file is disabled.
+        :param path: An absolute path to the output file or
+          ``None`` if creating the output file is disabled.
+
+        Starting from Robot Framework 7.5, the default implementation calls
+        :meth:`result_file` if creating the output file is not disabled.
         """
+        if path is not None:
+            self.result_file("OUTPUT", path)
 
     def log_file(self, path: Path):
-        """Called after the log file has been created.
+        """Called when the log file is ready.
+
+        :param path: An absolute path to the log file.
 
-        ``path`` is an absolute path to the log file.
         Not called if creating the log file is disabled.
+
+        Starting from Robot Framework 7.5, the default implementation calls
+        :meth:`result_file`.
         """
+        self.result_file("LOG", path)
 
     def report_file(self, path: Path):
-        """Called after the report file has been created.
+        """Called when the report file is ready.
+
+        :param path: An absolute path to the report file.
 
-        ``path`` is an absolute path to the report file.
         Not called if creating the report file is disabled.
+
+        Starting from Robot Framework 7.5, the default implementation calls
+        :meth:`result_file`.
         """
+        self.result_file("REPORT", path)
 
     def xunit_file(self, path: Path):
-        """Called after the xunit compatible output file has been created.
+        """Called when the xunit compatible output file is ready.
+
+        :param path: An absolute path to the xunit file.
 
-        ``path`` is an absolute path to the xunit file.
         Only called if creating the xunit file is enabled.
+
+        Starting from Robot Framework 7.5, the default implementation calls
+        :meth:`result_file`.
         """
+        self.result_file("XUNIT", path)
 
     def debug_file(self, path: Path):
-        """Called after the debug file has been created.
+        """Called when the debug file is ready.
+
+        :param path: An absolute path to the debug file.
 
-        ``path`` is an absolute path to the debug file.
         Only called if creating the debug file is enabled.
+
+        Starting from Robot Framework 7.5, the default implementation calls
+        :meth:`result_file`.
         """
+        self.result_file("DEBUG", path)
 
     def close(self):
         """Called when the whole execution ends.
@@ -1060,7 +1103,7 @@ class Parser(ABC):
     The support for custom parsers is new in Robot Framework 6.1.
     """
 
-    extension: "str|Sequence[str]"
+    extension: "str | Sequence[str]"
 
     @abstractmethod
     def parse(self, source: Path, defaults: TestDefaults) -> TestSuite: