libpagure

Clone

#20 __call_api: Replace private with protected method
Merged 7 years ago by yangl1996. Opened 7 years ago by mbasti.
mbasti/libpagure protected-method  into  master

file modified
+31 -31 
@@ -49,8 +49,8 @@ 
 

          else:
 

              self.header = None
 

  

-     def __call_api(self, url, method='GET', params=None, data=None):
 

-         """ Private method used to call the API.
 

+     def _call_api(self, url, method='GET', params=None, data=None):
 

+         """ Method used to call the API.
 

          It returns the raw JSON returned by the API or raises an exception
 

          if something goes wrong.
 

  
@@ -97,7 +97,7 @@ 
 

          :return:
 

          """
 

          request_url = "{}/api/0/version".format(self.instance)
 

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

          return return_value['version']
 

  

      def list_users(self, pattern=None):
 
@@ -110,7 +110,7 @@ 
 

          params = None
 

          if pattern:
 

              params = {'pattern': pattern}
 

-         return_value = self.__call_api(request_url, params=params)
 

+         return_value = self._call_api(request_url, params=params)
 

          return return_value['users']
 

  

      def list_tags(self, pattern=None):
 
@@ -129,7 +129,7 @@ 
 

          if pattern:
 

              params = {'pattern': pattern}
 

  

-         return_value = self.__call_api(request_url, params=params)
 

+         return_value = self._call_api(request_url, params=params)
 

          return return_value['tags']
 

  

      def list_groups(self, pattern=None):
 
@@ -143,7 +143,7 @@ 
 

          if pattern:
 

              params = {'pattern': pattern}
 

  

-         return_value = self.__call_api(request_url, params=params)
 

+         return_value = self._call_api(request_url, params=params)
 

          return return_value['groups']
 

  

      def error_codes(self):
 
@@ -152,7 +152,7 @@ 
 

          :return:
 

          """
 

          request_url = "{}/api/0/error_codes".format(self.instance)
 

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

          return return_value
 

  

      def list_requests(self, status=None, assignee=None, author=None):
 
@@ -177,7 +177,7 @@ 
 

          if author is not None:
 

              payload['author'] = author
 

  

-         return_value = self.__call_api(request_url, params=payload)
 

+         return_value = self._call_api(request_url, params=payload)
 

          return return_value['requests']
 

  

      def request_info(self, request_id):
 
@@ -194,7 +194,7 @@ 
 

                  self.instance, self.username, self.repo,
 

                  request_id)
 

  

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

          return return_value
 

  

      def merge_request(self, request_id):
 
@@ -211,7 +211,7 @@ 
 

                  self.instance, self.username, self.repo,
 

                  request_id)
 

  

-         return_value = self.__call_api(request_url, method='POST')
 

+         return_value = self._call_api(request_url, method='POST')
 

  

          if return_value['message'] != "Changes merged!":
 

              raise Exception(return_value['message'])
 
@@ -230,7 +230,7 @@ 
 

                  self.instance, self.username, self.repo,
 

                  request_id)
 

  

-         return_value = self.__call_api(request_url, method='POST')
 

+         return_value = self._call_api(request_url, method='POST')
 

  

          if return_value['message'] != "Pull-request closed!":
 

              raise Exception(return_value['message'])
 
@@ -262,8 +262,8 @@ 
 

          if row is not None:
 

              payload['row'] = row
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if return_value['message'] != "Comment added":
 

              raise Exception(return_value['message'])
 
@@ -297,8 +297,8 @@ 
 

          if uid is not None:
 

              payload['uid'] = uid
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if return_value['message'] != "Flag added" and return_value['message'] != "Flag updated":
 

              raise Exception(return_value['message'])
 
@@ -322,8 +322,8 @@ 
 

          if private:
 

              payload['private'] = private
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if return_value['message'] != "Issue created":
 

              raise Exception(return_value['message'])
 
