Coverage for src/fluree_py/http/mixin/request.py: 87%

1"""Base mixin for HTTP request handling in Fluree operations.""" 

2 

3from abc import ABC, abstractmethod 

4from dataclasses import dataclass 

5 

6from httpx import Request 

7 

8from fluree_py.http.protocol.mixin.request import SupportsRequestCreation 

9from fluree_py.types.common import JsonObject 

10 

11 

12@dataclass(frozen=True, kw_only=True) 

13class RequestMixin(ABC, SupportsRequestCreation): 

14 """Base class for creating and managing HTTP requests.""" 

15 

16 def get_request(self) -> Request: 

17 """Constructs an HTTP request with the operation's data. 

18 

19 Exceptions: 

20 NotImplementedError: If get_url() or build_request_payload() are not implemented. 

21 """ 

22 return Request( 

23 method="POST", 

24 url=self.get_url(), 

25 json=self.build_request_payload(), 

26 ) 

27 

28 @abstractmethod 

29 def get_url(self) -> str: 

30 """Returns the endpoint URL for the request. 

31 

32 Exceptions: 

33 NotImplementedError: If not implemented by subclass. 

34 """ 

35 ... 

36 

37 @abstractmethod 

38 def build_request_payload(self) -> JsonObject: 

39 """Constructs the JSON payload for the request. 

40 

41 Exceptions: 

42 NotImplementedError: If not implemented by subclass. 

43 """ 

44 ...