Skip to content

Use platformdirs to improve database path handling #40152

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

Merged
merged 3 commits into from
Jun 1, 2025

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented May 23, 2025

Improve the handling of the data directories by always including the system data dirs, in addition to SAGE_SHARE (and it's variations). Also move the sage_data_paths method to sage.env so that it can be reused more easily.

Should fix #40144.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

src/sage/env.py Outdated

def sage_data_paths(data_name: str) -> set[str]:
r"""
Search paths for database ``data_name``.
Copy link
Contributor

Choose a reason for hiding this comment

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

This can also be used in the future to search for other data files (eg. three.min.js), doesn't seem specific to databases.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, this was a result of simply copy&pasting. Fixed now.

vbraun pushed a commit to vbraun/sage that referenced this pull request May 26, 2025
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Improve the handling of the data directories by always including the
system data dirs, in addition to `SAGE_SHARE` (and it's variations).
Also move the `sage_data_paths` method to `sage.env` so that it can be
reused more easily.

Should fix sagemath#40144.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [ ] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->

URL: sagemath#40152
Reported by: Tobias Diez
Reviewer(s): Antonio Rojas, Tobias Diez
vbraun pushed a commit to vbraun/sage that referenced this pull request May 28, 2025
sagemathgh-40152: Use platformdirs to improve database path handling
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Improve the handling of the data directories by always including the
system data dirs, in addition to `SAGE_SHARE` (and it's variations).
Also move the `sage_data_paths` method to `sage.env` so that it can be
reused more easily.

Should fix sagemath#40144.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [ ] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#40152
Reported by: Tobias Diez
Reviewer(s): Antonio Rojas, Tobias Diez
@vbraun vbraun merged commit b8606ed into sagemath:develop Jun 1, 2025
14 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Meson build on Arch/Void: Missing 'cremona_mini.db'
3 participants