Coverage for amazonorders/entity/order.py: 93.94%
132 statements
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-24 18:41 +0000
« prev ^ index » next coverage.py v7.4.0, created at 2024-01-24 18:41 +0000
1import logging
2from datetime import datetime, date
3from typing import List, Optional, TypeVar
4from urllib.parse import parse_qs
5from urllib.parse import urlparse
7from bs4 import BeautifulSoup, Tag
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
15__author__ = "Alex Laird"
16__copyright__ = "Copyright 2024, Alex Laird"
17__version__ = "1.0.4"
19logger = logging.getLogger(__name__)
21Entity = TypeVar('Entity', bound='Order')
24class Order(Parsable):
25 """
26 An Amazon Order.
27 """
29 def __init__(self,
30 parsed: Tag,
31 full_details: bool = False,
32 clone: Optional[Entity] = None) -> None:
33 super().__init__(parsed)
35 #: If the Orders full details were populated from its details page.
36 self.full_details: bool = full_details
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)
55 # Fields below this point are only populated if `full_details` is True
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
78 def __repr__(self) -> str:
79 return "<Order #{}: \"{}\">".format(self.order_number, self.items)
81 def __str__(self) -> str: # pragma: no cover
82 return "Order #{}: {}".format(self.order_number, self.items)
84 def _parse_shipments(self) -> List[Shipment]:
85 return [Shipment(x) for x in self.parsed.find_all("div", {"class": "shipment"})]
87 def _parse_items(self) -> List[Item]:
88 return [Item(x) for x in self.parsed.find_all("div", {"class": "yohtmlc-item"})]
90 def _parse_order_details_link(self) -> Optional[str]:
91 tag = self.parsed.find("a", {"class": "yohtmlc-order-details-link"})
92 if tag:
93 return "{}{}".format(BASE_URL, tag.attrs["href"])
94 elif self.order_number:
95 return "{}/gp/your-account/order-details?orderID={}".format(BASE_URL, self.order_number)
96 else:
97 return None
99 def _parse_order_number(self) -> str:
100 try:
101 order_details_link = self._parse_order_details_link()
102 except:
103 # We're not using safe_parse here because it's fine if this fails, no need for noise
104 order_details_link = None
105 if order_details_link:
106 parsed_url = urlparse(order_details_link)
107 return parse_qs(parsed_url.query)["orderID"][0]
108 else:
109 tag = self.parsed.find("bdi", dir="ltr")
110 return tag.text.strip()
112 def _parse_grand_total(self) -> float:
113 tag = self.parsed.find("div", {"class": "yohtmlc-order-total"})
114 if tag:
115 tag = tag.find("span", {"class": "value"})
116 else:
117 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
118 if "grand total" in tag.text.lower():
119 tag = tag.find("div", {"class": "a-span-last"})
120 break
121 return float(tag.text.strip().replace("$", ""))
123 def _parse_order_placed_date(self) -> date:
124 tag = self.parsed.find("span", {"class": "order-date-invoice-item"})
125 if tag:
126 date_str = tag.text.split("Ordered on")[1].strip()
127 else:
128 tag = self.parsed.find("div", {"class": "a-span3"}).find_all("span")
129 date_str = tag[1].text.strip()
130 return datetime.strptime(date_str, "%B %d, %Y").date()
132 def _parse_recipient(self) -> Recipient:
133 tag = self.parsed.find("div", {"class": "displayAddressDiv"})
134 if not tag:
135 script_id = self.parsed.find("div",
136 id=lambda value: value and value.startswith("shipToInsertionNode")).attrs[
137 "id"]
138 tag = self.parsed.find("script",
139 id="shipToData-shippingAddress-{}".format(script_id.split("-")[2]))
140 tag = BeautifulSoup(str(tag.contents[0]).strip(), "html.parser")
141 return Recipient(tag)
143 def _parse_payment_method(self) -> Optional[str]:
144 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"})
145 if tag:
146 return tag.attrs["alt"]
147 else:
148 return None
150 def _parse_payment_method_last_4(self) -> Optional[str]:
151 tag = self.parsed.find("img", {"class": "pmts-payment-credit-card-instrument-logo"})
152 if tag:
153 ending_sibling = tag.find_next_siblings()[-1]
154 return ending_sibling.text.split("ending in")[1].strip()
155 else:
156 return None
158 def _parse_subtotal(self) -> Optional[float]:
159 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
160 if "subtotal" in tag.text.lower():
161 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
163 return None
165 def _parse_shipping_total(self) -> Optional[float]:
166 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
167 if "shipping" in tag.text.lower():
168 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
170 return None
172 def _parse_subscription_discount(self) -> Optional[float]:
173 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
174 if "subscribe" in tag.text.lower():
175 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
177 return None
179 def _parse_total_before_tax(self) -> Optional[float]:
180 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
181 if "before tax" in tag.text.lower():
182 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
184 return None
186 def _parse_estimated_tax(self) -> Optional[float]:
187 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
188 if "estimated tax" in tag.text.lower():
189 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
191 return None
193 def _parse_refund_total(self) -> Optional[float]:
194 for tag in self.parsed.find("div", id="od-subtotals").find_all("div", {"class": "a-row"}):
195 if "refund total" in tag.text.lower() and "tax refund" not in tag.text.lower():
196 return float(tag.find("div", {"class": "a-span-last"}).text.strip().replace("$", ""))
198 return None
200 def _parse_order_shipping_date(self) -> Optional[date]:
201 # TODO: find a better way to do this
202 if "Items shipped:" in self.parsed.text:
203 date_str = self.parsed.text.split("Items shipped:")[1].strip().split("-")[0].strip()
204 return datetime.strptime(date_str, "%B %d, %Y").date()
205 else:
206 return None
208 def _parse_refund_completed_date(self) -> Optional[date]:
209 # TODO: find a better way to do this
210 if "Refund: Completed" in self.parsed.text:
211 date_str = self.parsed.text.split("Refund: Completed")[1].strip().split("-")[0].strip()
212 return datetime.strptime(date_str, "%B %d, %Y").date()
213 else:
214 return None