Coverage for amazonorders/entity/order.py: 94.12%

1import logging 

2from datetime import datetime, date 

3from typing import List, Optional, TypeVar 

4from urllib.parse import parse_qs 

5from urllib.parse import urlparse 

6 

7from bs4 import BeautifulSoup, Tag 

8 

9from amazonorders.entity.item import Item 

10from amazonorders.entity.parsable import Parsable 

11from amazonorders.entity.recipient import Recipient 

12from amazonorders.entity.shipment import Shipment 

13from amazonorders.session import BASE_URL 

14 

15__author__ = "Alex Laird" 

16__copyright__ = "Copyright 2024, Alex Laird" 

17__version__ = "1.0.5" 

18 

19logger = logging.getLogger(__name__) 

20 

21Entity = TypeVar('Entity', bound='Order') 

22 

23 

24class Order(Parsable): 

25 """ 

26 An Amazon Order. 

27 """ 

28 

29 def __init__(self, 

30 parsed: Tag, 

31 full_details: bool = False, 

32 clone: Optional[Entity] = None) -> None: 

33 super().__init__(parsed) 

34 

35 #: If the Orders full details were populated from its details page. 

36 self.full_details: bool = full_details 

37 

38 #: The Order Shipments. 

39 self.shipments: List[Shipment] = clone.shipments if clone else self._parse_shipments() 

40 #: The Order Items. 

41 self.items: List[Item] = clone.items if clone and not full_details else self._parse_items() 

42 #: The Order number. 

43 self.order_number: str = clone.order_number if clone else self.safe_parse(self._parse_order_number) 

44 #: The Order details link. 

45 self.order_details_link: Optional[str] = clone.order_details_link if clone else self.safe_parse( 

46 self._parse_order_details_link) 

47 #: The Order grand total. 

48 self.grand_total: float = clone.grand_total if clone else self.safe_parse(self._parse_grand_total) 

49 #: The Order placed date. 

50 self.order_placed_date: date = clone.order_placed_date if clone else self.safe_parse( 

51 self._parse_order_placed_date) 

52 #: The Order Recipients. 

53 self.recipient: Recipient = clone.recipient if clone else self.safe_parse(self._parse_recipient) 

54 

55 # Fields below this point are only populated if `full_details` is True 

56 

57 #: The Order payment method. 

58 self.payment_method: Optional[str] = self._parse_payment_method() if self.full_details else None 

59 #: The Order payment method's last 4 digits. 

60 self.payment_method_last_4: Optional[str] = self._parse_payment_method_last_4() if self.full_details else None 

61 #: The Order subtotal. 

62 self.subtotal: Optional[float] = self._parse_subtotal() if self.full_details else None 

63 #: The Order shipping total. 

64 self.shipping_total: Optional[float] = self._parse_shipping_total() if self.full_details else None 

65 #: The Order Subscribe & Save discount. 

66 self.subscription_discount: Optional[float] = self._parse_subscription_discount() if self.full_details else None 

67 #: The Order total before tax. 

68 self.total_before_tax: Optional[float] = self._parse_total_before_tax() if self.full_details else None 

69 #: The Order estimated tax. 

70 self.estimated_tax: Optional[float] = self._parse_estimated_tax() if self.full_details else None 

71 #: The Order refund total. 

72 self.refund_total: Optional[float] = self._parse_refund_total() if self.full_details else None 

73 #: The Order shipped date. 

74 self.order_shipped_date: Optional[date] = self._parse_order_shipping_date() if self.full_details else None 

75 #: The Order refund total. 

76 self.refund_completed_date: Optional[date] = self._parse_refund_completed_date() if self.full_details else None 

77 

78 def __repr__(self) -> str: 

79 return "<Order #{}: \"{}\">".format(self.order_number, self.items) 

80 

81 def __str__(self) -> str: # pragma: no cover 

82 return "Order #{}: {}".format(self.order_number, self.items) 

83 

84 def _parse_shipments(self) -> List[Shipment]: 

85 shipments = [Shipment(x) for x in self.parsed.find_all("div", {"class": "shipment"})] 

86 shipments.sort() 

87 return shipments 

88 

89 def _parse_items(self) -> List[Item]: 

90 items = [Item(x) for x in self.parsed.find_all("div", {"class": "yohtmlc-item"})] 

91 items.sort() 

92 return items 

93 

94 def _parse_order_details_link(self) -> Optional[str]: 

95 tag = self.parsed.find("a", {"class": "yohtmlc-order-details-link"}) 

96 if tag: 

