fix: Fix circular dependencies errors for python packages

[MarcusArdelean]

Pull Request Submission

Please check the boxes once done.

The pull request must:

• Reviewer Documentation
  • follow CONTRIBUTING rules
  • be accompanied by a detailed description of the changes
  • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
  • highlight breaking API if applicable
  • contain a link to the automatic tests that cover the updated functionality.
  • [x ] contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
  • link to the link to the PR for the User-facing documentation
• User facing Documentation
  • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
  • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
• Testing
  • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

Updating the snyk-python-plugin version. The new version fixes the RecursionError: maximum recursion depth exceeded while calling a Python object error . This was happening due to some circular imports that same python packages have. For example apache-airflow requires apache-airflow-providers-common-io which requires apache-airflow again which results in a circular import and the dependency graph generator would fail after the 1000 maximum recursion depth is reached.

Where should the reviewer start?

The changes are available here: snyk-python-plugin PR

How should this be manually tested?

Running snyk test --command='python3' on any python 3 project that has packages with circular imports. For example apache-airflow==2.8.1

Any background context you want to provide?

On some Linux os systems like Ubuntu 22.04, the 'python' command is not available, unless alias-ed with python3.

What are the relevant tickets?

Slack conversation

Screenshots

[PeterSchafer]

Hi @MarcusArdelean,
could you please adapt the PR title to be more self explanatory and a complete sentence? The PR title will be by default the commit message that will be shown in the CLI Release Notes. Making this more understandable will help users understand which issue is being addressed. See for example this release where only one message properly explains the fix.
Thank you!

[bastiandoetsch]

Looks good to me, but what @PeterSchafer says :)

[MarcusArdelean]

@PeterSchafer I changed the PR title, let me know if it's explicit enough. Thank you!

[PeterSchafer]

@PeterSchafer I changed the PR title, let me know if it's explicit enough. Thank you!

Looks perfect, thank you!

Nitpick: to satisfy conventional commits it requires a fix: prefix in addition. It'll have to be fix: Fix circular dependencies errors for python packages

[PeterSchafer]

For some reason the PR Name didn't end up in the Release Notes. I will manually adapt it.

[MarcusArdelean]

Thank you @PeterSchafer 🔥