@@ -371,7 +371,7 @@ 
 

          if since is not None:
 

              payload['since'] = since
 

  

-         return_value = self.__call_api(request_url, params=payload)
 

+         return_value = self._call_api(request_url, params=payload)
 

  

          return return_value['issues']
 

  
@@ -389,7 +389,7 @@ 
 

                  self.instance, self.username, self.repo,
 

                  issue_id)
 

  

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

  

          return return_value
 

  
@@ -408,7 +408,7 @@ 
 

                  self.instance, self.username, self.repo,
 

                  issue_id, comment_id)
 

  

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

  

          return return_value
 

  
@@ -433,8 +433,8 @@ 
 

          if close_status is not None:
 

              payload['close_status'] = close_status
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if not return_value['message'].startswith("Successfully"):
 

              raise Exception(return_value['message'])
 
@@ -456,8 +456,8 @@ 
 

  

          payload = {} if milestone is None else {'milestone': milestone}
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if not return_value['message'].startswith("Successfully"):
 

              raise Exception(return_value['message'])
 
@@ -479,8 +479,8 @@ 
 

  

          payload = {'comment': body}
 

  

-         return_value = self.__call_api(request_url,
 

-                                        method='POST', data=payload)
 

+         return_value = self._call_api(request_url,
 

+                                       method='POST', data=payload)
 

  

          if return_value['message'] != 'Comment added':
 

              raise Exception(return_value['message'])
 
@@ -497,7 +497,7 @@ 
 

              request_url = "{}/api/0/fork/{}/{}/git/tags".format(
 

                  self.instance, self.username, self.repo)
 

  

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

  

          return return_value['tags']
 

  
@@ -519,7 +519,7 @@ 
 

          if fork is not None:
 

              payload['fork'] = fork
 

  

-         return_value = self.__call_api(request_url, params=payload)
 

+         return_value = self._call_api(request_url, params=payload)
 

  

          return return_value['projects']
 

  
@@ -531,7 +531,7 @@ 
 

          """
 

          request_url = "{}/api/0/user/{}".format(self.instance, username)
 

  

-         return_value = self.__call_api(request_url)
 

+         return_value = self._call_api(request_url)
 

  

          return return_value
 

  
@@ -560,7 +560,7 @@ 
 

          if create_readme is not None:
 

              payload['create_readme'] = create_readme
 

  

-         return_value = self.__call_api(request_url, data=payload,
 

-                                        method='POST')
 

+         return_value = self._call_api(request_url, data=payload,
 

+                                       method='POST')
 

  

          return return_value['message']

private method makes it harder for developer to inherite from Pagure class
and update it with own methods. There is no need for __call_api to be
private. Is enough to have _call_api which can be used in inherited classes.

rebased
7 years ago

Dependencies have been pushed

Python doesn't really have protected methods (or private) - the underscore is just a convention used to indicate that an API isn't intended to be a public interface (i.e., outsiders shouldn't rely on it being stable/maintained).

Looks fine to me, I just would avoid the word protected (and private) and just describe what the method does. I think you can rely on API users to know the convention of underscores to mean "don't rely on this".

Description updated

rebased
7 years ago

Can we expect a new release as a new pagure version has been deployed?

Merged.

Pull-Request has been merged by yangl1996
7 years ago

v0.9 released. Thank you for all those pull requests :D

you are welcome :)

Could you also release to fedora? Please, pretty please.

Yes but 0.6 not 0.9 IIUC

Yes.

@sayanchowdhury could you please help update the fedora package? Thanks!

Looking for a way to update the package in fedora repo.

i will go ahead with updating the libpagure package.

Edited 7 years ago by sayanchowdhury
Metadata
None
No Tags
Changes Summary 1
+31 -31
file changed
libpagure/libpagure.py
Powered by Pagure 5.13.3
Documentation • File an Issue • About • SSH Hostkey/Fingerprint
© Red Hat, Inc. and others.