PHMINT-85: Avoid excessively long lines whenever possible

pyproject.toml

@@ -64,10 +64,12 @@ disable_error_code = [
     "arg-type",
 ]
 
+[tool.pylint]
+max-line-length = 79
+
 [tool.pylint."MESSAGE CONTROL"]
 disable = [
-    "C0114",
-    "C0301",
+    "C0301", # line-too-long
     "C0411",
     "C0415",
     "C2801",
@@ -93,6 +95,9 @@ disable = [
     "W1514",
 ]
 
+[tool.ruff]
+line-length = 79
+
 [tool.ruff.lint]
 extend-safe-fixes = [
     "D400", # docstrings should end with a period

src/multisafepay/api/base/decorator.py

@@ -16,7 +16,8 @@ class Decorator:
 
     Attributes
     ----------
-    dependencies (Optional[Dict]): A dictionary of dependencies to be used by the decorator.
+    dependencies (Optional[Dict]): A dictionary of dependencies to be
+        used by the decorator.
 
     """
 
@@ -28,7 +29,8 @@ def __init__(self: "Decorator", dependencies: Dict = None) -> None:
 
         Parameters
         ----------
-        dependencies (dict): A dictionary of dependencies to be used by the decorator, by default {}.
+        dependencies (dict): A dictionary of dependencies to be used
+            by the decorator, by default {}.
 
         """
         self.dependencies = dependencies if dependencies is not None else {}
@@ -42,7 +44,8 @@ def adapt_checkout_options(
 
         Parameters
         ----------
-        checkout_options (Optional[dict]): A dictionary containing checkout options, by default None.
+        checkout_options (Optional[dict]): A dictionary containing
+            checkout options, by default None.
 
         Returns
         -------
@@ -89,7 +92,8 @@ def adapt_custom_info(
 
         Parameters
         ----------
-        custom_info (Optional[dict]): A dictionary containing custom information, by default None.
+        custom_info (Optional[dict]): A dictionary containing custom
+            information, by default None.
 
         Returns
         -------
@@ -114,7 +118,8 @@ def adapt_customer(
 
         Parameters
         ----------
-        customer (Optional[dict]): A dictionary containing customer information, by default None.
+        customer (Optional[dict]): A dictionary containing customer
+            information, by default None.
 
         Returns
         -------
@@ -137,7 +142,8 @@ def adapt_order_adjustment(
 
         Parameters
         ----------
-        order_adjustment (Optional[dict]): A dictionary containing order adjustment information, by default None.
+        order_adjustment (Optional[dict]): A dictionary containing
+            order adjustment information, by default None.
 
         Returns
         -------
@@ -164,7 +170,8 @@ def adapt_payment_details(
 
         Parameters
         ----------
-        payment_details (Optional[dict]): A dictionary containing payment details, by default None.
+        payment_details (Optional[dict]): A dictionary containing
+            payment details, by default None.
 
         Returns
         -------
@@ -191,7 +198,8 @@ def adapt_payment_methods(
 
         Parameters
         ----------
-        payment_methods (Optional[dict]): A dictionary containing payment methods, by default None.
+        payment_methods (Optional[dict]): A dictionary containing
+            payment methods, by default None.
 
         Returns
         -------
@@ -216,7 +224,8 @@ def adapt_shopping_cart(
 
         Parameters
         ----------
-        shopping_cart (Optional[dict]): A dictionary containing shopping cart information, by default None.
+        shopping_cart (Optional[dict]): A dictionary containing
+            shopping cart information, by default None.
 
         Returns
         -------
@@ -240,7 +249,8 @@ def adapt_related_transactions(
 
         Parameters
         ----------
-        related_transactions (Optional[dict]): A dictionary containing related transactions, by default None.
+        related_transactions (Optional[dict]): A dictionary containing
+            related transactions, by default None.
 
         Returns
         -------
@@ -264,7 +274,8 @@ def adapt_apps(self: "Decorator", apps: Optional[Dict]) -> "Decorator":
 
         Parameters
         ----------
-        apps (Optional[dict]): A dictionary containing app information, by default None.
+        apps (Optional[dict]): A dictionary containing app information,
+            by default None.
 
         Returns
         -------
@@ -289,7 +300,8 @@ def adapt_brands(
 
         Parameters
         ----------
-        brands (Optional[List[Optional[dict]]]): A list of dictionaries containing brand information, by default None.
+        brands (Optional[List[Optional[dict]]]): A list of
+            dictionaries containing brand information, by default None.
 
         Returns
         -------
@@ -315,7 +327,8 @@ def adapt_icon_urls(
 
         Parameters
         ----------
-        icon_urls (Optional[dict]): A dictionary containing icon URL information, by default None.
+        icon_urls (Optional[dict]): A dictionary containing icon URL
+            information, by default None.
 
         Returns
         -------
@@ -340,7 +353,8 @@ def adapt_tokenization(
 
         Parameters
         ----------
-        tokenization: (dict, optional) A dictionary containing tokenization information, by default None.
+        tokenization: (dict, optional) A dictionary containing
+            tokenization information, by default None.
 
         Returns
         -------
@@ -367,7 +381,8 @@ def adapt_allowed_amount(
 
         Parameters
         ----------
-        allowed_amount (Optional[dict]): A dictionary containing allowed amount information, by default None.
+        allowed_amount (Optional[dict]): A dictionary containing
+            allowed amount information, by default None.
 
         Returns
         -------

src/multisafepay/api/paths/orders/request/order_request.py

@@ -570,5 +570,5 @@ def validate_amount(self: "OrderRequest") -> "OrderRequest":
         OrderRequest: The validated OrderRequest object.
 
         """
-        validate = validate_total_amount(self.dict())
+        validate_total_amount(self.dict())
         return self

src/multisafepay/api/paths/payment_methods/response/components/__init__.py

@@ -1 +1 @@
-"""Payment method response components for detailed payment method configurations."""
+"""Payment method response components and configurations."""

src/multisafepay/api/shared/cart/__init__.py

@@ -1 +1 @@
-"""Shopping cart components for handling cart items and shopping cart operations."""
+"""Shopping cart components for cart items and operations."""

src/multisafepay/api/shared/checkout/__init__.py

@@ -1 +1 @@
-"""Checkout components for handling checkout options, tax rules, and payment configuration."""
+"""Checkout components: options, tax rules, and configuration."""

src/multisafepay/api/shared/checkout/tax_rule.py

@@ -5,7 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
-"""Tax rule model for defining taxation rules and rates in checkout processing."""
+"""Tax rule model for taxation rules and rates."""
 
 from typing import Any, Dict, List, Optional, Union
 

src/multisafepay/api/shared/costs.py

@@ -5,7 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
-"""Transaction costs model for handling fees and charges in payment processing."""
+"""Transaction costs model for fees and charges."""
 
 from typing import Optional
 

src/multisafepay/api/shared/customer.py

@@ -151,7 +151,8 @@ def from_dict(d: dict) -> Optional["Customer"]:
 
         Returns
         -------
-        Optional[Customer]: A Customer instance if the dictionary is not None, otherwise None.
+        Optional[Customer]: A Customer instance if the dictionary is
+            not None, otherwise None.
 
         """
         if d is None:

src/multisafepay/api/shared/delivery.py

@@ -258,7 +258,8 @@ def from_dict(d: Optional[dict]) -> Optional["Delivery"]:
 
         Returns
         -------
-        Optional[Delivery]: A Delivery instance if the dictionary is not None, otherwise None.
+        Optional[Delivery]: A Delivery instance if the dictionary is
+            not None, otherwise None.
 
         """
         if d is None:

src/multisafepay/model/api_model.py

@@ -30,19 +30,21 @@ class Config:
         Attributes
         ----------
         extra (str):
-            Specifies how to handle extra fields. Set to "allow" to include extra fields.
+            Specifies how to handle extra fields. Set to "allow" to
+            include extra fields.
 
         """
 
         extra = "allow"
 
     def to_dict(self: "ApiModel") -> dict:
         """
-        Convert the model to a dictionary, removing null values recursively.
+        Convert the model to a dictionary, removing null values.
 
         Returns
         -------
-        dict: The dictionary representation of the model with null values removed.
+        dict: The dictionary representation of the model with null
+        values removed.
 
         """
         return remove_null_recursive(self.dict())

src/multisafepay/model/extra_model.py

@@ -25,7 +25,8 @@ class Config:
         Attributes
         ----------
         extra (str):
-            Specifies how to handle extra fields. Set to "allow" to include extra fields.
+            Specifies how to handle extra fields. Set to "allow" to
+            include extra fields.
 
         """
 

src/multisafepay/model/inmutable_model.py

@@ -14,7 +14,8 @@ class InmutableModel(BaseModel):
     """
     A base model class that extends Pydantic's BaseModel.
 
-    This class is immutable, meaning its attributes cannot be changed after initialization.
+    This class is immutable, meaning its attributes cannot be
+    changed after initialization.
     """
 
     class Config:
@@ -24,7 +25,8 @@ class Config:
         Attributes
         ----------
         allow_mutation (bool):
-            Specifies whether mutation of model attributes is allowed. Set to False to make the model immutable.
+            Specifies whether mutation of model attributes is allowed.
+            Set to False to make the model immutable.
 
         """
 

src/multisafepay/model/request_model.py

@@ -32,11 +32,12 @@ class Config:
 
     def to_dict(self: "RequestModel") -> dict:
         """
-        Convert the model to a dictionary, removing null values recursively.
+        Convert the model to a dictionary, removing null values.
 
         Returns
         -------
-        dict: The dictionary representation of the model with null values removed.
+        dict: The dictionary representation of the model with null
+        values removed.
 
         """
         return remove_null_recursive(input_data=self.dict())

src/multisafepay/model/response_model.py

@@ -15,9 +15,11 @@
 
 class ResponseModel(BaseModel):
     """
-    A base model class for response models that extends Pydantic's BaseModel.
+    A base model class for response models that extends Pydantic's
+    BaseModel.
 
-    This class is immutable and allows extra fields to be included in the model.
+    This class is immutable and allows extra fields to be included
+    in the model.
 
     """
 
@@ -27,9 +29,11 @@ class Config:
 
         Attributes
         ----------
-        allow_mutation (bool): Specifies whether mutation of model attributes is allowed.
-            Set to False to make the model immutable.
-        extra (str): Specifies how to handle extra fields. Set to "allow" to include extra fields.
+        allow_mutation (bool): Specifies whether mutation of model
+            attributes is allowed. Set to False to make the model
+            immutable.
+        extra (str): Specifies how to handle extra fields. Set to
+            "allow" to include extra fields.
 
         """
 
@@ -48,6 +52,7 @@ def from_dict(d: dict) -> Optional["ResponseModel"]:
 
         Returns
         -------
-        Optional[ResponseModel]: The created model instance or None if the dictionary is invalid.
+        Optional[ResponseModel]: The created model instance or None
+            if the dictionary is invalid.
 
         """

src/multisafepay/sdk.py

@@ -31,8 +31,8 @@ class Sdk:
     """
     SDK class for interacting with the MultiSafePay API.
 
-    This class provides methods to manage various resources such as transactions,
-    gateways, payment methods, issuers, orders, and more.
+    This class provides methods to manage various resources such as
+    transactions, gateways, payment methods, issuers, orders, etc.
     """
 
     def __init__(

src/multisafepay/value_object/creditcard/cvc.py

@@ -45,11 +45,13 @@ def validate(cls: "Cvc", cvc: str) -> str:
 
         Returns
         -------
-        bool: True if the CVC is valid, raises InvalidArgumentException otherwise.
+        bool: True if the CVC is valid, raises
+            InvalidArgumentException otherwise.
 
         Raises
         ------
-        InvalidArgumentException: If the CVC does not have 3 digits or is not numeric.
+        InvalidArgumentException: If the CVC does not have 3 digits
+            or is not numeric.
 
         """
         cvc = cvc.replace(" ", "")

src/multisafepay/value_object/date.py

@@ -57,7 +57,8 @@ def get(self: "Date", date_format: str = "%Y-%m-%d") -> str:
 
         Parameters
         ----------
-        date_format Optional[str]: The format to return the date in (default is "%Y-%m-%d").
+        date_format Optional[str]: The format to return the date in
+            (default is "%Y-%m-%d").
 
         Returns
         -------

tests/multisafepay/e2e/examples/capture_manager/test_capture_reservation_cancel.py

@@ -170,6 +170,6 @@ def test_capture_reservation_cancel(sdk: Sdk):
 
     assert isinstance(capture_reservation_cancel_response, CustomApiResponse)
     assert capture_reservation_cancel_response.get_status_code() == 200
-    assert capture_reservation_cancel_response.get_body_success() == True
+    assert capture_reservation_cancel_response.get_body_success() is True
     capture_reservation = capture_reservation_cancel_response.get_data()
     assert isinstance(capture_reservation, CancelReservation)

tests/multisafepay/e2e/examples/recurring_manager/test_recurring.py

@@ -155,4 +155,4 @@ def test_recurring(sdk: Sdk):
     assert isinstance(delete_response, CustomApiResponse)
     delete_data_response = delete_response.get_body_data()
     assert isinstance(delete_data_response, dict)
-    assert delete_data_response.get("removed") == True
+    assert delete_data_response.get("removed") is True