Fix build and adjust imports

Author: gonchik

CONTRIBUTING.rst

@@ -3,7 +3,8 @@ How to contribute
 
 You’re very welcome to make bug fixes or enhancements to this library.
 This document lays out the guidelines for how to get those changes into
-the main package repository.
+the main package repository. As it's a community project, we welcome all
+contributions, whether they are small bug fixes or large new features.
 
 Getting Started
 ---------------

README.rst

@@ -16,7 +16,7 @@ and is compatible with both Atlassian Server and Cloud instances.
 
 Overall, the **atlassian-python-api** is a useful tool for Python developers who want to work with Atlassian products.
 It is well-documented and actively maintained, and provides a convenient way to access the full range of
-functionality offered by the Atlassian REST APIs.
+functionality offered by the Atlassian REST APIs and made with love for Atlassian.
 
 
 Documentation

atlassian/confluence/__init__.py

@@ -21,8 +21,16 @@
     ApiNotFoundError,
     ApiPermissionError,
     ApiValueError,
+    JsonRPCError,
+    JsonRPCRestrictionsError,
 )
 from atlassian.rest_client import AtlassianRestAPI
+import sys
+
+if sys.version_info >= (3, 8):
+    from typing import Literal  # Python 3.8+
+else:
+    from typing_extensions import Literal  # Python <=3.7
 
 log = logging.getLogger(__name__)
 
@@ -870,14 +878,9 @@ def get_all_restrictions_from_page_json_rpc(self, page_id):
         if self.api_version == "cloud" or self.cloud:
             return {}
         url = "rpc/json-rpc/confluenceservice-v2"
-        data = {
-            "jsonrpc": "2.0",
-            "method": "getContentPermissionSets",
-            "id": 9,
-            "params": [page_id]
-        }
+        data = {"jsonrpc": "2.0", "method": "getContentPermissionSets", "id": 9, "params": [page_id]}
         return self.post(url, data=data).get("result") or {}
