Skip to content

Use JsonSerializable for user_data #1193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Pijukatel wants to merge 2 commits into from
Closed

Use JsonSerializable for user_data #1193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dad6ecf
Use `JsonSerializable` for `user_data`
Pijukatel May 7, 2025
5eab9d8
Keep the top dict
Pijukatel May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/crawlee/_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ def __call__(
*,
selector: str | None = None,
label: str | None = None,
user_data: dict[str, Any] | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction] | None = None,
**kwargs: Unpack[EnqueueLinksKwargs],
) -> Coroutine[None, None, None]: ...
Expand All @@ -361,7 +361,7 @@ def __call__(
*,
selector: str | None = None,
label: str | None = None,
user_data: dict[str, Any] | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction] | None = None,
requests: Sequence[str | Request] | None = None,
**kwargs: Unpack[EnqueueLinksKwargs],
Expand Down Expand Up @@ -398,7 +398,7 @@ def __call__(
*,
selector: str = 'a',
label: str | None = None,
user_data: dict[str, Any] | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction] | None = None,
**kwargs: Unpack[EnqueueLinksKwargs],
) -> Coroutine[None, None, list[Request]]:
Expand Down
16 changes: 11 additions & 5 deletions src/crawlee/crawlers/_abstract_http/_abstract_http_crawler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import asyncio
import logging
from abc import ABC
from typing import TYPE_CHECKING, Any, Callable, Generic, Union
from typing import TYPE_CHECKING, Callable, Generic, Union

from pydantic import ValidationError
from typing_extensions import TypeVar
Expand All @@ -23,7 +23,13 @@
from typing_extensions import Unpack

from crawlee import RequestTransformAction
from crawlee._types import BasicCrawlingContext, EnqueueLinksFunction, EnqueueLinksKwargs, ExtractLinksFunction
from crawlee._types import (
BasicCrawlingContext,
EnqueueLinksFunction,
EnqueueLinksKwargs,
ExtractLinksFunction,
JsonSerializable,
)

from ._abstract_http_parser import AbstractHttpParser

Expand Down Expand Up @@ -150,7 +156,7 @@ async def extract_links(
*,
selector: str = 'a',
label: str | None = None,
user_data: dict[str, Any] | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction]
| None = None,
**kwargs: Unpack[EnqueueLinksKwargs],
Expand All @@ -173,7 +179,7 @@ async def extract_links(
skipped.append(url)
continue

request_options = RequestOptions(url=url, user_data={**base_user_data}, label=label)
request_options = RequestOptions(url=url, user_data=base_user_data, label=label)

if transform_request_function:
transform_request_options = transform_request_function(request_options)
Expand Down Expand Up @@ -220,7 +226,7 @@ async def enqueue_links(
*,
selector: str | None = None,
label: str | None = None,
user_data: dict[str, Any] | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction]
| None = None,
requests: Sequence[str | Request] | None = None,
Expand Down
14 changes: 10 additions & 4 deletions src/crawlee/crawlers/_playwright/_playwright_crawler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@
from typing_extensions import Unpack

from crawlee import RequestTransformAction
from crawlee._types import BasicCrawlingContext, EnqueueLinksFunction, EnqueueLinksKwargs, ExtractLinksFunction
from crawlee._types import (
BasicCrawlingContext,
EnqueueLinksFunction,
EnqueueLinksKwargs,
ExtractLinksFunction,
JsonSerializable,
)
from crawlee.browsers._types import BrowserType


Expand Down Expand Up @@ -281,7 +287,7 @@ async def extract_links(
*,
selector: str = 'a',
label: str | None = None,
user_data: dict | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction]
| None = None,
**kwargs: Unpack[EnqueueLinksKwargs],
Expand Down Expand Up @@ -314,7 +320,7 @@ async def extract_links(
skipped.append(url)
continue

request_option = RequestOptions({'url': url, 'user_data': {**base_user_data}, 'label': label})
request_option = RequestOptions({'url': url, 'user_data': base_user_data, 'label': label})

if transform_request_function:
transform_request_option = transform_request_function(request_option)
Expand Down Expand Up @@ -352,7 +358,7 @@ async def enqueue_links(
*,
selector: str | None = None,
label: str | None = None,
user_data: dict | None = None,
user_data: dict[str, JsonSerializable] | None = None,
transform_request_function: Callable[[RequestOptions], RequestOptions | RequestTransformAction]
| None = None,
requests: Sequence[str | Request] | None = None,
Expand Down
Loading