Skip to content

feat: deprecate get_storage_class in core/storage.py #36910

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Jun 13, 2025

Description

Fixes: #36739

The main goal is to modify the get_storage_class function referenced here in order to deprecate it.
However, a few special changes have been made, as described below:

  • In this file, get_storage_class was replaced by the generic resolve_storage function.
  • A similar update was made here.

Why does the get_storage_class function still exist with a new implementation that uses import_string?
This change is related to the DjangoStorageReportStore class and its parent implementation. Specifically, here, a dynamic logic is used to define the storage backend.

Given the complexity of that logic, I recommend creating a separate ticket to refactor this part of the code.

Lastly, the resolve_storage_backend function was updated to support a legacy_sec_setting_keys parameter. This allows it to handle storage settings defined as nested dictionaries. For example:

settings.VERIFY_STUDENT = {
    "STORAGE_CLASS": "storage.path.class"
}

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 13, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jun 13, 2025

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 13, 2025
@dwong2708 dwong2708 force-pushed the django5-storage-36739 branch 2 times, most recently from 52e93e7 to bed450a Compare June 13, 2025 22:21
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jun 16, 2025
@dwong2708 dwong2708 force-pushed the django5-storage-36739 branch 6 times, most recently from 3033d45 to 085e01a Compare June 18, 2025 15:30
@dwong2708 dwong2708 marked this pull request as ready for review June 18, 2025 15:31
@dwong2708 dwong2708 force-pushed the django5-storage-36739 branch 2 times, most recently from 2607ef4 to 6197b2d Compare June 20, 2025 15:40
@dwong2708 dwong2708 requested review from awais786 and feanil June 20, 2025 16:37
@dwong2708 dwong2708 force-pushed the django5-storage-36739 branch from 6197b2d to f6a4a32 Compare June 20, 2025 18:56
@dwong2708 dwong2708 force-pushed the django5-storage-36739 branch from f6a4a32 to d0a3e95 Compare June 20, 2025 19:37
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

RemovedInDjango51Warning for get_storage_class in openedx/core/storage.py
3 participants