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.

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

🔧 MAINTAIN: Add core. to aiida-core entry points #401

Open
mbercx opened this issue Aug 16, 2021 · 2 comments
Open

🔧 MAINTAIN: Add core. to aiida-core entry points #401

mbercx opened this issue Aug 16, 2021 · 2 comments
Assignees
Labels
priority/on-hold Issue is on hold until a specified event section/all Applies to all sections type/maintain

Comments

@mbercx
Copy link
Member

mbercx commented Aug 16, 2021

In aiidateam/aiida-core#5073, the entry points of plugins that ship with aiida-core are prefixed with core.. Once this change has been released, the tutorial material must be updated to reflect this backwards incompatible change.

@mbercx mbercx added section/all Applies to all sections type/maintain priority/on-hold Issue is on hold until a specified event labels Aug 16, 2021
@mbercx mbercx self-assigned this Aug 16, 2021
@sphuber
Copy link
Contributor

sphuber commented Aug 25, 2021

Just a small point of nuance: the change is backwards compatible, but the old entry points are deprecated and will no longer work after some time

@sphuber
Copy link
Contributor

sphuber commented Aug 30, 2021

Note that during the discussion of the changes in the entry point names, another point came to discussion. For a long time, we have been recommending new users to use the factories to load plugins, including basic data plugins that ship with aiida-core. The main idea behind this decision was that this would protect users from import errors if the resources would be moved. However, using the factories also has downsides, for example it makes the life of static analysis tools more difficult as they cannot introspect the resources loaded by the factories. Therefore it might be better to recommend to use the direct import method for certain classes. Especially for the base data plugins of aiida-core, e.g., Float, Str etc., it may be better to simply recommend to use from aiida.orm import Float.

If we decide to change this, we should address this in all the tutorials and documentation. However, we should make sure that the factories are still properly explained and say that sometimes they are fine to be used, especially for the entry points of external plugin packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/on-hold Issue is on hold until a specified event section/all Applies to all sections type/maintain
Projects
None yet
Development

No branches or pull requests

2 participants