Skip to content
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

Wraps the CyberSource imports in a warnings filter #191

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkachel
Copy link
Contributor

@jkachel jkachel commented Feb 27, 2025

What are the relevant tickets?

Related to https://github.com/mitodl/hq/issues/5951
Related to mitodl/mitxonline#2551

Description (What does it do?)

The CyberSource Python REST client library uses a couple of regexes that aren't in raw strings, and (starting with Python 3.12) doing that raises a SyntaxWarning. (This was deprecated in 3.6 but in between then and 3.12 it raised a DeprecationWarning, which is usually invisible.) Wrapping these in a catch_warnings context manager lets us filter out SyntaxWarning, so we can make it quiet. (pytest also sometimes regards these as errors, which keeps your tests from passing when using Python 3.12+, so this should fix that too.) It would be better for the upstream to be fixed but we can do this until that happens.

How can this be tested?

Automated tests should pass. Running tests using Python 3.12 or 3.13 should work. You can do this with uv run --python 3.13 pytest tests/payment_gateway/**/*.py (or 3.12).

It would be best to build and pull the built version of this into MITx Online and see how that works there with a more recent (>=3.12) version of Python.

This otherwise has no functional changes - it just slightly changes the imports in one file.

…atter from SyntaxWarning issues

The CyberSource Python REST client library uses a couple of regexes that aren't in raw strings, and (starting with Python 3.12) doing that raises a SyntaxWarning. (This was deprecated in 3.6 but in between then and 3.12 it raised a DeprecationWarning, which is usually invisible.) Wrapping these in a `catch_warnings` context manager lets us filter out SyntaxWarning, so we can make it quiet. (pytest also sometimes regards these as _errors_, which keeps your tests from passing when using Python 3.12+, so this should fix that too.) It would be better for the upstream to be fixed but we can do this until that happens.
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @jkachel, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request addresses a SyntaxWarning that arises from the CyberSource Python REST client library when using Python 3.12 or later. The library uses regular expressions that are not raw strings, triggering the warning. To resolve this, I've wrapped the CyberSource imports within a warnings.catch_warnings() context manager, filtering out SyntaxWarning. This prevents the warnings from being treated as errors by pytest and ensures tests pass in Python 3.12+ environments. Additionally, I've updated the uv.lock file to reflect the latest versions of mitol-django-google-sheets and mitol-django-google-sheets-refunds.

Highlights

  • SyntaxWarning Fix: Implements a workaround for SyntaxWarning generated by the CyberSource library in Python 3.12+ by using warnings.catch_warnings().
  • Dependency Update: Updates the uv.lock file to reflect the latest versions of mitol-django-google-sheets and mitol-django-google-sheets-refunds.
  • Changelog Update: Adds a changelog entry to document the SyntaxWarning fix for CyberSource imports.

Changelog

  • src/payment_gateway/changelog.d/20250227_142343_jkachel_wrap_cybersource_imports.md
    • Added a changelog entry documenting the wrapping of CyberSource imports to suppress SyntaxWarnings.
  • src/payment_gateway/mitol/payment_gateway/api.py
    • Wrapped CyberSource imports (lines 15-27) in a warnings.catch_warnings() context manager to filter out SyntaxWarning.
    • Added import warnings on line 10.
  • uv.lock
    • Updated the version of mitol-django-google-sheets from 2025.2.4 to 2025.2.27 (line 1271).
    • Updated the version of mitol-django-google-sheets-refunds from 2025.2.3 to 2025.2.27 (line 1321).
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Trivia time!

What is the significance of the .d extension in the changelog.d directory?

Click here for the answer
The `.d` extension in `changelog.d` typically signifies a directory containing 'fragments' or 'snippets' of changelog entries. This pattern is often used by tools like `scriv` to aggregate these fragments into a complete changelog file.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request introduces a change to wrap CyberSource imports in a warnings filter to suppress SyntaxWarning messages. This is a good approach to address the issue until the upstream library is fixed. The changes look good overall.

Summary of Findings

Merge Readiness

The code changes are straightforward and address the reported issue. The automated tests should pass, and the suggested manual testing in MITx Online would provide additional confidence. I am unable to approve this pull request, and recommend that others review and approve this code before merging. Given the nature of the change, it seems reasonable to merge this pull request after addressing any feedback from additional reviewers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant