docs: Upgrade upgrading guide #278
Open
+13
−9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
janbuchar
added
adhoc
janbuchar
commented
Sep 18, 2024
| @@ -28,6 +31,7 @@ Attributes suffixed with `_millis` were renamed to remove said suffix and have t | |||
| - `Actor.start`, `Actor.call`, `Actor.start_task`, `Actor.set_status_message` and `Actor.abort` return instances of the `ActorRun` model instead of an untyped `dict`. | |||
| - Upon entering the context manager (`async with Actor`), the `Actor` puts the default logging configuration in place. This can be disabled using the `configure_logging` parameter. | |||
| - The `config` parameter of `Actor` has been renamed to `configuration`. | |||
| - Event handlers registered via `Actor.on` will now receive Pydantic objects instead of untyped dicts. For example, where you would do `event['isMigrating']`, you should now use `event.is_migrating` | |||
There was a problem hiding this comment.
This is intentionally vague - maybe we should expose the event models somehow so that we can link them from here. Currently, they are internal members of Crawlee.
vdusek
approved these changes
Sep 18, 2024
| - The SDK now uses [crawlee](https://github.com/apify/crawlee-python) for local storage emulation. This change should not affect intended usage (working with `Dataset`, `KeyValueStore` and `RequestQueue` classes from the `apify.storages` module or using the shortcuts exposed by the `Actor` class) in any way. | ||
| - There is a difference in the `RequestQueue.add_request` method: it accepts an `apify.Request` object instead of a free-form dictionary. | ||
| - A quick way to migrate from dict-based arguments is to wrap it with a `Request.model_validate()` call. | ||
| - The preferred way is to instantiate it directly, e.g., `Request(url='https://example.tld', ...)`, or using the `Request.from_url` helper which prefills the `unique_key` and `id` attributes. |
There was a problem hiding this comment.
I think we should mention the from_url as a preferred way of creating new Requests. The need for instantiating it directly should be quite rare.
|
|
||
| Removing the `StorageClientManager` class is a significant change. If you need to change the storage client, use `crawlee.service_container` instead. | ||
| - The SDK now uses [crawlee](https://github.com/apify/crawlee-python) for local storage emulation. This change should not affect intended usage (working with `Dataset`, `KeyValueStore` and `RequestQueue` classes from the `apify.storages` module or using the shortcuts exposed by the `Actor` class) in any way. | ||
| - There is a difference in the `RequestQueue.add_request` method: it accepts an `apify.Request` object instead of a free-form dictionary. |
There was a problem hiding this comment.
Is it only RQ.add_request? Do no more methods work with requests? We should also mention that users can provide just a URL as a string or apify.Request object.
There was a problem hiding this comment.
Do the bullets below this one not satisfy this need?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.