MIGRATION

Migration notes

Migration and deprecation notes for unihan-etl are here, see {ref}history as well.

1. 📌 For safety, **always** pin the package
2. 📖 Check the migration notes _(You are here)_
3. 📣 If you feel something got deprecated and it interrupted you - past, present, or future - voice your opinion on the [tracker].

   We want to make unihan-etl fun, reliable, and useful for users.

   API changes can be painful.

   If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here!

   (Please pin the package. 🙏)

   [tracker]: https://github.com/cihai/unihan-etl/discussions

Next release

Notes on the upcoming release will be added here

unihan-etl 0.22.0 (2023-06-17)

Move unihan_etl.process to unihan_etl.core (#284)

Before 0.22.0:

from unihan_etl.process import Packager

From 0.22.0+:

>>> from unihan_etl.core import Packager

Options is now a dataclass object (#280)

A typed, autocomplete-friendly :obj:dataclasses.dataclass object is now used for the unihan_etl options object.

Before 0.22.0:

from unihan_etl.process import Packager

packager = Packager({
    'fields': ['kDefinition']
})

From 0.22.0+ (also note above):

>>> from unihan_etl.core import Packager
>>> from unihan_etl.options import Options
>>> packager = Packager(Options(
...     fields=['kDefinition']
... ))