support python3.12 #2290

branchvincent · 2024-02-05T02:35:05Z

Python 3.12 has removed its bundled setuptools (aka pkg_resources): https://docs.python.org/3.12/whatsnew/3.12.html#removed

Summary by CodeRabbit

Refactor
- Improved plugin handling and version information retrieval in slither-analyzer, ensuring compatibility with Python 3.10.
- Replaced pkg_resources with importlib.metadata for handling entry points and version information retrieval.
- Updated the output_to_sarif function to use metadata instead of require.

CLAassistant · 2024-02-05T02:35:10Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

coderabbitai · 2024-02-05T02:35:22Z

Walkthrough

The recent update in the slither project involves transitioning from using pkg_resources to importlib.metadata for managing entry points, fetching version information, and enhancing the output_to_sarif function within the analyzer. This modification not only ensures compatibility with Python 3.10 but also optimizes plugin handling and streamlines the process of retrieving version details for slither-analyzer.

Changes

Files	Change Summary
`slither/__main__.py` `slither/utils/output.py`	Updated to use `importlib.metadata` for entry points, version info retrieval, and enhanced `output_to_sarif` function.

🐇✨
In the realm of code, a change took flight,
From pkg_resources to metadata bright.
Slither through code, with ease now we might,
A rabbit's cheer for progress in sight. 🎉
🌟🐰

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e3dcf1e and 93cbf7d.

Files selected for processing (2)

slither/main.py (3 hunks)
slither/utils/output.py (2 hunks)

coderabbitai · 2024-02-05T02:36:23Z

slither/utils/output.py

@@ -161,7 +160,7 @@ def output_to_sarif(
                    "driver": {
                        "name": "Slither",
                        "informationUri": "https://github.com/crytic/slither",
-                        "version": require("slither-analyzer")[0].version,
+                        "version": metadata.version("slither-analyzer"),


Ensure that metadata.version("slither-analyzer") is wrapped in a try-except block to handle PackageNotFoundError in case the package is not found.

coderabbitai · 2024-02-05T02:36:23Z

slither/__main__.py

+    if sys.version_info >= (3, 10):
+        entry_points = metadata.entry_points(group="slither_analyzer.plugin")
+    else:
+        from pkg_resources import iter_entry_points
+        entry_points = iter_entry_points(group="slither_analyzer.plugin", name=None)
+


Consider simplifying the conditional import logic for entry_points by directly using metadata.entry_points(group="slither_analyzer.plugin"), as the minimum supported Python version is now 3.10.

coderabbitai · 2024-02-05T02:36:23Z

slither/__main__.py

@@ -297,7 +302,7 @@ def parse_args(
    parser.add_argument(
        "--version",
        help="displays the current version",
-        version=require("slither-analyzer")[0].version,
+        version=metadata.version("slither-analyzer"),


Ensure that metadata.version("slither-analyzer") is wrapped in a try-except block to handle PackageNotFoundError in case the package is not found.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e3dcf1e and 410119a.

Files selected for processing (2)

slither/main.py (3 hunks)
slither/utils/output.py (2 hunks)

Files skipped from review as they are similar to previous changes (2)

slither/main.py
slither/utils/output.py

elopez

Thanks for the PR @branchvincent! This looks good!

NB @0xalpharush I have not manually confirmed if the plugin system remains working on 3.10+ and I don't think we have an automated test for that.

elopez · 2024-02-05T11:49:20Z

slither/__main__.py

@@ -166,7 +165,14 @@ def get_detectors_and_printers() -> Tuple[
    printers = [p for p in printers_ if inspect.isclass(p) and issubclass(p, AbstractPrinter)]

    # Handle plugins!
-    for entry_point in iter_entry_points(group="slither_analyzer.plugin", name=None):
+    if sys.version_info >= (3, 10):
+        entry_points = metadata.entry_points(group="slither_analyzer.plugin")


It may be possible to use this implementation in 3.8+ as well if we added a dependency on importlib_metadata >= 3.6 and imported metadata through it.

0xalpharush · 2024-02-05T15:00:50Z

We should update this to run 3.8 and 3.12 on every PR and run 3.8-3.12.

slither/.github/workflows/test.yml

Line 28 in 1bd279a

    
           python: ${{ (github.event_name == 'pull_request' && fromJSON('["3.8", "3.11"]')) || fromJSON('["3.8", "3.9", "3.10", "3.11"]') }}

0xalpharush · 2024-02-05T16:43:22Z

@branchvincent Would you be willing to sign the CLA please?

0xalpharush · 2024-02-12T18:14:43Z

@branchvincent bump

0xalpharush · 2024-02-16T23:05:25Z

@elopez I guess we are going to have to reopen this ourselves since the OP is unresponsive

branchvincent · 2024-02-16T23:18:15Z

sorry about that, I have to check with my employer before signing the CLA. alternatively, I'm more than happy for you to just create the same PR

0xalpharush · 2024-03-01T22:53:00Z

replaced by #2348

branchvincent requested review from montyly, 0xalpharush and smonicas as code owners February 5, 2024 02:35

coderabbitai bot reviewed Feb 5, 2024

View reviewed changes

elopez linked an issue Feb 5, 2024 that may be closed by this pull request

python3.12 support is broken #2276

Closed

support python3.12

410119a

branchvincent force-pushed the python3.12 branch from 93cbf7d to 410119a Compare February 5, 2024 03:27

coderabbitai bot reviewed Feb 5, 2024

View reviewed changes

0xalpharush requested a review from elopez February 5, 2024 04:39

elopez approved these changes Feb 5, 2024

View reviewed changes

0xalpharush closed this Mar 1, 2024

branchvincent deleted the python3.12 branch March 4, 2024 03:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support python3.12 #2290

support python3.12 #2290

branchvincent commented Feb 5, 2024 •

edited by coderabbitai bot

Loading

CLAassistant commented Feb 5, 2024

coderabbitai bot commented Feb 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot Feb 5, 2024

coderabbitai bot Feb 5, 2024

coderabbitai bot Feb 5, 2024

coderabbitai bot left a comment

elopez left a comment

elopez Feb 5, 2024

0xalpharush commented Feb 5, 2024

0xalpharush commented Feb 5, 2024

0xalpharush commented Feb 12, 2024

0xalpharush commented Feb 16, 2024

branchvincent commented Feb 16, 2024 •

edited

Loading

0xalpharush commented Mar 1, 2024

support python3.12 #2290

support python3.12 #2290

Conversation

branchvincent commented Feb 5, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

CLAassistant commented Feb 5, 2024

coderabbitai bot commented Feb 5, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Feb 5, 2024

Choose a reason for hiding this comment

coderabbitai bot Feb 5, 2024

Choose a reason for hiding this comment

coderabbitai bot Feb 5, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

elopez left a comment

Choose a reason for hiding this comment

elopez Feb 5, 2024

Choose a reason for hiding this comment

0xalpharush commented Feb 5, 2024

0xalpharush commented Feb 5, 2024

0xalpharush commented Feb 12, 2024

0xalpharush commented Feb 16, 2024

branchvincent commented Feb 16, 2024 • edited Loading

0xalpharush commented Mar 1, 2024

branchvincent commented Feb 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

branchvincent commented Feb 16, 2024 •

edited

Loading