Request/Response object models

Author: iivanou

.pre-commit-config.yaml

@@ -8,7 +8,6 @@ repos:
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
-    -   id: flake8
 -   repo: https://github.com/PyCQA/pydocstyle
     rev: 5.0.2
     hooks:
@@ -17,3 +16,7 @@ repos:
     rev: v1.0.0
     hooks:
     -   id: rst-linter
+-   repo: https://gitlab.com/pycqa/flake8.git
+    rev: 3.7.7
+    hooks:
+    -   id: flake8

reportportal_client/core/rp_file.py

@@ -0,0 +1,28 @@
+"""This module contains classes representing RP file object."""
+
+
+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):
+        """Initialize instance attributes.
+
+        :param name:         File name
+        :param content:      File content
+        :param content_type: File content type (i.e. application/pdf)
+        """
+        self.content = content
+        self.content_type = content_type
+        self.name = name
+
+    @property
+    def payload(self):
+        """Get HTTP payload for the request."""
+        return {
+            'content': self.content,
+            'contentType': self.content_type,
+            'name': self.name
+        }

reportportal_client/core/rp_file.pyi

@@ -0,0 +1,12 @@
+from typing import Any, Dict, Optional, Text
+
+class RPFile:
+    content: Any = ...
+    content_type: Text = ...
+    name: Text = ...
+    def __init__(self,
+                 name: Optional[Text],
+                 content: Any,
+                 content_type: Optional[Text]) -> None: ...
+    @property
+    def payload(self) -> Dict: ...

reportportal_client/core/rp_issues.py

@@ -24,6 +24,20 @@
   }
   ...
 }
+
+Copyright (c) 2018 http://reportportal.io .
+
+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.
 """
 
 
@@ -37,8 +51,9 @@ def __init__(self,
                  ignore_analyzer=True):
         """Initialize instance attributes.
 
-        :param issue_type:      Type of the issue. One of the followings:
-                                NOT_ISSUE, ab001, pb001, si001, nd001, ti001
+        :param issue_type:      Issue type locator. Allowable values: "pb***",
+                                "ab***", "si***", "ti***", "nd001". Where ***
+                                is locator id.
         :param comment:         Issue comments
         :param auto_analyzed:   Indicator that the issue has been marked with
                                 the RP auto analyzer

reportportal_client/core/rp_issues.pyi

@@ -1,31 +1,31 @@
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, Text
 
 class Issue:
     _external_issues: List = ...
     auto_analyzed: bool = ...
-    comment: str = ...
+    comment: Text = ...
     ignore_analyzer: bool = ...
-    issue_type: str = ...
+    issue_type: Text = ...
     def __init__(self,
-                 issue_type: str,
-                 comment: Optional[str] = ...,
+                 issue_type: Text,
+                 comment: Optional[Text] = ...,
                  auto_analyzed: Optional[bool] = ...,
                  ignore_analyzer: Optional[bool] = ...) -> None: ...
     def external_issue_add(self, issue: ExternalIssue) -> None: ...
     @property
     def payload(self) -> Dict: ...
 
 class ExternalIssue:
-    bts_url: str = ...
-    bts_project: str = ...
-    submit_date: str = ...
-    ticket_id: str = ...
-    url: str = ...
+    bts_url: Text = ...
+    bts_project: Text = ...
+    submit_date: Text = ...
+    ticket_id: Text = ...
+    url: Text = ...
     def __init__(self,
-                 bts_url: Optional[str] = ...,
-                 bts_project: Optional[str] = ...,
-                 submit_date: Optional[str] = ...,
-                 ticket_id: Optional[str] = ...,
-                 url: Optional[str] = ...) -> None: ...
+                 bts_url: Optional[Text] = ...,
+                 bts_project: Optional[Text] = ...,
+                 submit_date: Optional[Text] = ...,
+                 ticket_id: Optional[Text] = ...,
+                 url: Optional[Text] = ...) -> None: ...
     @property
     def payload(self) -> Dict: ...