Platform: Add type annotations for primary key types by model [FC-0117]

[bradenmacdonald]

Description

This is the openedx-platform PR related to openedx/openedx-core#534 .

Basically, this new feature in openedx-core lets us use fully-typed primary keys instead of plain int types:

- def get_staged_content_olx(staged_content_id: int) -> str | None:
+ def get_staged_content_olx(staged_content_id: StagedContentID) -> str | None:

This provides a higher level of clarity, documentation, and automated validation.

e.g.

error: Argument 1 to "get_staged_content_olx" has incompatible type "str"; expected "StagedContentID"  [arg-type]

Supporting information

This PR includes some minor drive-by typing fixes, to enable mypy to check a couple more files that it wasn't previously checking.

Testing instructions

This should not have any runtime effects. (Although technically, changing .pk to .id is a runtime change.)

Deadline

Verawood

[openedx-webhooks]

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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.

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.

[bradenmacdonald]

Note (possibly relevant to OEP-68 recommendations): due to how this module is structured and imported (with the StagedContent model not being part of the API in any way), it was necessary to put the StagedContentID type in data.py. Which makes sense anyways.

[kdmccormick]

It does make sense. I think it'd be a good convention.