Enh/code revamp 4 (#34)

* Enhance docstring in _validate_params method

* Remove a won't do todo

* Update JSONResponseMeta._body_json initialization

* Fix a typo in docstrings

* Rename body_json to response_json

* Make response_fields modules private

Author: ebram96

src/abstract_api/avatars/avatars.py

@@ -20,7 +20,11 @@ class Avatars(BaseService[AvatarsResponse]):
 
     @staticmethod
     def _validate_params(**kwargs) -> None:
-        """Validates passed service parameters."""
+        """Validates passed service parameters.
+
+        Raises:
+            ClientRequestError if a parameter has invalid/not acceptable value.
+        """
         ranged = {
             "image_size": (6, 512),
             "font_size": (0.1, 1.0),

…pi/company_enrichment/response_fields.py …i/company_enrichment/_response_fields.pysrc/abstract_api/company_enrichment/response_fields.py renamed to src/abstract_api/company_enrichment/_response_fields.py src/abstract_api/company_enrichment/response_fields.py renamed to src/abstract_api/company_enrichment/_response_fields.py

@@ -2,8 +2,8 @@
 
 from ..core.bases import BaseService
 from ..core.mixins import ResponseFieldsMixin
+from ._response_fields import RESPONSE_FIELDS
 from .company_enrichment_response import CompanyEnrichmentResponse
-from .response_fields import RESPONSE_FIELDS
 
 
 class CompanyEnrichment(

src/abstract_api/company_enrichment/company_enrichment.py

@@ -8,7 +8,7 @@ class BaseResponseMeta(ABC):
     """Base response metadata for Abstract API service response."""
 
     def __init__(self, response: requests.models.Response) -> None:
-        """Initialize a new BaseResponseMeta."""
+        """Initializes a new BaseResponseMeta."""
         self._http_status: int = response.status_code
         self._body: bytes = response.content
 
@@ -32,7 +32,7 @@ class BaseResponse(ABC):
     _meta_class: ClassVar[Type[BaseResponseMeta]]
 
     def __init__(self, response: requests.models.Response) -> None:
-        """Initialize a new BaseResponse."""
+        """Initializes a new BaseResponse."""
         self._meta: BaseResponseMeta = self._meta_class(response)
 
     @property

src/abstract_api/core/bases/_base_response.py

@@ -15,7 +15,7 @@ class FileResponse(BaseResponse):
     meta: FileResponseMeta
 
     def __init__(self, response: requests.models.Response) -> None:
-        """Initialize a new FileResponse."""
+        """Initializes a new FileResponse."""
         super().__init__(response)
         self._content: bytes = response.content
 

src/abstract_api/core/bases/file_response.py

@@ -9,17 +9,17 @@ class JSONResponseMeta(BaseResponseMeta):
     """Metadata about a JSON-based API response."""
 
     def __init__(self, response: requests.models.Response) -> None:
-        """Initialize a new JSONResponseMeta."""
+        """Initializes a new JSONResponseMeta."""
         super().__init__(response)
-        try:
-            self._body_json = response.json()
-        except:  # noqa: E722
-            self._body_json = None
+        if response.status_code == requests.codes.NO_CONTENT:
+            self._response_json = None
+        else:
+            self._response_json = response.json()
 
     @property
-    def body_json(self) -> dict[str, Any] | list[dict[str, Any]]:
+    def response_json(self) -> dict[str, Any] | list[dict[str, Any]] | None:
         """JSON representation of response body returned from API request."""
-        return self._body_json
+        return self._response_json
 
 
 class JSONResponse(BaseResponse):
@@ -65,23 +65,23 @@ def __init__(
         response_fields: frozenset[str],
         list_response: bool = False
     ) -> None:
-        """Initialize a new JSONResponse."""
+        """Initializes a new JSONResponse."""
         self._response_fields = response_fields  # Must be set first.
 
         super().__init__(response)
 
-        if self.meta.body_json is None:
+        if self.meta.response_json is None:
             return
 
         if TYPE_CHECKING:
-            assert isinstance(self.meta.body_json, dict)
+            assert isinstance(self.meta.response_json, dict)
 
         not_in_response = object()
         for field in response_fields:
             value = (
-                self.meta.body_json.get(field, not_in_response)
+                self.meta.response_json.get(field, not_in_response)
                 if not list_response
-                else self.meta.body_json
+                else self.meta.response_json
             )
             # Initialize property only if field was returned
             if value is not not_in_response:

src/abstract_api/core/bases/json_response.py

@@ -50,21 +50,21 @@ def details(self) -> dict[str, Any] | None:
         return self._details
 
     @staticmethod
-    def _get_error_details(body_json: dict[str, Any]) -> dict[str, Any]:
+    def _get_error_details(response_json: dict[str, Any]) -> dict[str, Any]:
         """Extracts error details from response.
 
         Args:
-            body_json: Returned response body as JSON.
+            response_json: Returned response body as JSON.
 
         Returns:
             A dict containing error details: message, code, and details.
         """
         error_details = {}
 
-        if body_json and body_json.get("error"):
-            error_details["message"] = body_json["error"].get("message")
-            error_details["code"] = body_json["error"].get("code")
-            error_details["details"] = body_json["error"].get("details")
+        if response_json and response_json.get("error"):
+            error_details["message"] = response_json["error"].get("message")
+            error_details["code"] = response_json["error"].get("code")
+            error_details["details"] = response_json["error"].get("details")
 
         return error_details
 
@@ -107,11 +107,11 @@ def raise_from_response(
                 error details returned from API when available.
         """
         try:
-            body_json = response.json()
+            response_json = response.json()
         except Exception:
-            body_json = {}
+            response_json = {}
 
-        error_details = cls._get_error_details(body_json)
+        error_details = cls._get_error_details(response_json)
         raised_error_message = cls._build_raised_error_message(
             error_details, response.status_code
         )

src/abstract_api/core/exceptions/api_request_error.py

@@ -4,7 +4,7 @@
 import requests
 
 from ..core.bases import JSONResponse
-from .response_fields import RESPONSE_FIELDS
+from ._response_fields import RESPONSE_FIELDS
 
 
 class EmailValidationResponse(JSONResponse):