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

Add pytest-sugar for improved pytest output. #272

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Conversation

mansenfranzen
Copy link
Owner

@mansenfranzen mansenfranzen commented Apr 24, 2024

Type

enhancement


Description

  • Added pytest-sugar to the pyproject.toml to enhance the output of pytest during test runs.
  • This change includes adding pytest-sugar as an optional dependency and listing it under the test extras to ensure it is installed with the test suite.

Changes walkthrough

Relevant files
Enhancement
pyproject.toml
Add pytest-sugar to pyproject.toml for enhanced testing output

pyproject.toml

  • Added pytest-sugar dependency with version "^1.0.0" marked as
    optional.
  • Included pytest-sugar in the test extras list.
  • +3/-1     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @mansenfranzen mansenfranzen merged commit 6c4244b into main Apr 24, 2024
    28 checks passed
    @mansenfranzen mansenfranzen deleted the add_pytest_sugar branch April 24, 2024 08:50
    @github-actions github-actions bot added the enhancement New feature or request label Apr 24, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (129b141)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR involves a simple addition of a dependency and its inclusion in an extras list. The changes are straightforward and limited to the pyproject.toml file.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:

    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Best practice
    Specify a more precise version range for pytest-sugar.

    Consider specifying a more precise version range for pytest-sugar to ensure compatibility
    with the project's dependencies and avoid potential conflicts with future versions.

    pyproject.toml [42]

    -pytest-sugar = { version = "^1.0.0", optional = true }
    +pytest-sugar = { version = "^1.0.0, <2.0.0", optional = true }
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

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

    Successfully merging this pull request may close these issues.

    None yet

    1 participant