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

Change the name Database3 to Database #1673

Open
4 tasks
john-science opened this issue Mar 29, 2024 · 0 comments
Open
4 tasks

Change the name Database3 to Database #1673

john-science opened this issue Mar 29, 2024 · 0 comments
Assignees
Labels
architecture Issues related to big picture system architecture complex Expected to be a complex issue

Comments

@john-science
Copy link
Member

This is a big, complex change that will have to be done in phases.

It is an unfortunate fluke of history that ARMI's database class is called Database3. This was meant to be a temporary name used during a transition.

But, obviously, this is a big, API-breaking change that will cause a ton of (trivial) code changes in ARMI and downstream. So, I would suggest a long, gradual transition:

  • Move database3.py to database.py, but create the stub file below in a new database3.py.
  • Slowly transition all code in ARMI and downstream to use Database (without the "3").
  • Eventually, add a DeprecationWarning in Database3.py
  • Finally, eventually, remove Database3 from ARMI.

Suggested stub file to ease our transition:

# database3.py
from armi.bookkeeping.db.database import *

class Database3(Database):
    pass
@john-science john-science added architecture Issues related to big picture system architecture complex Expected to be a complex issue labels Mar 29, 2024
@john-science john-science self-assigned this Mar 29, 2024
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 complex Expected to be a complex issue
Projects
None yet
Development

No branches or pull requests

1 participant