-    
+
     def update_restrictions_for_page_json_rpc(self, page_id, permission_type, content_permissions):
         """
         The JSON-RPC APIs for Confluence are provided here to help you browse and discover APIs you have access to.
@@ -892,90 +895,130 @@ def update_restrictions_for_page_json_rpc(self, page_id, permission_type, conten
             "jsonrpc": "2.0",
             "method": "setContentPermissions",
             "id": 9,
-            "params": [page_id, permission_type, content_permissions]
+            "params": [page_id, permission_type, content_permissions],
         }
         return self.post(url, data=data).get("result") or {}
-    
-    def get_users_from_restricts_in_page_by_type(self, page_id: str, restriction_type: Literal['View', 'Edit']):
-        page_name = self.get_page_by_id(page_id=page_id)['title']
+
+    def get_users_from_restricts_in_page_by_type(self, page_id: str, restriction_type: Literal["View", "Edit"]):
+        page_name = self.get_page_by_id(page_id=page_id)["title"]
         restrictions_in_page = self.get_all_restrictions_from_page_json_rpc(page_id=page_id)
         try:
             if len(restrictions_in_page) > 0:
                 for restriction_type_in_page in restrictions_in_page:
-                    if dict(restriction_type_in_page).get('type') == restriction_type:
-                        users = dict(restriction_type_in_page).get('contentPermissions')
+                    if dict(restriction_type_in_page).get("type") == restriction_type:
+                        users = dict(restriction_type_in_page).get("contentPermissions")
                 return users
             else:
-                raise JsonRPCRestrictionsError(f'On page "{page_name}" has no restrictions type of "{restriction_type}"')
+                raise JsonRPCRestrictionsError(
+                    f'On page "{page_name}" has no restrictions type of "{restriction_type}"'
+                )
         except JsonRPCError:
             raise
 
-    def create_restricts_from_from_user(self, user_name: str, restriction_type: Literal['View', 'Edit']):
-        content = {'type': restriction_type, 'userName': user_name, 'groupName': None}
-        
+    def create_restricts_from_from_user(self, user_name: str, restriction_type: Literal["View", "Edit"]):
+        content = {"type": restriction_type, "userName": user_name, "groupName": None}
+
         return content
 
-    def add_user_in_restricted_page(self, user_name: str, page_id: str, restriction_type: Literal['View', 'Edit']):
-        page_name = self.get_page_by_id(page_id=page_id).get('title')
+    def add_user_in_restricted_page(self, user_name: str, page_id: str, restriction_type: Literal["View", "Edit"]):
+        page_name = self.get_page_by_id(page_id=page_id).get("title")
         user_find_view_bool = False
         user_find_edit_bool = False
-        users_content_view: list = self.get_users_from_restricts_in_page_by_type(page_id=page_id, restriction_type='View')
-        users_content_edit: list = self.get_users_from_restricts_in_page_by_type(page_id=page_id, restriction_type='Edit')
-        current_user_content_view: dict = self.create_restricts_from_from_user(user_name=user_name, restriction_type='View')
-        current_user_content_edit: dict = self.create_restricts_from_from_user(user_name=user_name, restriction_type='Edit')
+        users_content_view: list = self.get_users_from_restricts_in_page_by_type(
+            page_id=page_id, restriction_type="View"
+        )
+        users_content_edit: list = self.get_users_from_restricts_in_page_by_type(
+            page_id=page_id, restriction_type="Edit"
+        )
+        current_user_content_view: dict = self.create_restricts_from_from_user(
+            user_name=user_name, restriction_type="View"
+        )
+        current_user_content_edit: dict = self.create_restricts_from_from_user(
+            user_name=user_name, restriction_type="Edit"
+        )
         try:
             if None not in [users_content_view, users_content_edit]:
                 if users_content_view is not None:
                     for user in users_content_view:
-                        if dict(user).get('userName') == current_user_content_view.get('userName'):
+                        if dict(user).get("userName") == current_user_content_view.get("userName"):
                             user_find_view_bool = True
                 if users_content_edit is not None:
                     for user in users_content_edit:
-                        if dict(user).get('userName') == current_user_content_edit.get('userName'):
+                        if dict(user).get("userName") == current_user_content_edit.get("userName"):
                             user_find_edit_bool = True
-                if restriction_type == 'View':
-                    if user_find_view_bool == False:
-                        current_user_content = self.create_restricts_from_from_user(user_name=user_name, restriction_type=restriction_type)
+                if restriction_type == "View":
+                    if user_find_view_bool is False:
+                        current_user_content = self.create_restricts_from_from_user(
+                            user_name=user_name, restriction_type=restriction_type
+                        )
                         users_content_view.append(current_user_content)
-                        self.update_restrictions_for_page_json_rpc(page_id=page_id, user=user_name, permission_type=restriction_type, content_permissions=users_content_view)
-                    elif user_find_view_bool == True:
-                        raise JsonRPCRestrictionsError(f'User "{user_name}" already have restrictions type of "{restriction_type}" on page "{page_name}"')
-                elif restriction_type == 'Edit':
-                    if user_find_edit_bool == False:
-                        current_user_content_view = self.create_restricts_from_from_user(user_name=user_name, restriction_type='View')
-                        current_user_content_edit = self.create_restricts_from_from_user(user_name=user_name, restriction_type=restriction_type)
+                        self.update_restrictions_for_page_json_rpc(
+                            page_id=page_id,
+                            permission_type=restriction_type,
+                            content_permissions=users_content_view,
+                        )
+                    elif user_find_view_bool:
+                        raise JsonRPCRestrictionsError(
+                            f'User "{user_name}" already have restrictions type of "{restriction_type}" on page "{page_name}"'
+                        )
+                elif restriction_type == "Edit":
+                    if not user_find_edit_bool:
+                        current_user_content_view = self.create_restricts_from_from_user(
+                            user_name=user_name, restriction_type="View"
+                        )
+                        current_user_content_edit = self.create_restricts_from_from_user(
+                            user_name=user_name, restriction_type=restriction_type
+                        )
                         users_content_view.append(current_user_content_view)
                         users_content_edit.append(current_user_content_edit)
-                        self.update_restrictions_for_page_json_rpc(page_id=page_id, permission_type='View', content_permissions=users_content_view)
-                        self.update_restrictions_for_page_json_rpc(page_id=page_id, permission_type=restriction_type, content_permissions=users_content_edit)
-                        print(f'User "{user_name}" granted restrictions type of "{restriction_type}" on page "{page_name}"')
-                    elif user_find_edit_bool == True:
-                        raise JsonRPCRestrictionsError(f'User "{user_name}" already have restrictions type of "{restriction_type}" on page "{page_name}"')
+                        self.update_restrictions_for_page_json_rpc(
+                            page_id=page_id, permission_type="View", content_permissions=users_content_view
+                        )
+                        self.update_restrictions_for_page_json_rpc(
+                            page_id=page_id, permission_type=restriction_type, content_permissions=users_content_edit
+                        )
+                        print(
+                            f'User "{user_name}" granted restrictions type of "{restriction_type}" on page "{page_name}"'
+                        )
+                    elif user_find_edit_bool:
+                        raise JsonRPCRestrictionsError(
+                            f'User "{user_name}" already have restrictions type of "{restriction_type}" on page "{page_name}"'
+                        )
         except JsonRPCError:
             raise
 
     def remove_user_from_restricted_page(self, user_name: str, page_id: str):
-        page_name = self.get_page_by_id(page_id=page_id).get('title')
+        page_name = self.get_page_by_id(page_id=page_id).get("title")
         user_find_bool = False
-        users_content_view: list = self.get_users_from_restricts_in_page_by_type(page_id=page_id, restriction_type='View')
-        users_content_edit: list = self.get_users_from_restricts_in_page_by_type(page_id=page_id, restriction_type='Edit')
-        current_user_content_view = self.create_restricts_from_from_user(user_name=user_name, restriction_type='View')
-        current_user_content_edit = self.create_restricts_from_from_user(user_name=user_name, restriction_type='Edit')
+        users_content_view: list = self.get_users_from_restricts_in_page_by_type(
+            page_id=page_id, restriction_type="View"
+        )
+        users_content_edit: list = self.get_users_from_restricts_in_page_by_type(
+            page_id=page_id, restriction_type="Edit"
+        )
+        current_user_content_view = self.create_restricts_from_from_user(user_name=user_name, restriction_type="View")
+        current_user_content_edit = self.create_restricts_from_from_user(user_name=user_name, restriction_type="Edit")
         for user_index, user_value in enumerate(users_content_view):
-            if dict(user_value).get('userName') == current_user_content_view.get('userName'):
+            if dict(user_value).get("userName") == current_user_content_view.get("userName"):
                 user_find_bool = True
                 users_content_view.pop(user_index)
         for user_index, user_value in enumerate(users_content_edit):
-            if dict(user_value).get('userName') == current_user_content_edit.get('userName'):
+            if dict(user_value).get("userName") == current_user_content_edit.get("userName"):
                 user_find_bool = True
                 users_content_edit.pop(user_index)
         try:
-            if user_find_bool == True:
-                self.update_restrictions_for_page_json_rpc(page_id=page_id, permission_type='View', content_permissions=users_content_view)
-                self.update_restrictions_for_page_json_rpc(page_id=page_id, permission_type='Edit', content_permissions=users_content_edit)
+            if user_find_bool:
+                self.update_restrictions_for_page_json_rpc(
+                    page_id=page_id, permission_type="View", content_permissions=users_content_view
+                )
+                self.update_restrictions_for_page_json_rpc(
+                    page_id=page_id, permission_type="Edit", content_permissions=users_content_edit
+                )
                 print(f'User "{user_name}" has been deleted from restrictions on page "{page_name}"')
-            elif user_find_bool == False:
-                raise JsonRPCRestrictionsError(f'User "{user_name}" has not founded in restrictions on page "{page_name}"')
+            elif not user_find_bool:
+                raise JsonRPCRestrictionsError(
+                    f'User "{user_name}" has not founded in restrictions on page "{page_name}"'
+                )
         except JsonRPCError:
             raise
 
@@ -1691,10 +1734,10 @@ def download_attachments_from_page(self, page_id, path=None, start=0, limit=50,
                 else:
                     # Sanitize filename if needed
                     if re.search(r'[<>:"/\\|?*\x00-\x1F]', file_name):
-                        sanitized = re.sub(r'[<>:"/\\|?*\x00-\x1F]', '_', file_name)
+                        sanitized = re.sub(r'[<>:"/\\|?*\x00-\x1F]', "_", file_name)
                         warnings.warn(
                             f"File name '{file_name}' contained invalid characters and was renamed to '{sanitized}'.",
-                            UserWarning
+                            UserWarning,
                         )
                         file_name = sanitized
                     file_path = os.path.join(path, file_name)

atlassian/errors.py

@@ -31,5 +31,6 @@ class ApiConflictError(ApiError):
 class ApiNotAcceptable(ApiError):
     pass
 
+
 class JsonRPCRestrictionsError(JsonRPCError):
     pass

atlassian/jira.py

@@ -7,8 +7,12 @@
 
 from deprecated import deprecated
 from requests import HTTPError, Response
-from typing_extensions import Literal
+import sys
 
+if sys.version_info >= (3, 8):
+    from typing import Literal  # Python 3.8+
+else:
+    from typing_extensions import Literal  # Python <=3.7
 from .errors import ApiNotFoundError, ApiPermissionError
 from .rest_client import AtlassianRestAPI
 from .typehints import T_id, T_resp_json

atlassian/rest_client.py

@@ -1,4 +1,5 @@
 # coding=utf-8
+
 import logging
 import random
 import time
@@ -13,11 +14,15 @@
     overload,
 )
 from urllib.parse import urlencode
-
+import sys
 import requests
 import urllib3
 from requests.adapters import HTTPAdapter
-from typing_extensions import Literal
+
+if sys.version_info >= (3, 8):
+    from typing import Literal  # Python 3.8+
+else:
+    from typing_extensions import Literal  # Python <=3.7
 
 from atlassian.typehints import T_resp_json