yad2-scraper 0.5.1__py3-none-any.whl → 0.5.3__py3-none-any.whl

yad2_scraper/exceptions.py

@@ -6,7 +6,6 @@ class ResponseError(Exception):
     """Represents an error response from an HTTP request."""
 
     def __init__(self, msg: str, request: httpx.Request, response: httpx.Response):
-        """Initialize with an error message, request, and response objects."""
         super().__init__(msg)
         self.request = request
         self.response = response
@@ -26,7 +25,6 @@ class MaxAttemptsExceededError(Exception):
     """Raised when the maximum number of attempts is exceeded."""
 
     def __init__(self, msg: str, max_attempts: int, errors: List[BaseException] = None):
-        """Initialize with an error message, max attempts, and optional errors."""
         super().__init__(msg)
         self.max_attempts = max_attempts
         self.errors = errors
@@ -36,7 +34,6 @@ class MaxRequestAttemptsExceededError(MaxAttemptsExceededError):
     """Raised when all HTTP request attempts fail."""
 
     def __init__(self, method: str, url: str, max_attempts: int, errors: List[Union[httpx.HTTPError, ResponseError]]):
-        """Initialize with request method, URL, max attempts, and error list."""
         msg = f"All {max_attempts} attempts for {method} request to '{url}' have failed"
         super().__init__(msg, max_attempts, errors)
         self.method = method

yad2_scraper/next_data.py

@@ -27,6 +27,7 @@ class SafeAccessOptionalKeysMeta(type):
 
 
 class Field(str, Enum):
+    """Enum representing different field types for data."""
     ID = "id"
     TEXT = "text"
     ENGLISH_TEXT = "textEng"

yad2_scraper/query.py

@@ -6,6 +6,7 @@ NumberRange = Tuple[int, int]
 
 
 class OrderBy(int, Enum):
+    """Enum representing different order options for sorting."""
     DATE = 1
     PRICE_LOWEST_TO_HIGHEST = 3
     PRICE_HIGHEST_TO_LOWEST = 4

yad2_scraper/vehicles/category.py

@@ -6,8 +6,10 @@ from yad2_scraper.vehicles.next_data import VehiclesNextData
 
 
 class Yad2VehiclesCategory(Yad2Category):
-    def get_vehicle_tags(self) -> List[VehicleTag]:
-        """Retrieve a and return list of vehicle tags from the current category."""
+    """Represents a Yad2 vehicles category parsed from an HTML page."""
+
+    def get_tags(self) -> List[VehicleTag]:
+        """Retrieve and return a list of tags from the current vehicle page."""
         tags = self.find_all_tags_by_class_substring("div", "feedItemBox")
         return [VehicleTag(tag) for tag in tags]
 

yad2_scraper/vehicles/next_data.py

@@ -14,7 +14,7 @@ from yad2_scraper.vehicles.urls import VEHICLES_URL
 
 
 class VehicleData(metaclass=SafeAccessOptionalKeysMeta):
-    """Represents structured Next.js data of a specific vehicle category."""
+    """Represents the data for a single vehicle."""
 
     def __init__(self, data: dict):
         self.data = data
@@ -305,7 +305,12 @@ class VehicleData(metaclass=SafeAccessOptionalKeysMeta):
 
 
 class VehiclesNextData(NextData):
-    def iterate_vehicles(self) -> Iterator[VehicleData]:
+    """Represents structured Next.js data of a specific vehicle category."""
+
+    def get_data(self) -> List[VehicleData]:
+        """Extract and return a list of vehicle-data objects from the stored queries."""
+        data_list = []
+
         for query in self.queries:
             data = query["state"].get("data")
 
@@ -314,7 +319,6 @@ class VehiclesNextData(NextData):
 
             for vehicle_data in itertools.chain.from_iterable(data.values()):
                 if isinstance(vehicle_data, dict):
-                    yield VehicleData(vehicle_data)
+                    data_list.append(VehicleData(vehicle_data))
 
-    def __getitem__(self, item):
-        return self.data[item]
+        return data_list

yad2_scraper/vehicles/query.py

@@ -5,6 +5,7 @@ from yad2_scraper.query import QueryFilters, OrderBy, NumberRange, format_number
 
 
 class OrderVehiclesBy(int, Enum):
+    """Enum representing different order options for sorting vehicles."""
     DATE = OrderBy.DATE
     PRICE_LOWEST_TO_HIGHEST = OrderBy.PRICE_LOWEST_TO_HIGHEST
     PRICE_HIGHEST_TO_LOWEST = OrderBy.PRICE_HIGHEST_TO_LOWEST

