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

Separate public / private interface. #43

Merged
merged 1 commit into from
Jun 15, 2020

Conversation

greschd
Copy link
Member

@greschd greschd commented Jun 14, 2020

Fixes #41, fixes #42

Separate the public / private interface and rename as discussed in #41

As discussed in #42, the duplicated code from CpInputFile and PwInputFile has been moved into the common base, which was renamed and made private.

The constants are now given as a SimpleNamespace, instead of defined at the top-level of their module. The reason for this is that we want to be compatible with adding version-specific constants later on. This could now be done by adding a get_constants function that takes the QE version as input, and returns the SimpleNamespace of corresponding constants.

#25 is also related, but not completely fixed

Next steps:

TODO for 2.0 release proper:

Separate the public and private interface, as detailed in
issues aiidateam#41,42,25.
The duplicated code from CpInputFile and PwInputFile has been
moved into the common base, which was renamed and made private.
The constants are now given as a SimpleNamespace, instead of
defined at the top-level of their module. The reason for this is
that we want to be compatible with adding version-specific
constants later on. This could now be done by adding a
'get_constants' function that takes the QE version as input,
and returns the SimpleNamespace of corresponding constants.
@greschd greschd marked this pull request as draft June 14, 2020 19:35
Copy link
Member

@giovannipizzi giovannipizzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@giovannipizzi
Copy link
Member

Of course I'm happy to re-review if you want to address the remaining points before

@greschd greschd marked this pull request as ready for review June 15, 2020 13:28
@greschd greschd merged commit aedee19 into aiidateam:develop Jun 15, 2020
@greschd
Copy link
Member Author

greschd commented Jun 15, 2020

Of course I'm happy to re-review if you want to address the remaining points before

Nah, I've made separate issues for that.

@greschd greschd deleted the update_public_private_separation branch June 15, 2020 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Structure of Qe/Pw/CpInputFile Clearly define public vs. private interface
2 participants