Drop stub files

Author: HardNorth

reportportal_client/_internal/services/client_id.py

@@ -17,6 +17,7 @@
 import io
 import logging
 import os
+from typing import Iterable, Optional, Union
 from uuid import uuid4
 
 from .constants import CLIENT_ID_PROPERTY, RP_FOLDER_PATH, RP_PROPERTIES_FILE_PATH
@@ -32,35 +33,35 @@ def __preprocess_file(self, fp):
         content = "[" + self.DEFAULT_SECTION + "]\n" + fp.read()
         return io.StringIO(content)
 
-    def read(self, filenames, encoding=None):
+    def read(self, filenames: Union[Iterable[str], str], source: Optional[str] = None) -> None:
         if isinstance(filenames, str):
             filenames = [filenames]
         for filename in filenames:
             with open(filename, "r") as fp:
                 preprocessed_fp = self.__preprocess_file(fp)
                 self.read_file(preprocessed_fp, filename)
 
-    def write(self, fp, space_around_delimiters=True):
+    def write(self, fp, space_around_delimiters: bool = True) -> None:
         for key, value in self.items(self.DEFAULT_SECTION):
             delimiter = " = " if space_around_delimiters else "="
             fp.write("{}{}{}\n".format(key, delimiter, value))
 
 
-def __read_config():
+def __read_config() -> configparser.ConfigParser:
     config = __NoSectionConfigParser()
     if os.path.exists(RP_PROPERTIES_FILE_PATH):
         config.read(RP_PROPERTIES_FILE_PATH)
     return config
 
 
-def _read_client_id():
+def _read_client_id() -> Optional[str]:
     config = __read_config()
     if config.has_option(__NoSectionConfigParser.DEFAULT_SECTION, CLIENT_ID_PROPERTY):
         return config.get(__NoSectionConfigParser.DEFAULT_SECTION, CLIENT_ID_PROPERTY)
     return None
 
 
-def _store_client_id(client_id):
+def _store_client_id(client_id: str) -> None:
     config = __read_config()
     if not os.path.exists(RP_FOLDER_PATH):
         os.makedirs(RP_FOLDER_PATH)
@@ -69,7 +70,7 @@ def _store_client_id(client_id):
         config.write(fp)
 
 
-def get_client_id():
+def get_client_id() -> str:
     """Return unique client ID of the instance, generate new if not exists."""
     client_id = None
     try:

reportportal_client/_internal/services/client_id.pyi

@@ -17,7 +17,7 @@
 import os
 
 
-def _decode_string(text):
+def _decode_string(text: str) -> str:
     """Decode value of the given string.
 
     :param text: Encoded string
@@ -28,8 +28,8 @@ def _decode_string(text):
     return message_bytes.decode("ascii")
 
 
-CLIENT_INFO = _decode_string("Ry1XUDU3UlNHOFhMOm5Ib3dqRjJQUVotNDFJbzBPcDRoZlE=")
-ENDPOINT = "https://www.google-analytics.com/mp/collect"
-CLIENT_ID_PROPERTY = "client.id"
-RP_FOLDER_PATH = os.path.join(os.path.expanduser("~"), ".rp")
-RP_PROPERTIES_FILE_PATH = os.path.join(RP_FOLDER_PATH, "rp.properties")
+CLIENT_INFO: str = _decode_string("Ry1XUDU3UlNHOFhMOm5Ib3dqRjJQUVotNDFJbzBPcDRoZlE=")
+ENDPOINT: str = "https://www.google-analytics.com/mp/collect"
+CLIENT_ID_PROPERTY: str = "client.id"
+RP_FOLDER_PATH: str = os.path.join(os.path.expanduser("~"), ".rp")
+RP_PROPERTIES_FILE_PATH: str = os.path.join(RP_FOLDER_PATH, "rp.properties")

reportportal_client/_internal/services/constants.py

@@ -14,12 +14,24 @@
 """This module contains classes representing RP file object."""
 
 import uuid
+from typing import Any, Optional
 
 
 class RPFile(object):
     """Class representation for a file that will be attached to the log."""
 
-    def __init__(self, name=None, content=None, content_type=None, data=None, mime=None):
+    content: Optional[Any]
+    content_type: str
+    name: str
+
+    def __init__(
+        self,
+        name: Optional[str] = None,
+        content: Optional[Any] = None,
+        content_type: Optional[str] = None,
+        data: Optional[Any] = None,
+        mime: Optional[str] = None,
+    ) -> None:
         """Initialize instance attributes.
 
         :param name:         File name
@@ -33,6 +45,6 @@ def __init__(self, name=None, content=None, content_type=None, data=None, mime=N
         self.name = name if name and name.strip() else str(uuid.uuid4())
 
     @property
-    def payload(self):
+    def payload(self) -> dict:
         """Get HTTP payload for the request."""
         return {"content": self.content, "contentType": self.content_type, "name": self.name}

reportportal_client/_internal/services/constants.pyi

@@ -39,11 +39,25 @@
 }
 """
 
+from typing import Any, Optional
+
 
 class Issue:
     """This class represents an issue that can be attached to test result."""
 
-    def __init__(self, issue_type, comment=None, auto_analyzed=False, ignore_analyzer=True):
+    _external_issues: list
+    auto_analyzed: bool
+    comment: Optional[str]
+    ignore_analyzer: bool
+    issue_type: str
+
+    def __init__(
+        self,
+        issue_type: str,
+        comment: Optional[str] = None,
+        auto_analyzed: bool = False,
+        ignore_analyzer: bool = True,
+    ) -> None:
         """Initialize instance attributes.
 
         :param issue_type:      Issue type locator. Allowable values: "pb***",
@@ -61,12 +75,12 @@ def __init__(self, issue_type, comment=None, auto_analyzed=False, ignore_analyze
         self.ignore_analyzer = ignore_analyzer
         self.issue_type = issue_type
 
-    def external_issue_add(self, issue):
+    def external_issue_add(self, issue: "ExternalIssue") -> None:
         """Add external system issue to the issue."""
         self._external_issues.append(issue.payload)
 
     @property
-    def payload(self):
+    def payload(self) -> dict[str, Optional[Any]]:
         """Form the correct dictionary for the issue."""
         return {
             "autoAnalyzed": self.auto_analyzed,
@@ -80,7 +94,20 @@ def payload(self):
 class ExternalIssue:
     """This class represents external(BTS) system issue."""
 
-    def __init__(self, bts_url=None, bts_project=None, submit_date=None, ticket_id=None, url=None):
+    bts_url: Optional[str]
+    bts_project: Optional[str]
+    submit_date: Optional[str]
+    ticket_id: Optional[str]
+    url: Optional[str]
+
+    def __init__(
+        self,
+        bts_url: Optional[str] = None,
+        bts_project: Optional[str] = None,
+        submit_date: Optional[str] = None,
+        ticket_id: Optional[str] = None,
+        url: Optional[str] = None,
+    ) -> None:
         """Initialize instance attributes.
 
         :param bts_url:     Bug tracker system URL
@@ -96,7 +123,7 @@ def __init__(self, bts_url=None, bts_project=None, submit_date=None, ticket_id=N
         self.url = url
 
     @property
-    def payload(self):
+    def payload(self) -> dict[str, Optional[str]]:
         """Form the correct dictionary for the BTS issue."""
         return {
             "btsUrl": self.bts_url,