Merge pull request #110 from AbduazizZiyodov/master

Refactor type annotations

Author: Muhammadali-Akbarov

payme/classes/cards.py

@@ -19,7 +19,7 @@ class Cards:
     services. It allows you to create new cards and retrieve verification
     codes for existing cards.
     """
-    def __init__(self, url: str, payme_id: str) -> "Cards":
+    def __init__(self, url: str, payme_id: str) -> None:
         """
         Initialize the Cards client.
 

payme/classes/client.py

@@ -1,5 +1,4 @@
-
-from typing import Union
+import typing as t
 
 from payme.const import Networks
 from payme.classes.cards import Cards
@@ -11,20 +10,23 @@ class Payme:
     """
     The payme class provides a simple interface
     """
+
     def __init__(
         self,
         payme_id: str,
-        fallback_id: Union[str, None] = None,
-        payme_key: Union[str, None] = None,
-        is_test_mode: bool = False
-    ):
-
+        fallback_id: t.Optional[str] = None,
+        payme_key: t.Optional[str] = None,
+        is_test_mode: bool = False,
+    ) -> None:
         # initialize payme network
         url = Networks.PROD_NET.value
 
         if is_test_mode is True:
             url = Networks.TEST_NET.value
 
         self.cards = Cards(url=url, payme_id=payme_id)
-        self.initializer = Initializer(payme_id=payme_id, fallback_id=fallback_id, is_test_mode=is_test_mode)
-        self.receipts = Receipts(url=url, payme_id=payme_id, payme_key=payme_key)  # noqa
+        self.initializer = Initializer(
+            payme_id=payme_id, fallback_id=fallback_id, is_test_mode=is_test_mode
+        )
+        if payme_key:
+            self.receipts = Receipts(url=url, payme_id=payme_id, payme_key=payme_key)

payme/classes/initializer.py

@@ -13,17 +13,14 @@ class Initializer:
         The Payme ID associated with your account
     """
 
-    def __init__(self, payme_id: str = None, fallback_id: str = None, is_test_mode: bool = False):
+    def __init__(
+        self, payme_id: str = None, fallback_id: str = None, is_test_mode: bool = False
+    ) -> None:
         self.payme_id = payme_id
         self.fallback_id = fallback_id
         self.is_test_mode = is_test_mode
 
-    def generate_pay_link(
-        self,
-        id: int,
-        amount: int,
-        return_url: str
-    ) -> str:
+    def generate_pay_link(self, id: int, amount: int, return_url: str) -> str:
         """
         Generate a payment link for a specific order.
 