97 return "{}{}".format(BASE_URL, tag.attrs["href"]) 

98 elif self.order_number: 

99 return "{}/gp/your-account/order-details?orderID={}".format(BASE_URL, self.order_number) 

100 else: 

101 return None 

102 

103 def _parse_order_number(self) -> str: 

104 try: 

105 order_details_link = self._parse_order_details_link() 

106 except: 

107 # We're not using safe_parse here because it's fine if this fails, no need for noise 

108 order_details_link = None 

109 if order_details_link: 

110 parsed_url = urlparse(order_details_link) 

111 return parse_qs(parsed_url.query)["orderID"][0] 

112 else: 

113 tag = self.parsed.find("bdi", dir="ltr") 

114 return tag.text.strip() 

115 

116 def _parse_grand_total(self) -> float: 

117 tag = self.parsed.find("div", {"class": "yohtmlc-order-total"}) 

118 if tag: 

119 tag = tag.find("span", {"class": "value"}) 

120 else: 

121 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

122 if "grand total" in tag.text.lower(): 

123 tag = tag.find("div", {"class": "a-span-last"}) 

124 break 

125 return float(tag.text.strip().replace("$", "")) 

126 

127 def _parse_order_placed_date(self) -> date: 

128 tag = self.parsed.find("span", {"class": "order-date-invoice-item"}) 

129 if tag: 

130 date_str = tag.text.split("Ordered on")[1].strip() 

131 else: 

132 tag = self.parsed.find("div", {"class": "a-span3"}).find_all("span") 

133 date_str = tag[1].text.strip() 

134 return datetime.strptime(date_str, "%B %d, %Y").date() 

135 

136 def _parse_recipient(self) -> Recipient: 

137 tag = self.parsed.find("div", {"class": "displayAddressDiv"}) 

138 if not tag: 

139 script_id = self.parsed.find("div", 

140 id=lambda value: value and value.startswith("shipToInsertionNode")).attrs[ 

141 "id"] 

142 tag = self.parsed.find("script", 

143 id="shipToData-shippingAddress-{}".format(script_id.split("-")[2])) 

144 tag = BeautifulSoup(str(tag.contents[0]).strip(), "html.parser") 

145 return Recipient(tag) 

146 

147 def _parse_payment_method(self) -> Optional[str]: 

148 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"}) 

149 if tag: 

150 return tag.attrs["alt"] 

151 else: 

152 return None 

153 

154 def _parse_payment_method_last_4(self) -> Optional[str]: 

155 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"}) 

156 if tag: 

157 ending_sibling = tag.find_next_siblings()[-1] 

158 return ending_sibling.text.split("ending in")[1].strip() 

159 else: 

160 return None 

161 

162 def _parse_subtotal(self) -> Optional[float]: 

163 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

164 if "subtotal" in tag.text.lower(): 

165 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

166 

167 return None 

168 

169 def _parse_shipping_total(self) -> Optional[float]: 

170 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

171 if "shipping" in tag.text.lower(): 

172 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

173 

174 return None 

175 

176 def _parse_subscription_discount(self) -> Optional[float]: 

177 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

178 if "subscribe" in tag.text.lower(): 

179 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

180 

181 return None 

182 

183 def _parse_total_before_tax(self) -> Optional[float]: 

184 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

185 if "before tax" in tag.text.lower(): 

186 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

187 

188 return None 

189 

190 def _parse_estimated_tax(self) -> Optional[float]: 

191 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

192 if "estimated tax" in tag.text.lower(): 

193 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

194 

195 return None 

196 

197 def _parse_refund_total(self) -> Optional[float]: 

198 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}): 

199 if "refund total" in tag.text.lower() and "tax refund" not in tag.text.lower(): 

200 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", "")) 

201 

202 return None 

203 

204 def _parse_order_shipping_date(self) -> Optional[date]: 

205 # TODO: find a better way to do this 

206 if "Items shipped:" in self.parsed.text: 

207 date_str = self.parsed.text.split("Items shipped:")[1].strip().split("-")[0].strip() 

208 return datetime.strptime(date_str, "%B %d, %Y").date() 

209 else: 

210 return None 

211 

212 def _parse_refund_completed_date(self) -> Optional[date]: 

213 # TODO: find a better way to do this 

214 if "Refund: Completed" in self.parsed.text: 

215 date_str = self.parsed.text.split("Refund: Completed")[1].strip().split("-")[0].strip() 

216 return datetime.strptime(date_str, "%B %d, %Y").date() 

217 else: 

218 return None