Cache properties and methods (#25)

Author: ebram96

src/abstract_api/company_enrichment/company_enrichment_response.py

@@ -1,45 +1,47 @@
+from functools import cached_property
+
 from ..core.bases import JSONResponse
 
 
 class CompanyEnrichmentResponse(JSONResponse):
     """Company enrichment service response."""
 
-    @property
+    @cached_property
     def name(self) -> str | None:
         """The name of the company."""
         return self._get_response_field("name")
 
-    @property
+    @cached_property
     def domain(self) -> str | None:
         """The domain the company website is hosted on."""
         return self._get_response_field("domain")
 
-    @property
+    @cached_property
     def year_founded(self) -> int | None:
         """The year the company was founded."""
         return self._get_response_field("year_founded")
 
-    @property
+    @cached_property
     def industry(self) -> str | None:
         """The industry the company is operating in."""
         return self._get_response_field("industry")
 
-    @property
+    @cached_property
     def employees_count(self) -> str | None:
         """The approximate number of employees of the company."""
         return self._get_response_field("employees_count")
 
-    @property
+    @cached_property
     def locality(self) -> str | None:
         """The city or region the company headquarter is based in."""
         return self._get_response_field("locality")
 
-    @property
+    @cached_property
     def country(self) -> str | None:
         """The country the company is based in."""
         return self._get_response_field("country")
 
-    @property
+    @cached_property
     def linkedin_url(self) -> str | None:
         """The LinkedIn URL of the company."""
         return self._get_response_field("linkedin_url")

src/abstract_api/core/bases/base_service.py

@@ -1,3 +1,4 @@
+from functools import lru_cache
 from io import BytesIO
 from typing import TYPE_CHECKING, Any, Final, Generic, Type, TypeVar
 
@@ -36,7 +37,8 @@ def __init__(self, api_key: str) -> None:
         """
         self._api_key: str = api_key
 
-    def _service_url(self, action: str = "") -> str:
+    @lru_cache(maxsize=5)
+    def __service_url(self, action: str = "") -> str:
         """Builds and returns an API URL for a service using its subdomain.
 
         Args:
@@ -80,7 +82,7 @@ def _service_request(
 
         request_kwargs: dict[str, Any] = {
             "method": _method,
-            "url": self._service_url(_action)
+            "url": self.__service_url(_action)
         }
 
         if _method == "get":

src/abstract_api/email_validation/email_validation_response.py

@@ -1,3 +1,4 @@
+from functools import cached_property
 from typing import Any
 
 import requests
@@ -43,12 +44,12 @@ def __init__(
         """Initializes a new EmailValidationResponse."""
         super().__init__(response, RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def email(self) -> str | None:
         """The value for “email” that was entered into the request."""
         return self._get_response_field("email")
 
-    @property
+    @cached_property
     def autocorrect(self) -> str | None:
         """The auto corrected email.
 
@@ -60,15 +61,15 @@ def autocorrect(self) -> str | None:
         """
         return self._get_response_field("autocorrect")
 
-    @property
+    @cached_property
     def deliverability(self) -> str | None:
         """Abstract's evaluation of the deliverability of the email.
 
         Possible values are: DELIVERABLE, UNDELIVERABLE, and UNKNOWN.
         """
         return self._get_response_field("deliverability")
 
-    @property
+    @cached_property
     def quality_score(self) -> float | None:
         """Decimal score for quality and deliverability of the submitted email.
 
@@ -77,7 +78,7 @@ def quality_score(self) -> float | None:
         """
         return self._get_response_field("quality_score")
 
-    @property
+    @cached_property
     def is_valid_format(self) -> bool | None:
         """Whether the email follows the format of “address @ domain . TLD”.
 
@@ -86,7 +87,7 @@ def is_valid_format(self) -> bool | None:
         """
         return self._get_response_field("is_valid_format")
 
-    @property
+    @cached_property
     def is_free_email(self) -> bool | None:
         """Whether email's domain is a free to use email.
 
@@ -95,7 +96,7 @@ def is_free_email(self) -> bool | None:
         """
         return self._get_response_field("is_free_email")
 
-    @property
+    @cached_property
     def is_disposable_email(self) -> bool | None:
         """Whether the email is disposable.
 
@@ -104,7 +105,7 @@ def is_disposable_email(self) -> bool | None:
         """
         return self._get_response_field("is_disposable_email")
 
-    @property
+    @cached_property
     def is_role_email(self) -> bool | None:
         """Whether the email represents a role and not an individual.
 
@@ -114,12 +115,12 @@ def is_role_email(self) -> bool | None:
         """
         return self._get_response_field("is_role_email")
 
-    @property
+    @cached_property
     def is_catchall_email(self) -> bool | None:
         """Whether the domain is configured to catch all email."""
         return self._get_response_field("is_catchall_email")
 
-    @property
+    @cached_property
     def is_mx_found(self) -> bool | None:
         """Whether MX Records for the domain can be found.
 
@@ -128,7 +129,7 @@ def is_mx_found(self) -> bool | None:
         """
         return self._get_response_field("is_mx_found")
 
-    @property
+    @cached_property
     def is_smtp_valid(self) -> bool | None:
         """Whether the SMTP check of the email was successful.
 

src/abstract_api/exchange_rates/_multiple_exchange_rates_response.py

@@ -1,3 +1,4 @@
+from functools import cached_property
 from typing import Any
 
 from ..core.bases import JSONResponse
@@ -44,12 +45,12 @@ def _init_response_field(self, field: str, value: Any) -> None:
             value = tuple(exchange_rates)
         super()._init_response_field(field, value)
 
-    @property
+    @cached_property
     def base(self) -> str | None:
         """The base currency used to get the exchange rates."""
         return self._get_response_field("base")
 
-    @property
+    @cached_property
     def exchange_rates(self) -> tuple[ExchangeRate] | None:
         """Target currencies exchange rates versus the base currency."""
         return self._get_response_field("exchange_rates")

src/abstract_api/exchange_rates/exchange_rates_conversion_response.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from ..core.bases import JSONResponse
@@ -11,30 +13,30 @@ def __init__(self, response: requests.models.Response) -> None:
         """Initializes a new ExchangeRateConversionResponse."""
         super().__init__(response, CONVERSION_RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def base(self) -> str | None:
         """The base currency used to get the exchange rates."""
         return self._get_response_field("base")
 
-    @property
+    @cached_property
     def target(self) -> str | None:
         """The target currency that the base_amount was converted into."""
         return self._get_response_field("target")
 
-    @property
+    @cached_property
     def date(self) -> str | None:
         """The date the currencies were pulled from.
 
         This is per successful request.
         """
         return self._get_response_field("date")
 
-    @property
+    @cached_property
     def base_amount(self) -> str | None:
         """The amount of the base currency from the request."""
         return self._get_response_field("base_amount")
 
-    @property
+    @cached_property
     def converted_amount(self) -> str | None:
         """The amount after conversion.
 
@@ -43,12 +45,12 @@ def converted_amount(self) -> str | None:
         """
         return self._get_response_field("converted_amount")
 
-    @property
+    @cached_property
     def exchange_rate(self) -> str | None:
         """The exchange rate used in conversion."""
         return self._get_response_field("exchange_rate")
 
-    @property
+    @cached_property
     def last_updated(self) -> str | None:
         """The Unix timestamp of when the returned data was last updated."""
         return self._get_response_field("last_updated")

src/abstract_api/exchange_rates/historical_exchange_rates_response.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from ._multiple_exchange_rates_response import MultipleExchangeRatesResponse
@@ -11,7 +13,7 @@ def __init__(self, response: requests.models.Response) -> None:
         """Initializes a new HistoricalExchangeRatesResponse."""
         super().__init__(response, HISTORICAL_RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def date(self) -> str | None:
         """The date the currencies were pulled from.
 

src/abstract_api/exchange_rates/live_exchange_rates_response.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from ._multiple_exchange_rates_response import MultipleExchangeRatesResponse
@@ -11,7 +13,7 @@ def __init__(self, response: requests.models.Response) -> None:
         """Initializes a new LiveExchangeRatesResponse."""
         super().__init__(response, LIVE_RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def last_updated(self) -> int | None:
         """The Unix timestamp of when the returned data was last updated."""
         return self._get_response_field("last_updated")

src/abstract_api/holidays/holidays_response.py

@@ -1,3 +1,4 @@
+from functools import cached_property
 from typing import Any
 
 import requests
@@ -134,13 +135,13 @@ def _init_response_field(
         holidays = []
         for c in value:
             holidays.append(Holiday(**c))
-        self._holidays = tuple(holidays)
+        self._holidays: tuple[Holiday, ...] = tuple(holidays)
 
     def __init__(self, response: requests.models.Response) -> None:
         """Initializes a new HolidaysResponse."""
         super().__init__(response, RESPONSE_FIELDS, list_response=True)
 
-    @property
-    def holidays(self) -> tuple[Holiday]:
+    @cached_property
+    def holidays(self) -> tuple[Holiday, ...]:
         """The returned holidays."""
         return self._get_response_field("holidays")

src/abstract_api/iban_validation/iban_validation_response.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from ..core.bases import JSONResponse
@@ -11,12 +13,12 @@ def __init__(self, response: requests.models.Response) -> None:
         """Initializes a new IBANValidationResponse."""
         super().__init__(response, RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def iban(self) -> str:
         """The IBAN submitted for validation."""
         return self._get_response_field("iban")
 
-    @property
+    @cached_property
     def is_valid(self) -> bool:
         """Whether the IBAN submitted is valid."""
         return self._get_response_field("is_valid")

src/abstract_api/image_processing/image_processing_response.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from ..core.bases import JSONResponse
@@ -13,42 +15,42 @@ def __init__(
         """Initializes a new ImageProcessingResponse."""
         super().__init__(response, RESPONSE_FIELDS)
 
-    @property
+    @cached_property
     def original_size(self) -> str | None:
         """The original size of the provided image, in bytes."""
         return self._get_response_field("original_size")
 
-    @property
+    @cached_property
     def original_height(self) -> str | None:
         """The original height of the provided image, in bytes."""
         return self._get_response_field("original_height")
 
-    @property
+    @cached_property
     def original_width(self) -> str | None:
         """The original width of the provided image, in bytes."""
         return self._get_response_field("original_width")
 
-    @property
+    @cached_property
     def final_size(self) -> str | None:
         """The final size of the processed image, in bytes."""
         return self._get_response_field("final_size")
 
-    @property
+    @cached_property
     def bytes_saved(self) -> str | None:
         """The number of bytes saved by optimizing the image, in bytes."""
         return self._get_response_field("bytes_saved")
 
-    @property
+    @cached_property
     def final_height(self) -> str | None:
         """The final height of the processed image, in bytes."""
         return self._get_response_field("final_height")
 
-    @property
+    @cached_property
     def final_width(self) -> str | None:
         """The final width of the processed image, in bytes."""
         return self._get_response_field("final_width")
 
-    @property
+    @cached_property
     def url(self) -> str | None:
         """The URL with the new processed image."""
         return self._get_response_field("url")