Skip to content

docs: document trait declaration deprecation 🤖🍆 (#520) #981

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

Open
frobel0520 wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Open

docs: document trait declaration deprecation 🤖🍆 (#520) #981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions docs/source/migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,27 @@ populate the metadata for a trait type instance is to use the new
We also deprecated the ``get_metadata`` method. The metadata of a trait
type instance can directly be accessed via the ``metadata`` attribute.

Deprecation of trait declarations via classes
----------------------------------------------

Traits should be declared with instances of their trait types. Declaring a
trait with the trait type itself is deprecated:

.. code:: python

from traitlets import HasTraits, Int


class OldStyle(HasTraits):
value = Int # deprecated


class NewStyle(HasTraits):
value = Int() # preferred

This applies to container traits as well. For example, use ``List(Int())``
instead of ``List(Int)``.

Deprecation of ``on_trait_change``
----------------------------------

Expand Down
Loading