{yad2_scraper-0.5.1.dist-info → yad2_scraper-0.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: yad2-scraper
-Version: 0.5.1
+Version: 0.5.3
 Summary: Scrape Yad2 in Python.
 License: LICENSE
 Author: dav ost
@@ -59,9 +59,9 @@ To fetch any category, use the `fetch_category` function:
 from yad2_scraper import fetch_category, Yad2Category
 
 # Fetch real estate category (returns a generic Yad2Category object)
-real_estate_category_page1 = fetch_category("https://www.yad2.co.il/realestate/forsale", page=1)
+real_estate_page1 = fetch_category("https://www.yad2.co.il/realestate/forsale", page=1)
 ...
-real_estate_category_page2 = fetch_category("https://www.yad2.co.il/realestate/forsale", page=2)
+real_estate_page2 = fetch_category("https://www.yad2.co.il/realestate/forsale", page=2)
 ...
 ```
 
@@ -75,21 +75,21 @@ from yad2_scraper import fetch_vehicle_category, OrderVehiclesBy, Field
 # Fetch cars category
 cars_category = fetch_vehicle_category("cars")
 
-for car_data in cars_category.load_next_data().iterate_vehicles():
+for car_data in cars_category.load_next_data().get_data():
     print(car_data.model(Field.ENGLISH_TEXT))
     print(car_data.test_date)
     print(car_data.price)
     ...
 
 # Fetch motorcycles category
-motorcycle_categories = fetch_vehicle_category(
+motorcycle_category = fetch_vehicle_category(
     "motorcycles",
     price_range=(5000, 15000),
     year_range=(2010, 2020),
     order_by=OrderVehiclesBy.PRICE_LOWEST_TO_HIGHEST
 )
 
-for motorcycle_tag in motorcycle_categories.get_vehicle_tags():
+for motorcycle_tag in motorcycle_category.get_tags():
     print(motorcycle_tag.page_link)
     print(motorcycle_tag.hand)
     print(motorcycle_tag.price)
@@ -129,22 +129,23 @@ from yad2_scraper.vehicles import (
     get_vehicle_category_url
 )
 
-# Fetch businesses for sale category with filters
-scraper = Yad2Scraper()
+scraper = Yad2Scraper(request_defaults={"timeout": 5}, max_request_attempts=3)
+
+# Fetch businesses-for-sale category with filters
 url = "https://www.yad2.co.il/products/businesses-for-sale"
 query_filters = QueryFilters(price_range=(10000, 250000), order_by=OrderBy.PRICE_LOWEST_TO_HIGHEST)
-real_estate_category = scraper.fetch_category(url, Yad2Category, params=query_filters)
+businesses_for_sale_category = scraper.fetch_category(url, Yad2Category, params=query_filters)
 
-# Fetch watercraft (vehicle) category with filters
+# Fetch watercraft category with filters
 url = get_vehicle_category_url("watercraft")
 query_filters = VehiclesQueryFilters(year_range=(2010, 2020), order_by=OrderVehiclesBy.DATE)
 watercraft_category = scraper.fetch_category(url, Yad2VehiclesCategory, params=query_filters)
 ```
 
-#### Attributes & Methods
+#### Features & Functionality
 
-The `Yad2Scraper` object contains a lot of additional attributes & methods which you can use.
-Please check out the actual code documentation for more details.
+The `Yad2Scraper` class provides various attributes and methods to customize and extend its functionality.
+For detailed usage and examples, refer to the code documentation.
 
 ## Contributing
 

yad2_scraper-0.5.3.dist-info/RECORD

@@ -0,0 +1,18 @@
+yad2_scraper/__init__.py,sha256=oLANQo7jrtR5ex1tv4sM5ppaW9JpHS70Knsp0ZgVzm0,3708
+yad2_scraper/category.py,sha256=SQ2eg0-fQ9hEaNryYpWVFaJqCx1d65t2_E_S3qpuw9g,1230
+yad2_scraper/constants.py,sha256=8zXJ31fRqkDIOJp96BRK1PJofGXX8SG64YcfmJnVW8Q,910
+yad2_scraper/exceptions.py,sha256=CC7LUy5hMQRTI48UqLZBvYJAYkVZD6n05HXeGWAIO5w,1283
+yad2_scraper/next_data.py,sha256=k8Hkd_fMaAvVWHC6cizuv2osi9c_pJoKjo6mKqfJNEY,2037
+yad2_scraper/query.py,sha256=6-Xc2qvHYLbejEUij85xWB4mHX3MF1XxPup9oUIkU3w,1503
+yad2_scraper/scraper.py,sha256=VA-P24Gvn1y5Pkn_n3hDdpVl1aeEnLoC82eBYteAbWQ,11816
+yad2_scraper/utils.py,sha256=UDpFKel_TJa0dJv1FV-CVqA8-uaFo_hDcooiFAkSZI8,1578
+yad2_scraper/vehicles/__init__.py,sha256=dxjZcNv3ExnN3fKW-m1oqKiX9YC7gj8lqpIa3uWo9iI,242
+yad2_scraper/vehicles/category.py,sha256=_INkTv2Svpj3zytOMANFoBAmTvzfkhdOUm0bs6HrrWI,805
+yad2_scraper/vehicles/next_data.py,sha256=QHAa8AMz7NJ9r0tDVMZ0iLhhIxM2qWgnkV07t5RYjSQ,9330
+yad2_scraper/vehicles/query.py,sha256=N0kA1Ci_MexPXfNpa9EUkXf8XLYOr6np9jMMMpVOlaM,986
+yad2_scraper/vehicles/tag.py,sha256=Wj7v2c8IPQLYHVkfzP1UiulKKJE4yLqnbeh81nvWZhU,2052
+yad2_scraper/vehicles/urls.py,sha256=zxipWjm0SXn2gGOBWw9VqKAJ59mhIGpzd_fTYitpW8c,715
+yad2_scraper-0.5.3.dist-info/LICENSE,sha256=JCpnDxMx2kE40e0UQ1svSmifrLWg2Gni5VTkJR68thY,1065
+yad2_scraper-0.5.3.dist-info/METADATA,sha256=X6MaY2hRMU-DO5F-bGmJUoBWOZ7doYgHdfR0_ZjnzFU,5259
+yad2_scraper-0.5.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+yad2_scraper-0.5.3.dist-info/RECORD,,

{yad2_scraper-0.5.1.dist-info → yad2_scraper-0.5.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.0
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any

yad2_scraper-0.5.1.dist-info/RECORD

@@ -1,18 +0,0 @@
-yad2_scraper/__init__.py,sha256=oLANQo7jrtR5ex1tv4sM5ppaW9JpHS70Knsp0ZgVzm0,3708
-yad2_scraper/category.py,sha256=SQ2eg0-fQ9hEaNryYpWVFaJqCx1d65t2_E_S3qpuw9g,1230
-yad2_scraper/constants.py,sha256=8zXJ31fRqkDIOJp96BRK1PJofGXX8SG64YcfmJnVW8Q,910
-yad2_scraper/exceptions.py,sha256=5yentEUBuEGItwRcjtZY89A19rvFErcTy4S4GUtY_WY,1526
-yad2_scraper/next_data.py,sha256=OcZ7ingXSd6sLNkqQPz6NVTeEDbMkOai9QONFErc3FI,1977
-yad2_scraper/query.py,sha256=HPBoLE6xFjsmvBFR2ULvPq96XXl-2zOqXt7LnHgetIk,1438
-yad2_scraper/scraper.py,sha256=VA-P24Gvn1y5Pkn_n3hDdpVl1aeEnLoC82eBYteAbWQ,11816
-yad2_scraper/utils.py,sha256=UDpFKel_TJa0dJv1FV-CVqA8-uaFo_hDcooiFAkSZI8,1578
-yad2_scraper/vehicles/__init__.py,sha256=dxjZcNv3ExnN3fKW-m1oqKiX9YC7gj8lqpIa3uWo9iI,242
-yad2_scraper/vehicles/category.py,sha256=HdUGCVpC1jw2V-2XvyAC4pPlVQR6cwHyVKDxS3pfQhc,744
-yad2_scraper/vehicles/next_data.py,sha256=lEIWcTP7BOFDC3lL0FhBGp6u-7hsgGdbbrH0iw0Ux20,9203
-yad2_scraper/vehicles/query.py,sha256=ieIJSGJELcgzqtJh6bQXalvDg743LnI2RYrAyHDIH80,912
-yad2_scraper/vehicles/tag.py,sha256=Wj7v2c8IPQLYHVkfzP1UiulKKJE4yLqnbeh81nvWZhU,2052
-yad2_scraper/vehicles/urls.py,sha256=zxipWjm0SXn2gGOBWw9VqKAJ59mhIGpzd_fTYitpW8c,715
-yad2_scraper-0.5.1.dist-info/LICENSE,sha256=JCpnDxMx2kE40e0UQ1svSmifrLWg2Gni5VTkJR68thY,1065
-yad2_scraper-0.5.1.dist-info/METADATA,sha256=SLeA6BPi1idJ20WWWbl7AW-hC_u1_vKPRmUTg4_VhVI,5225
-yad2_scraper-0.5.1.dist-info/WHEEL,sha256=7dDg4QLnNKTvwIDR9Ac8jJaAmBC_owJrckbC0jjThyA,88
-yad2_scraper-0.5.1.dist-info/RECORD,,