[BryanttV]

Description

Re-exports the constants of the enrollments, learner_administration, and learner_grading applets from openedx_authz.authz, alongside the applets already exported there (content libraries, course authoring, and course team roles).

After #550 moved the built-in definitions into applets, these three applets were missing from the public openedx_authz.authz namespace and __all__. This makes every applet's constants importable from a single place.

Changes

• src/openedx_authz/authz/__init__.py: import and add to __all__ the constants of enrollments, learner_administration and learner_grading.

Testing instructions

from openedx_authz import authz
# Constants from the three applets are now available, e.g.:
import openedx_authz.applets.enrollments.constants as c
assert all(hasattr(authz, name) for name in c.__all__)

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]

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[rodmgwgu]

This looks good, however I have a question:

My impression of the applets idea is that going forward, users of these constants should explicitly import from the applets, so it's clear what belongs where and it's easier to refactor in the future when those applets are exported out of authz.

This meant that keeping these constants under authz was a retrocompatibility meassure, not a practice to keep going forward.

Now, it does feel cleaner to still keep this exports in sync.

I don't have a strong opinion on that, but wanted to raise this discussion.

What do you think?

[BryanttV]

Thanks for raising this, @rodmgwgu. I checked what the repo says today, and it isn't consistent:

• ADR 0032 (line 185) and the READMEs of content_libraries, course_authoring and course_team_roles say clients import the constants from openedx_authz.authz, with openedx_authz.constants.* kept as compatibility exports.
• ADR 0032 (line 25) and the READMEs of the three applets in this PR say the stable path is openedx_authz.constants.*.

So I don't think we can say yet that authz is only a retrocompatibility layer. For now, I'd keep the exports in sync, because three applets importable from authz and three not is the more confusing state. To keep one convention, I'd update the three applet READMEs in this PR so they match the others (openedx_authz.authz for clients, constants as compatibility).

What do you think? FYI @mariajgrimaldi

[rodmgwgu]

Thanks for raising this, @rodmgwgu. I checked what the repo says today, and it isn't consistent:

• ADR 0032 (line 185) and the READMEs of content_libraries, course_authoring and course_team_roles say clients import the constants from openedx_authz.authz, with openedx_authz.constants.* kept as compatibility exports.
• ADR 0032 (line 25) and the READMEs of the three applets in this PR say the stable path is openedx_authz.constants.*.

So I don't think we can say yet that authz is only a retrocompatibility layer. For now, I'd keep the exports in sync, because three applets importable from authz and three not is the more confusing state. To keep one convention, I'd update the three applet READMEs in this PR so they match the others (openedx_authz.authz for clients, constants as compatibility).

What do you think? FYI @mariajgrimaldi

Thanks for clarifying this, in that case, I'm ok with these changes. Thanks!

[mariajgrimaldi]

Adding to Bryann's comment, the ADR 0032 addendum replaces the import paths described earlier in the ADR (line 25 included), so openedx_authz.authz is the public API for the constants and openedx_authz.constants.* is the compatibility layer. The applets stay internal on purpose, since importing from them directly would tie clients to the internal layout and break those imports when an applet moves out of openedx-authz. +1 to keeping the exports in sync and updating the three READMEs here, thanks!