john-bodley opened a new pull request, #24331: URL: https://github.com/apache/superset/pull/24331
<!--- Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/ Example: fix(dashboard): load charts correctly --> ### SUMMARY This PR is the first of many to related to [SIP-92 Proposal for restructuring the Python code base](https://github.com/apache/superset/issues/20630). Specifically it organizes all the DAOs under the `superset/daos` subfolder. A few things of note: 1. The `EmbeddedDAO` was renamed `EmbeddedDashboardDAO` for clarity. 2. The organization is flat from a directory standpoint (akin to @ktmud's suggestion in the SIP) as opposed to tiered. This means that there was consolidation of DAOs by theme: - `AnnotationLayerDAO` is housed `daos/annotation.py` - `EmbeddedDashboardDAO` and `FilterSetDAO` are housed in `daos/dashboard.py` - `SavedQueryDAO` is housed in `daos/query.py` - `SSHTunnelDAO` is housed in `daos/database.py` 3. It wasn't overly clear whether the modules should use [singular or plural](https://softwareengineering.stackexchange.com/a/75929) forms, i.e., `dashboard` or `dashboards`. I opted for the former given that: - They're already housed under `daos` (plural) subfolder. - Even though the `dashboard.py` file contains a collection of DAOs (`DashboardDAO`, `EmbeddedDashboardDAO`) we _tend_ to think of the term "dashboard" as a concept/type rather than multiple types. - It seems prudent to stick with either singular or plural from a consistency standpoint—the one exception is (no pun intended) `exceptions` as this houses different exception types and is consistent with how other files containing exceptions are named. 4. Apart from singularizing the terms the follow renames occurred: - `css_templates/dao.py` became `daos/css.py` - `row_level_security/dao.py` became `daos/security.py` ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF <!--- Skip this if not applicable --> ### TESTING INSTRUCTIONS CI. ### ADDITIONAL INFORMATION <!--- Check any relevant boxes with "x" --> <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue --> - [ ] Has associated issue: - [ ] Required feature flags: - [ ] Changes UI - [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351)) - [ ] Migration is atomic, supports rollback & is backwards-compatible - [ ] Confirm DB migration upgrade and downgrade tested - [ ] Runtime estimates and downtime expectations provided - [ ] Introduces new feature or API - [ ] Removes existing feature or API -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
