Update types

Author: HardNorth

robotframework_reportportal/helpers.py

@@ -17,7 +17,8 @@
 import binascii
 import fnmatch
 import re
-from typing import Iterable, Optional, Tuple
+from collections.abc import Iterable
+from typing import Optional
 
 
 def translate_glob_to_regex(pattern: Optional[str]) -> Optional[re.Pattern]:
@@ -48,7 +49,7 @@ def match_pattern(pattern: Optional[re.Pattern], line: Optional[str]) -> bool:
     return pattern.fullmatch(line) is not None
 
 
-def replace_patterns(text: str, patterns: Iterable[Tuple[re.Pattern, str]]) -> str:
+def replace_patterns(text: str, patterns: Iterable[tuple[re.Pattern, str]]) -> str:
     """Replace given patterns in the text."""
     result = text
     for p, repl in patterns:

robotframework_reportportal/listener.py

@@ -21,7 +21,7 @@
 import warnings
 from functools import wraps
 from mimetypes import guess_type
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Optional, Union
 from warnings import warn
 
 from reportportal_client.helpers import LifoQueue, guess_content_type_from_bytes, is_binary
@@ -94,7 +94,7 @@ def wrap(*args, **kwargs):
     return wrap
 
 
-def process_keyword_names_and_tags(matcher_list: List[KeywordMatch], pattern_str: str) -> None:
+def process_keyword_names_and_tags(matcher_list: list[KeywordMatch], pattern_str: str) -> None:
     """Pick name or pattern string, parse it and add to the matcher list.
 
     :param matcher_list: List of keyword matchers to add to
@@ -115,8 +115,8 @@ class listener:
     _items: LifoQueue[Union[Keyword, Launch, Suite, Test]]
     _service: Optional[RobotService]
     _variables: Optional[Variables]
-    _remove_keyword_filters: List[KeywordMatch] = []
-    _flatten_keyword_filters: List[KeywordMatch] = []
+    _remove_keyword_filters: list[KeywordMatch] = []
+    _flatten_keyword_filters: list[KeywordMatch] = []
     _remove_all_keyword_content: bool = False
     _remove_data_passed_tests: bool = False
     ROBOT_LISTENER_API_VERSION = 2
@@ -127,7 +127,7 @@ def __init__(self) -> None:
         self._service = None
         self._variables = None
 
-    def _build_msg_struct(self, message: Dict[str, Any]) -> LogMessage:
+    def _build_msg_struct(self, message: dict[str, Any]) -> LogMessage:
         """Check if the given message comes from our custom logger or not.
 
         :param message: Message passed by the Robot Framework
@@ -271,7 +271,7 @@ def _log_message(self, message: LogMessage) -> None:
                     self.__post_log_message(message)
 
     @check_rp_enabled
-    def log_message(self, message: Dict) -> None:
+    def log_message(self, message: dict) -> None:
         """Send log message to the Report Portal.
 
         :param message: Message passed by the Robot Framework
@@ -280,7 +280,7 @@ def log_message(self, message: Dict) -> None:
         self._log_message(msg)
 
     @check_rp_enabled
-    def log_message_with_image(self, msg: Dict, image: str):
+    def log_message_with_image(self, msg: dict, image: str):
         """Send log message to the ReportPortal.
 
         :param msg:   Message passed by the Robot Framework
@@ -363,7 +363,7 @@ def _process_keyword_flatten(self):
                     continue
                 process_keyword_names_and_tags(self._flatten_keyword_filters, pattern_str)
 
-    def start_launch(self, attributes: Dict[str, Any], ts: Optional[Any] = None) -> None:
+    def start_launch(self, attributes: dict[str, Any], ts: Optional[Any] = None) -> None:
         """Start a new launch at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
@@ -385,7 +385,7 @@ def start_launch(self, attributes: Dict[str, Any], ts: Optional[Any] = None) ->
             rerun_of=self.variables.rerun_of,
         )
 
-    def finish_launch(self, attributes: Dict[str, Any], ts: Optional[Any] = None) -> None:
+    def finish_launch(self, attributes: dict[str, Any], ts: Optional[Any] = None) -> None:
         """Finish started launch at the ReportPortal.
 
         :param attributes: Dictionary passed by the Robot Framework
