Skip to content
New: Star-import, signal unraveling, Python 3.12 support, and more

#
updater module

Classes for scheduling data updates.

## DataUpdater class

    DataUpdater(
        data,
        schedule_manager=None,
        update_kwargs=None,
        **kwargs
    )

Base class for scheduling data updates.

Args

`data` :`Data`
  Data instance.
`update_kwargs` :`dict`
  Default keyword arguments for `DataSaver.update`.
`**kwargs`
  Keyword arguments passed to the constructor of `Configured`.

Superclasses

- Cacheable
- Chainable
- Comparable
- Configured
- HasSettings
- Pickleable
- Prettified

Inherited members

- Cacheable.get_ca_setup()
- Chainable.pipe()
- Configured.config
- Configured.copy()
- Configured.equals()
- Configured.get_writeable_attrs()
- Configured.prettify()
- Configured.rec_state
- Configured.replace()
- Configured.resolve_merge_kwargs()
- Configured.update_config()
- HasSettings.get_path_setting()
- HasSettings.get_path_settings()
- HasSettings.get_setting()
- HasSettings.get_settings()
- HasSettings.has_path_setting()
- HasSettings.has_path_settings()
- HasSettings.has_setting()
- HasSettings.has_settings()
- HasSettings.reset_settings()
- HasSettings.resolve_setting()
- HasSettings.resolve_settings_paths()
- HasSettings.set_settings()
- Pickleable.decode_config()
- Pickleable.decode_config_node()
- Pickleable.dumps()
- Pickleable.encode_config()
- Pickleable.encode_config_node()
- Pickleable.file_exists()
- Pickleable.getsize()
- Pickleable.load()
- Pickleable.loads()
- Pickleable.modify_state()
- Pickleable.resolve_file_path()
- Pickleable.save()

Subclasses

- DataSaver

### data property

Data instance.

See Data.

### schedule_manager property

Schedule manager instance.

See ScheduleManager.

### update method

    DataUpdater.update(
        **kwargs
    )

Method that updates data.

Override to do pre- and postprocessing.

To stop this method from running again, raise CancelledError.

### update_every method

    DataUpdater.update_every(
        *args,
        to=None,
        tags=None,
        in_background=False,
        replace=True,
        start=True,
        start_kwargs=None,
        **update_kwargs
    )

Schedule DataUpdater.update() as a job.

For `*args`, `to` and `tags`, see ScheduleManager.every().

If `in_background` is set to True, starts in the background as an `asyncio` task. The task can be stopped with ScheduleManager.stop().

If `replace` is True, will delete scheduled jobs with the same tags, or all jobs if tags are omitted.

If `start` is False, will add the job to the scheduler without starting.

`**update_kwargs` are merged over DataUpdater.update_kwargs and passed to DataUpdater.update().

### update_kwargs property

Keyword arguments passed to `DataSaver.update`.

#### Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

- Google Analytics
- GitHub

Manage settings