Use property decorator to improve typing compatibility (#1925)

nakato · web-flow · commit e4168109dd53 · 2021-04-26T14:23:34.000+10:00
As a property these functions are expected to be accessed without the
private __get_ and __set_ functions, however while the functions are
typed, the property is not, and mypy shows an attribute error.

As this codebase no-longer requires support for python versions without
support for @property.setter(2.6?) this updates the functions to use
decorators and updates the type files to reflect the attribute
existence.
diff --git a/github/MainClass.py b/github/MainClass.py
@@ -142,31 +142,29 @@ def __init__(
             pool_size,
         )
 
-    def __get_FIX_REPO_GET_GIT_REF(self):
+    @property
+    def FIX_REPO_GET_GIT_REF(self):
         """
         :type: bool
         """
         return self.__requester.FIX_REPO_GET_GIT_REF
 
-    def __set_FIX_REPO_GET_GIT_REF(self, value):
+    @FIX_REPO_GET_GIT_REF.setter
+    def FIX_REPO_GET_GIT_REF(self, value):
         self.__requester.FIX_REPO_GET_GIT_REF = value
 
-    FIX_REPO_GET_GIT_REF = property(
-        __get_FIX_REPO_GET_GIT_REF, __set_FIX_REPO_GET_GIT_REF
-    )
-
-    def __get_per_page(self):
+    # v2: Remove this property? Why should it be necessary to read/modify it after construction
+    @property
+    def per_page(self):
         """
         :type: int
         """
         return self.__requester.per_page
 
-    def __set_per_page(self, value):
+    @per_page.setter
+    def per_page(self, value):
         self.__requester.per_page = value
 
-    # v2: Remove this property? Why should it be necessary to read/modify it after construction
-    per_page = property(__get_per_page, __set_per_page)
-
     # v2: Provide a unified way to access values of headers of last response
     # v2: (and add/keep ad hoc properties for specific useful headers like rate limiting, oauth scopes, etc.)
     # v2: Return an instance of a class: using a tuple did not allow to add a field "resettime"
diff --git a/github/MainClass.pyi b/github/MainClass.pyi
@@ -41,10 +41,14 @@ class Github:
         verify: bool = ...,
         retry: Any = ...,
     ) -> None: ...
-    def __get_FIX_REPO_GET_GIT_REF(self) -> bool: ...
-    def __set_FIX_REPO_GET_GIT_REF(self, value: bool) -> None: ...
-    def __get_per_page(self) -> int: ...
-    def __set_per_page(self, value: int) -> None: ...
+    @property
+    def FIX_REPO_GET_GIT_REF(self) -> bool: ...
+    @FIX_REPO_GET_GIT_REF.setter
+    def FIX_REPO_GET_GIT_REF(self, value: bool) -> None: ...
+    @property
+    def per_page(self) -> int: ...
+    @per_page.setter
+    def per_page(self, value: int) -> None: ...
     def create_from_raw_data(
         self,
         klass: Type[TGithubObject],
