Bump version. Add deprecated marker for typo method names

Author: Gonchik Tsymzhitov

.github/bump_version

@@ -13,13 +13,13 @@ if [[ ( -z ${1+x} ) || ( -z ${2+x} ) ]]; then
 
         Expects arguments:
         - repo: the relative/absolute path to the repository
-        - increment: (major|minor|patch) part of the version to increase, default is patch
+        - increment: (major|minor|patch) part of the version to INCREASE, default is patch
 EOF
     exit 1
 fi
 
-repo_path=${1}
-increase=${2:patch}
+REPO_PATH=${1}
+INCREASE=${2:patch}
 
 
 function autoversion(){
@@ -30,7 +30,7 @@ function autoversion(){
         BUILD_NUMBER="0"  # In the developer machine, this will build x.y.z.dev0
     fi
 
-    cd ${repo_path}
+    cd ${REPO_PATH} || exit 1
 
     git fetch --tags 2>/dev/null
     last_tag=$(git tag | sort -Vr | head -1)
@@ -40,7 +40,7 @@ function autoversion(){
         echo "0.1.0.dev${BUILD_NUMBER}"
     else
         a=( ${last_tag//./ } )   # replace points, split into array
-        case ${increase} in
+        case ${INCREASE} in
           patch)
             ((a[2]++))
             ;;

atlassian/VERSION

@@ -1 +1 @@
-2.4.1
+2.4.2

atlassian/bitbucket/__init__.py

@@ -1426,10 +1426,10 @@ def update_pull_request_comment(
         data = {"version": comment_version, "text": comment}
         return self.put(url, data=data)
 
-    @deprecated
+    @deprecated(version="2.4.2", reason="Use delete_pull_request_comment()")
     def delete_pull_reques_comment(self, project_key, repository_slug, pull_request_id, comment_id, comment_version):
         """
-        Typo will be removed
+        Deprecated name since 2.4.2. Let's use the get_pull_request()
         """
         return self.delete_pull_request_comment(
             project_key, repository_slug, pull_request_id, comment_id, comment_version

atlassian/bitbucket/cloud/base.py

@@ -10,7 +10,8 @@ def __init__(self, url, link="self", *args, **kwargs):
         """
         Init the rest api wrapper
         :param url:       The base url used for the rest api.
-        :param link:      Attribute to resolve a url based on input data. If None, no tries to receive an url from input data
+        :param link:      Attribute to resolve a url based on input data.
+                          If None, no tries to receive an url from input data
         :param *args:     The fixed arguments for the AtlassianRestApi.
         :param **kwargs:  The keyword arguments for the AtlassianRestApi.
 

atlassian/bitbucket/server/__init__.py

@@ -24,20 +24,23 @@ def __init__(self, url, *args, **kwargs):
     @property
     def groups(self):
         """
-        Property to access the global groups (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp62)
+        Property to access the global groups
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp62
         """
         return self.__groups
 
     @property
     def users(self):
         """
-        Property to access the global users (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp68)
+        Property to access the global users
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp68
         """
         return self.__users
 
     @property
     def projects(self):
         """
-        Property to access the projects (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp147)
+        Property to access the projects
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp147
         """
         return self.__projects

atlassian/bitbucket/server/projects/__init__.py

@@ -145,20 +145,23 @@ def set_avatar(self, avatar):
     @property
     def groups(self):
         """
-        Property to access the project groups (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp158)
+        Property to access the project groups
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp158
         """
         return self.__groups
 
     @property
     def users(self):
         """
-        Property to access the project groups (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp164)
+        Property to access the project groups
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp164
         """
         return self.__users
 
     @property
     def repos(self):
         """
-        Property to access the repositories (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp173)
+        Property to access the repositories
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp173
         """
         return self.__repos

atlassian/bitbucket/server/projects/repos/__init__.py

@@ -217,13 +217,15 @@ def related(self):
     @property
     def groups(self):
         """
-        Property to access the project groups (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp279)
+        Property to access the project groups:
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp279
         """
         return self.__groups
 
     @property
     def users(self):
         """
-        Property to access the project groups (https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp285)
+        Property to access the project groups
+        Reference: https://docs.atlassian.com/bitbucket-server/rest/7.8.0/bitbucket-rest.html#idp285
         """
         return self.__users

atlassian/confluence.py

@@ -4,7 +4,7 @@
 import time
 
 from requests import HTTPError
-
+from deprecated import deprecated
 from atlassian import utils
 from .errors import (
     ApiError,
@@ -506,8 +506,9 @@ def get_all_draft_pages_from_space_through_cql(self, space, start=0, limit=500,
 
         return response.get("results")
 
+    @deprecated(version="2.4.2", reason="Use get_all_restrictions_for_content()")
     def get_all_restictions_for_content(self, content_id):
-        """keep typo method"""
+        """Let's use the get_all_restrictions_for_content()"""
         log.warning("Please, be informed that is deprecated as typo naming")
         return self.get_all_restrictions_for_content(content_id=content_id)
 

examples/bitbucket/bitbucket_check_last_auth_users.py

@@ -25,11 +25,11 @@ def report(all=False, non_auth=False, limit=20):
         else:
             full_date = None
         if full_date:
-            output = f"{user.get('displayName')} ({user.get('emailAddress')}) authenticated on {full_date}"
+            output = "{} ({}) authenticated on {}".format(user.get('displayName'), user.get('emailAddress'), full_date)
             if all:
                 print(output)
         else:
-            output = f"{user.get('displayName')} ({user.get('emailAddress')}) not authenticated yet"
+            output = "{} ({}) not authenticated yet".format(user.get('displayName'), user.get('emailAddress'))
             if non_auth or all:
                 print(output)
 

examples/jira/jira_convert_group_members_into_user_in_role.py

@@ -13,7 +13,7 @@ def convert_group_into_users_in_role(project_key, role_id, group_name):
     users = jira.get_all_users_from_group(group=group_name, limit=1000).get("values")
     for user in users:
         jira.add_user_into_project_role(project_key=project_key, role_id=role_id, user_name=user.get("name"))
-        print(f"{user.get('name')} added into role_id  {role_id} in {project_key}")
+        print("{} added into role_id  {} in {}".format(user.get('name'), role_id, project_key))
 
 
 group_name_to_find = "old-developers"
@@ -27,5 +27,5 @@ def convert_group_into_users_in_role(project_key, role_id, group_name):
         for member in members_of_role:
             if member.get("type") == "atlassian-group-role-actor":
                 if member.get("name") == group_name_to_find:
-                    print(f'{project.get("key")} has {role.get("name")}')
+                    print('{} has {}'.format(project.get("key"), role.get("name")))
                     convert_group_into_users_in_role(project.get("key"), role.get("id"), group_name_to_find)