@@ -396,7 +396,7 @@ def finish_launch(self, attributes: Dict[str, Any], ts: Optional[Any] = None) ->
         self.service.finish_launch(launch=launch, ts=ts)
 
     @check_rp_enabled
-    def start_suite(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
+    def start_suite(self, name: str, attributes: dict, ts: Optional[Any] = None) -> None:
         """Start a new test suite at the ReportPortal.
 
         :param name:       Test suite name
@@ -425,7 +425,7 @@ def _log_keyword_content_removed(self, item_id: str, timestamp: str) -> None:
         self._log_data_removed(item_id, timestamp, REMOVED_KEYWORD_CONTENT_LOG)
 
     @check_rp_enabled
-    def end_suite(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
+    def end_suite(self, _: Optional[str], attributes: dict, ts: Optional[Any] = None) -> None:
         """Finish started test suite at the ReportPortal.
 
         :param _:          Test suite name
@@ -444,7 +444,7 @@ def end_suite(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None
             self.finish_launch(attributes, ts)
 
     @check_rp_enabled
-    def start_test(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
+    def start_test(self, name: str, attributes: dict, ts: Optional[Any] = None) -> None:
         """Start a new test case at the ReportPortal.
 
         :param name:       Test case name
@@ -461,7 +461,7 @@ def start_test(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> N
         self._add_current_item(test)
 
     @check_rp_enabled
-    def end_test(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
+    def end_test(self, _: Optional[str], attributes: dict, ts: Optional[Any] = None) -> None:
         """Finish started test case at the ReportPortal.
 
         :param _:          Test case name
@@ -500,7 +500,7 @@ def _log_keyword_content_flattened(self, item_id: str, timestamp: str) -> None:
         self._log_data_removed(item_id, timestamp, FLATTENED_KEYWORD_CONTENT_LOG)
 
     @check_rp_enabled
-    def start_keyword(self, name: str, attributes: Dict, ts: Optional[Any] = None) -> None:
+    def start_keyword(self, name: str, attributes: dict, ts: Optional[Any] = None) -> None:
         """Start a new keyword(test step) at the ReportPortal.
 
         :param name:       Keyword name
@@ -547,7 +547,7 @@ def _do_end_keyword(self, keyword: Keyword, ts: Optional[str] = None) -> None:
         self.service.finish_keyword(keyword=keyword, ts=ts)
 
     @check_rp_enabled
-    def end_keyword(self, _: Optional[str], attributes: Dict, ts: Optional[Any] = None) -> None:
+    def end_keyword(self, _: Optional[str], attributes: dict, ts: Optional[Any] = None) -> None:
         """Finish started keyword at the ReportPortal.
 
         :param _:          Keyword name

robotframework_reportportal/logger.py

@@ -35,7 +35,7 @@ def log_free_memory(self):
             },
         )
 """
-from typing import Dict, Optional
+from typing import Optional
 
 from robot.api import logger
 
@@ -46,7 +46,7 @@ def write(
     msg: str,
     level: str = "INFO",
     html: bool = False,
-    attachment: Optional[Dict[str, str]] = None,
+    attachment: Optional[dict[str, str]] = None,
     launch_log: bool = False,
 ) -> None:
     """Write the message to the log file using the given level.
@@ -73,12 +73,12 @@ def write(
     logger.write(log_message, level, html)
 
 
-def trace(msg: str, html: bool = False, attachment: Optional[Dict[str, str]] = None, launch_log: bool = False) -> None:
+def trace(msg: str, html: bool = False, attachment: Optional[dict[str, str]] = None, launch_log: bool = False) -> None:
     """Write the message to the log file using the ``TRACE`` level."""
     write(msg, "TRACE", html, attachment, launch_log)
 
 
-def debug(msg: str, html: bool = False, attachment: Optional[Dict[str, str]] = None, launch_log: bool = False) -> None:
+def debug(msg: str, html: bool = False, attachment: Optional[dict[str, str]] = None, launch_log: bool = False) -> None:
     """Write the message to the log file using the ``DEBUG`` level."""
     write(msg, "DEBUG", html, attachment, launch_log)
 
@@ -87,7 +87,7 @@ def info(
     msg: str,
     html: bool = False,
     also_console: bool = False,
-    attachment: Optional[Dict[str, str]] = None,
+    attachment: Optional[dict[str, str]] = None,
     launch_log: bool = False,
 ):
     """Write the message to the log file using the ``INFO`` level.
@@ -99,12 +99,12 @@ def info(
         console(msg)
 
 
-def warn(msg: str, html: bool = False, attachment: Optional[Dict[str, str]] = None, launch_log: bool = False) -> None:
+def warn(msg: str, html: bool = False, attachment: Optional[dict[str, str]] = None, launch_log: bool = False) -> None:
     """Write the message to the log file using the ``WARN`` level."""
     write(msg, "WARN", html, attachment, launch_log)
 
 
-def error(msg: str, html: bool = False, attachment: Optional[Dict[str, str]] = None, launch_log: bool = False) -> None:
+def error(msg: str, html: bool = False, attachment: Optional[dict[str, str]] = None, launch_log: bool = False) -> None:
     """Write the message to the log file using the ``ERROR`` level."""
     write(msg, "ERROR", html, attachment, launch_log)
 

robotframework_reportportal/model.py

@@ -17,7 +17,8 @@
 import os
 import re
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, List, Optional, Union
+from collections.abc import Callable
+from typing import Any, Optional, Union
 
 from reportportal_client.helpers import gen_attributes
 
@@ -36,7 +37,7 @@ class Entity:
     remove_origin: Optional[Any]
     rp_item_id: Optional[str]
     parent: Optional["Entity"]
-    skipped_keywords: List["Keyword"]
+    skipped_keywords: list["Keyword"]
     posted: bool
 
     def __init__(self, entity_type: str, parent: Optional["Entity"]):
@@ -64,7 +65,7 @@ def rp_parent_item_id(self):
 class LogMessage(str):
     """Class represents Robot Framework messages."""
 
-    attachment: Optional[Dict[str, str]]
+    attachment: Optional[dict[str, str]]
     launch_log: bool
     item_id: Optional[str]
     level: str
@@ -84,9 +85,9 @@ def __init__(self, message: str):
 class Keyword(Entity):
     """Class represents Robot Framework keyword."""
 
-    robot_attributes: Dict[str, Any]
-    args: List[str]
-    assign: List[str]
+    robot_attributes: dict[str, Any]
+    args: list[str]
+    assign: list[str]
     doc: str
     end_time: str
     keyword_name: str
@@ -95,11 +96,11 @@ class Keyword(Entity):
     name: str
     start_time: str
     status: str
-    tags: List[str]
+    tags: list[str]
     type: str = "KEYWORD"
-    skipped_logs: List[LogMessage]
+    skipped_logs: list[LogMessage]
 
-    def __init__(self, name: str, robot_attributes: Dict[str, Any], parent: Entity):
+    def __init__(self, name: str, robot_attributes: dict[str, Any], parent: Entity):
         """Initialize required attributes.
 
         :param name:              Name of the keyword
@@ -142,7 +143,7 @@ def get_type(self) -> str:
         else:
             return "STEP"
 
-    def update(self, attributes: Dict[str, Any]) -> "Keyword":
+    def update(self, attributes: dict[str, Any]) -> "Keyword":
         """Update keyword attributes on keyword finish.
 
         :param attributes: Suite attributes passed through the listener
@@ -155,22 +156,22 @@ def update(self, attributes: Dict[str, Any]) -> "Keyword":
 class Suite(Entity):
     """Class represents Robot Framework test suite."""
 
-    robot_attributes: Union[List[str], Dict[str, Any]]
+    robot_attributes: Union[list[str], dict[str, Any]]
     doc: str
     end_time: str
     longname: str
     message: str
-    metadata: Dict[str, str]
+    metadata: dict[str, str]
     name: str
     robot_id: str
     start_time: Optional[str]
     statistics: str
     status: str
-    suites: List[str]
-    tests: List[str]
+    suites: list[str]
+    tests: list[str]
     total_tests: int
 
-    def __init__(self, name: str, robot_attributes: Dict[str, Any], parent: Optional[Entity] = None):
+    def __init__(self, name: str, robot_attributes: dict[str, Any], parent: Optional[Entity] = None):
         """Initialize required attributes.
 
         :param name:       Suite name
@@ -194,7 +195,7 @@ def __init__(self, name: str, robot_attributes: Dict[str, Any], parent: Optional
         self.total_tests = robot_attributes["totaltests"]
 
     @property
-    def attributes(self) -> Optional[List[Dict[str, str]]]:
+    def attributes(self) -> Optional[list[dict[str, str]]]:
         """Get Suite attributes."""
         if self.metadata is None or not self.metadata:
             return None
@@ -206,7 +207,7 @@ def source(self) -> str:
         if self.robot_attributes.get("source") is not None:
             return os.path.relpath(self.robot_attributes["source"], os.getcwd())
 
-    def update(self, attributes: Dict[str, Any]) -> "Suite":
+    def update(self, attributes: dict[str, Any]) -> "Suite":
         """Update suite attributes on suite finish.
 
         :param attributes: Suite attributes passed through the listener
@@ -221,10 +222,10 @@ def update(self, attributes: Dict[str, Any]) -> "Suite":
 class Launch(Suite):
     """Class represents Robot Framework test suite."""
 
-    launch_attributes: Optional[List[Dict[str, str]]]
+    launch_attributes: Optional[list[dict[str, str]]]
     type: str = "LAUNCH"
 
-    def __init__(self, name: str, robot_attributes: Dict[str, Any], launch_attributes: Optional[List[str]]):
+    def __init__(self, name: str, robot_attributes: dict[str, Any], launch_attributes: Optional[list[str]]):
         """Initialize required attributes.
 
         :param name:       Launch name
@@ -236,7 +237,7 @@ def __init__(self, name: str, robot_attributes: Dict[str, Any], launch_attribute
         self.type = "LAUNCH"
 
     @property
-    def attributes(self) -> Optional[List[Dict[str, str]]]:
+    def attributes(self) -> Optional[list[dict[str, str]]]:
         """Get Launch attributes."""
         return self.launch_attributes
 
@@ -245,9 +246,9 @@ class Test(Entity):
     """Class represents Robot Framework test case."""
 
     _critical: str
-    _tags: List[str]
-    robot_attributes: Dict[str, Any]
-    test_attributes: Optional[List[Dict[str, str]]]
+    _tags: list[str]
+    robot_attributes: dict[str, Any]
+    test_attributes: Optional[list[dict[str, str]]]
     doc: str
     end_time: str
     longname: str
@@ -258,7 +259,7 @@ class Test(Entity):
     status: str
     template: str
 
-    def __init__(self, name: str, robot_attributes: Dict[str, Any], test_attributes: List[str], parent: Entity):
+    def __init__(self, name: str, robot_attributes: dict[str, Any], test_attributes: list[str], parent: Entity):
         """Initialize required attributes.
 
         :param name:             Name of the test
@@ -287,12 +288,12 @@ def critical(self) -> bool:
         return self._critical in ("yes", True)
 
     @property
-    def tags(self) -> List[str]:
+    def tags(self) -> list[str]:
         """Get list of test tags excluding test_case_id."""
         return [tag for tag in self._tags if not tag.startswith(TEST_CASE_ID_SIGN)]
 
     @property
-    def attributes(self) -> Optional[List[Dict[str, str]]]:
+    def attributes(self) -> Optional[list[dict[str, str]]]:
         """Get Test attributes."""
         return self.test_attributes + gen_attributes(self.tags)
 
@@ -323,7 +324,7 @@ def test_case_id(self) -> Optional[str]:
         # generate it if not
         return "{0}:{1}".format(self.source, self.name)
 
-    def update(self, attributes: Dict[str, Any]) -> "Test":
+    def update(self, attributes: dict[str, Any]) -> "Test":
         """Update test attributes on test finish.
 
         :param attributes: Suite attributes passed through the listener