wehub-resource-sync
90 lines
3.8 KiB
Markdown
90 lines
3.8 KiB
Markdown
---
|
|
title: Migrating from 0.28 to 0.29
|
|
order: 981
|
|
---
|
|
|
|
<!-- ^^^ this number must be _decremented_ when you copy/paste this file -->
|
|
|
|
## 🐍 Python API
|
|
### New API for defining visualizer overrides
|
|
|
|
The Python API for setting blueprint overrides now uses special visualizer objects under the hood.
|
|
A sideffect of that is that `VisualizerOverrides` no longer exists, instead you just list the visualizers out:
|
|
|
|
|
|
Before:
|
|
```py
|
|
rr.send_blueprint(
|
|
rrb.TimeSeriesView(
|
|
overrides={
|
|
"trig/sin": [
|
|
rrb.VisualizerOverrides([rrb.visualizers.SeriesLines, rrb.visualizers.SeriesPoints]),
|
|
],
|
|
},
|
|
)
|
|
)
|
|
```
|
|
After:
|
|
```py
|
|
rr.send_blueprint(rrb.TimeSeriesView(overrides={"trig/sin": [rr.SeriesLines(), rr.SeriesPoints()]}))
|
|
```
|
|
|
|
In general, you can now pass any archetype that has a corresponding visualizer.
|
|
Internally, passing such a `VisualizableArchetype` is a shorthand for calling `.visualizer()` on the object.
|
|
|
|
### `Entry.update()` is deprecated in favor of `Entry.set_name()`
|
|
|
|
The `Entry.update()` method has been deprecated. Use `Entry.set_name()` instead for renaming entries.
|
|
|
|
```python
|
|
# Before (deprecated)
|
|
entry.update(name="new_name")
|
|
|
|
# After
|
|
entry.set_name("new_name")
|
|
```
|
|
|
|
The deprecated method will emit a `DeprecationWarning` and will be removed in a future release.
|
|
|
|
### `CatalogClient`: Renamed `addr` constructor parameter
|
|
The first argument to `CatalogClient` is now called `url`.
|
|
The other arguments (including `token`) are now kw-args.
|
|
|
|
### `Server`: Renamed `addr` constructor parameter
|
|
The first argument to `Server` is now called `host`.
|
|
|
|
### Deprecated `rerun.dataframe` API has been removed
|
|
|
|
The `rerun.dataframe` module and its associated APIs, which were deprecated in 0.28, have now been fully removed. This includes `RecordingView`, `Recording.view()`, and the ability to run dataframe queries locally via this module.
|
|
|
|
Please refer to the [0.28 migration guide section on `RecordingView` and local dataframe API](migration-0-28.md#recordingview-and-local-dataframe-api-deprecated) for details on updating your code to use `rerun.server.Server` and the `rerun.catalog` API instead.
|
|
|
|
### Deprecated `rerun.catalog` APIs have been removed
|
|
|
|
The deprecated `rerun.catalog` APIs that were marked for removal in 0.28 have now been fully removed. If you were using any of these deprecated methods, you must update your code to use the new APIs.
|
|
|
|
Please refer to the [0.28 migration guide section on catalog API overhaul](migration-0-28.md#python-sdk-catalog-api-overhaul) for more details on the new API patterns.
|
|
|
|
### Multiple internal submodules were move to properly mark internal
|
|
Most of their functionality is already exposed indirectly through re-exports.
|
|
If you still need to use any functionality directly you can still find them in their new location.
|
|
* `rr.color_conversion` -> `rr._color_conversion`
|
|
* `rr.event` -> `rr._event`
|
|
* `rr.legacy_notebook` -> `rr._legacy_notebook`
|
|
* `rr.logging_handler` -> `rr._logging_handler`
|
|
* `rr.memory` -> `rr._memory`
|
|
* `rr.script_helpers` -> `rr._script_helpers`
|
|
|
|
## CLI
|
|
`rerun server --addr …` has been renamed `rerun server --host …`
|
|
|
|
## Overrides in blueprint files can't be imported
|
|
|
|
Rerun 0.29 cannot currently load component overrides from `.rbl` files created in previous versions. Support for legacy overrides is coming soon.
|
|
|
|
## Dataset re-registration required to fix missing `name` and `start_time` in segment table
|
|
|
|
This release fixes a bug where the built-in properties ([`RecordingInfo`](../types/archetypes/recording_info.md), including `name` and `start_time`) would not be displayed in the segment table. On catalog server deployments, property extraction happens at registration time. This means that datasets will need to be re-registered for these columns to be populated.
|
|
|
|
The OSS server is not affected because it generates the segment table on the fly.
|