@@ -52,9 +49,7 @@ def generate_pay_link(
         https://developer.help.paycom.uz/initsializatsiya-platezhey/
         """
         amount = amount * 100  # Convert amount to the smallest currency unit
-        params = (
-            f'm={self.payme_id};ac.{settings.PAYME_ACCOUNT_FIELD}={id};a={amount};c={return_url}'
-        )
+        params = f"m={self.payme_id};ac.{settings.PAYME_ACCOUNT_FIELD}={id};a={amount};c={return_url}"
         params = base64.b64encode(params.encode("utf-8")).decode("utf-8")
 
         if self.is_test_mode is True:

payme/classes/receipts.py

@@ -1,4 +1,4 @@
-from typing import Union, Optional
+import typing as t
 
 from payme.classes.cards import Cards
 from payme.classes.http import HttpClient
@@ -20,7 +20,8 @@ class Receipts:
     """
     The Receipts class provides methods to interact with the Payme Receipts.
     """
-    def __init__(self, payme_id: str, payme_key: str, url: str) -> "Receipts":
+
+    def __init__(self, payme_id: str, payme_key: str, url: str) -> None:
         """
         Initialize the Receipts client.
 
@@ -32,33 +33,33 @@ def __init__(self, payme_id: str, payme_key: str, url: str) -> "Receipts":
 
         headers = {
             "X-Auth": f"{payme_id}:{payme_key}",
-            "Content-Type": "application/json"
+            "Content-Type": "application/json",
         }
         self.http = HttpClient(url, headers)
 
     def create(
         self,
         account: dict,
-        amount: Union[float, int],
-        description: Optional[str] = None,
-        detail: Optional[dict] = None,
-        timeout: int = 10
+        amount: t.Union[float, int],
+        description: t.Optional[str] = None,
+        detail: t.Optional[t.Dict] = None,
+        timeout: int = 10,
     ) -> response.CreateResponse:
         """
         Create a new receipt.
 
         :param account: The account details for the receipt.
         :param amount: The amount of the receipt.
-        :param description: Optional description for the receipt.
-        :param detail: Optional additional details for the receipt.
+        :param description: t.Optional description for the receipt.
+        :param detail: t.Optional additional details for the receipt.
         :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.create"
         params = {
             "amount": amount,
             "account": account,
             "description": description,
-            "detail": detail
+            "detail": detail,
         }
         return self._post_request(method, params, timeout)
 
@@ -74,10 +75,7 @@ def pay(
             The request timeout duration in seconds (default is 10).
         """
         method = "receipts.pay"
-        params = {
-            "id": receipts_id,
-            "token": token
-        }
+        params = {"id": receipts_id, "token": token}
         return self._post_request(method, params, timeout)
 
     def send(
@@ -91,76 +89,56 @@ def send(
         :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.send"
-        params = {
-            "id": receipts_id,
-            "phone": phone
-        }
+        params = {"id": receipts_id, "phone": phone}
         return self._post_request(method, params, timeout)
 
-    def cancel(
-        self, receipts_id: str, timeout: int = 10
-    ) -> response.CancelResponse:
+    def cancel(self, receipts_id: str, timeout: int = 10) -> response.CancelResponse:
         """
         Cancel the receipt.
 
         :param receipts_id: The ID of the cheque used for payment.
         :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.cancel"
-        params = {
-            "id": receipts_id
-        }
+        params = {"id": receipts_id}
         return self._post_request(method, params, timeout)
 
-    def check(
-        self, receipts_id: str, timeout: int = 10
-    ) -> response.CheckResponse:
+    def check(self, receipts_id: str, timeout: int = 10) -> response.CheckResponse:
         """
         Check the status of a cheque.
 
         :param receipts_id: The ID of the cheque used for payment.
         :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.check"
-        params = {
-            "id": receipts_id
-        }
+        params = {"id": receipts_id}
         return self._post_request(method, params, timeout)
 
-    def get(
-        self, receipts_id: str, timeout: int = 10
-    ) -> response.GetResponse:
+    def get(self, receipts_id: str, timeout: int = 10) -> response.GetResponse:
         """
         Get the details of a specific cheque.
 
         :param receipts_id: The ID of the cheque used for payment.
         :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.get"
-        params = {
-            "id": receipts_id
-        }
+        params = {"id": receipts_id}
         return self._post_request(method, params, timeout)
 
     def get_all(
         self, count: int, from_: int, to: int, offset: int, timeout: int = 10
     ) -> response.GetAllResponse:
         """
-        Get all cheques for a specific account.
+         Get all cheques for a specific account.
 
-        :param count: The number of cheques to retrieve.
-        :param from_: The start index of the cheques to retrieve.
-        :param to: The end index of the cheques to retrieve.
-        :param offset: The offset for pagination.
-       :param timeout: The request timeout duration in seconds (default 10).
+         :param count: The number of cheques to retrieve.
+         :param from_: The start index of the cheques to retrieve.
+         :param to: The end index of the cheques to retrieve.
+         :param offset: The offset for pagination.
+        :param timeout: The request timeout duration in seconds (default 10).
         """
         method = "receipts.get_all"
-        params = {
-            "count": count,
-            "from": from_,
-            "to": to,
-            "offset": offset
-        }
+        params = {"count": count, "from": from_, "to": to, "offset": offset}
         return self._post_request(method, params, timeout)
 
     def _post_request(
@@ -185,6 +163,7 @@ def test(self):
         covering creation, payment, sending, cancellation, status checks,
         retrieval of a single receipt, and retrieval of multiple receipts.
         """
+
         # Helper to assert conditions with messaging
         def assert_condition(condition, message, test_case):
             self._assert_and_print(condition, message, test_case=test_case)
@@ -195,36 +174,34 @@ def create_sample_receipt():
                 account={"id": 12345},
                 amount=1000,
                 description="Test receipt",
-                detail={"key": "value"}
+                detail={"key": "value"},
             )
 
         # Test 1: Initialization check
         assert_condition(
             isinstance(self, Receipts),
             "Initialized Receipts class successfully.",
-            test_case="Initialization Test"
+            test_case="Initialization Test",
         )
 
         # Test 2: Create and Pay Receipt
         create_response = create_sample_receipt()
         assert_condition(
             isinstance(create_response, response.CreateResponse),
             "Created a new receipt successfully.",
-            test_case="Receipt Creation Test"
+            test_case="Receipt Creation Test",
         )
 
         # pylint: disable=W0212
         assert_condition(
             isinstance(create_response.result.receipt._id, str),
             "Created a valid receipt ID.",
-            test_case="Receipt ID Test"
+            test_case="Receipt ID Test",
         )
 
         # Prepare card and verification
         cards_create_response = self.__cards.create(
-            number="8600495473316478",
-            expire="0399",
-            save=True
+            number="8600495473316478", expire="0399", save=True
         )
         token = cards_create_response.result.card.token
         self.__cards.get_verify_code(token=token)
@@ -236,7 +213,7 @@ def create_sample_receipt():
         assert_condition(
             pay_response.result.receipt.state == 4,
             "Paid the receipt successfully.",
-            test_case="Payment Test"
+            test_case="Payment Test",
         )
 
         # Test 3: Create and Send Receipt
@@ -246,7 +223,7 @@ def create_sample_receipt():
         assert_condition(
             send_response.result.success is True,
             "Sent the receipt successfully.",
-            test_case="Send Test"
+            test_case="Send Test",
         )
 
         # Test 4: Create and Cancel Receipt
@@ -256,43 +233,37 @@ def create_sample_receipt():
         assert_condition(
             cancel_response.result.receipt.state == 50,
             "Cancelled the receipt successfully.",
-            test_case="Cancel Test"
+            test_case="Cancel Test",
         )
 
         # Test 5: Check Receipt Status
         check_response = self.check(receipts_id=receipt_id)
         assert_condition(
             check_response.result.state == 50,
             "Checked the receipt status successfully.",
-            test_case="Check Test"
+            test_case="Check Test",
         )
 
         # Test 6: Get Receipt Details
         get_response = self.get(receipts_id=receipt_id)
         assert_condition(
             get_response.result.receipt._id == receipt_id,
             "Retrieved the receipt details successfully.",
-            test_case="Get Test"
+            test_case="Get Test",
         )
 
         # Test 7: Retrieve All Receipts
         get_all_response = self.get_all(
-            count=1,
-            from_=1730322122000,
-            to=1730398982000,
-            offset=0
+            count=1, from_=1730322122000, to=1730398982000, offset=0
         )
         assert_condition(
             isinstance(get_all_response.result, list),
             "Retrieved all receipts successfully.",
-            test_case="Get All Test"
+            test_case="Get All Test",
         )
 
     # pylint: disable=W0212
     def _assert_and_print(
-        self,
-        condition: bool,
-        success_message: str,
-        test_case: Optional[str] = None
+        self, condition: bool, success_message: str, test_case: t.Optional[str] = None
     ):
         self.__cards._assert_and_print(condition, success_message, test_case)