Skip to content

refactor: import specific names from openedx_authz.authz - #620

Merged
BryanttV merged 1 commit into
mainfrom
bav/use-authz-imports
Nov 12, 2026
Merged

BryanttV merged 1 commit into
mainfrom
bav/use-authz-imports

Conversation

@BryanttV

@BryanttV BryanttV commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Description

Replaces module-style access (authz.X, permissions.X, roles.X) with explicit imports of only the names each module needs, e.g. from openedx_authz.authz import LIBRARY_ADMIN, VIEW_LIBRARY.

  • Applies to the REST API views/permissions, engine/utils.py and the tests.
  • tests/test_imports.py and tests/authz/test_resources.py are unchanged since they test the authz module itself.
  • from openedx_authz import api imports are left as they are.

Testing instructions

Run the test suite and make quality/ruff check src.

Merge checklist:
Check off if complete or not applicable:

  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 12, 2026
@openedx-webhooks

openedx-webhooks commented Nov 12, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/committers-openedx-authz.

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.

Details
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 Nov 12, 2026
@BryanttV
BryanttV added this pull request to stack #621 November 12, 2026 17:28
@BryanttV
BryanttV marked this pull request as draft November 12, 2026 17:29
@BryanttV
BryanttV force-pushed the bav/use-authz-imports branch from 438df55 to 048865a Compare November 12, 2026 17:32
@BryanttV
BryanttV marked this pull request as ready for review November 12, 2026 17:35
@BryanttV
BryanttV marked this pull request as draft November 12, 2026 18:35
@BryanttV
BryanttV marked this pull request as ready for review November 12, 2026 18:35
Base automatically changed from bav/make-format to main November 12, 2026 19:22
@BryanttV
BryanttV force-pushed the bav/use-authz-imports branch from 048865a to 743070d Compare November 12, 2026 19:22

@rodmgwgu rodmgwgu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this, looks good!

Replace module-style authz.X access with explicit imports of only the
constants each module needs.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@BryanttV
BryanttV force-pushed the bav/use-authz-imports branch from 743070d to 467784b Compare November 12, 2026 22:13
@BryanttV
BryanttV merged commit 0a484fa into main Nov 12, 2026
8 checks passed
@BryanttV
BryanttV deleted the bav/use-authz-imports branch November 12, 2026 22:18
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Migrate internal openedx-authz usages of legacy constants imports to openedx_authz.authz

3 participants