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

Rewrite compat patching to fix module double-execution #490

Merged
merged 2 commits into from
Dec 23, 2024
Merged

Conversation

kageurufu
Copy link
Member

I previously was simply generating aliases for any currently imported klippy modules. While this somewhat worked, it did not handle cases where a module was not imported until after patching completed.

This new hooking method provides two features:

  1. Rewrite non-package imports, e.g. import mcu effectively becomes import klippy.mcu as mcu
  2. Provide aliases in sys.modules to prevent double-execution of modules.

The second is especially important as is and isinstance checks will fail between two seperately imported copies of the same module.

Checklist

  • pr title makes sense
  • squashed to 1 commit
  • added a test case if possible
  • if new feature, added to the readme
  • ci is happy and green

I previously was simply generating aliases for any currently imported
klippy modules. While this somewhat worked, it did not handle cases
where a module was not imported until after patching completed.

This new hooking method provides two features:

1. Rewrite non-package imports, e.g. `import mcu` effectively becomes `import klippy.mcu as mcu`
2. Provide aliases in sys.modules to prevent double-execution of modules.

The second is especially important as `is` and `isinstance` checks will fail between two seperately
imported copies of the same module.
@kageurufu kageurufu requested a review from a team as a code owner December 17, 2024 19:06
klippy/printer.py Outdated Show resolved Hide resolved
@rogerlz rogerlz merged commit b0c0ce6 into main Dec 23, 2024
2 checks passed
@rogerlz rogerlz deleted the better_compat branch December 23, 2024 02:02
kageurufu added a commit that referenced this pull request Dec 24, 2024
iamnotahippie reported breakage in HappyHare after PR #490 was merged.
I did a bunch of investigation, and found that the `path` rewrite in the
import aliasing was causing the imported modules to have the wrong
internal package name, which caused subsequent relative imports to also
look in the wrong place

This change fixes that, and with compat in place HappyHare now passes
our `--import-test`
@kageurufu kageurufu mentioned this pull request Dec 24, 2024
5 tasks
rogerlz pushed a commit that referenced this pull request Dec 27, 2024
iamnotahippie reported breakage in HappyHare after PR #490 was merged.
I did a bunch of investigation, and found that the `path` rewrite in the
import aliasing was causing the imported modules to have the wrong
internal package name, which caused subsequent relative imports to also
look in the wrong place

This change fixes that, and with compat in place HappyHare now passes
our `--import-test`
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.

2 participants