Skip to content
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

Update custom data plugin documentation #5898

Merged
merged 3 commits into from
Feb 22, 2023
Merged

Update custom data plugin documentation #5898

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81d20ec
Update custom data plugin documentation
zhubonan Feb 20, 2023
09a9742
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Feb 20, 2023
3730a50
Update docs/source/topics/data_types.rst
zhubonan Feb 21, 2023
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
2 changes: 2 additions & 0 deletions docs/source/topics/data_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1149,6 +1149,8 @@ Therefore, we have to override the constructor :meth:`~aiida.orm.nodes.node.Node
.. warning::

For the class to function properly, the signature of the constructor **cannot be changed** and the constructor of the parent class **has to be called**.
Note also that the constructor is **NOT** called when the node is loaded from the database afterwards.
Hence, one should not rely on initializing instance attributes inside the ``__init__`` itself (here "attributes" does not refer to the data stored in the database, but the normal Python understanding of attributes that class instances have).

Before calling the constructor of the base class, we have to remove the ``value`` keyword from the keyword arguments ``kwargs``, because the base class will not expect it and will raise an exception if left in the keyword arguments.
The final step is to actually *store* the value that is passed by the caller of the constructor.
Expand Down