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

Renaming Database3 to Database, but creating API stubs #1674

Closed
wants to merge 3 commits into from

Conversation

john-science
Copy link
Member

What is the change?

This PR nominally renames Database3 to Database. But, since that is a big API-breaking change, this PR also creates API stubs for database3.py to fully support the old name.

Why is the change being made?

Database3 was only ever meant to be a placeholder name, while ARMI made the switch from the old Database class to the new one. The name was supposed to be fixed ~6 years ago.


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@john-science john-science added architecture Issues related to big picture system architecture cleanup Code/comment cleanup: Low Priority labels Mar 29, 2024
@john-science
Copy link
Member Author

Testing in all the downstream projects I can find, this is a pretty seamless change.

Since I preserved Database3 in the API, nearly everything works perfectly.

I only found one place where someone was doing a mock of Database3 directly in a unit test in a place where Database would be the new default. So, that one, ultra-specific unit test will need a one-line update.

@john-science
Copy link
Member Author

This was about #1673

@john-science
Copy link
Member Author

Too much time has passed, I will try to get to this PR again in August/September.

I still think this is a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture Issues related to big picture system architecture cleanup Code/comment cleanup: Low Priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant