Skip to content

fix(function): fix strip_formatting function regex #874

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

Merged
merged 1 commit into from
May 30, 2025

Conversation

CapnRyna
Copy link
Contributor

@CapnRyna CapnRyna commented May 26, 2025

Description

fixes the strip_formatting function regex that caused strings with codeblock ticks to return a empty string and not trigger the is_harmful functions

Guidelines

  • My code follows the style guidelines of this project (formatted with Ruff)

  • I have performed a self-review of my own code

  • I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation if needed

  • My changes generate no new warnings

  • I have tested this change

  • Any dependent changes have been merged and published in downstream modules

  • I have added all appropriate labels to this PR

  • I have followed all of these guidelines.

How Has This Been Tested? (if applicable)

locally hosted and tested in ATL's dev server

Summary by Sourcery

Fix strip_formatting to preserve text within Markdown code fences instead of removing it, ensuring harmful content detection triggers correctly for backtick-enclosed strings.

Bug Fixes:

  • Update triple backtick regex to capture and retain inner content rather than drop entire block
  • Adjust single backtick regex to preserve code content inside backticks instead of deleting it

Copy link
Contributor

sourcery-ai bot commented May 26, 2025

Reviewer's Guide

This PR refines the strip_formatting function by updating the regex patterns used for triple and single backtick code blocks to capture and retain inner content instead of removing it entirely, ensuring strings with code block ticks are processed correctly by is_harmful functions.

Sequence Diagram: Impact of strip_formatting Fix on is_harmful Input

sequenceDiagram
    participant C as Caller
    participant SF as strip_formatting
    participant IH as is_harmful

    C->>SF: strip_formatting("Text with ```code_block``` and `inline_code`")
    activate SF
    Note right of SF: Regex updated to preserve content within ```...``` and `...`
    SF-->>C: "Text with code_block and inline_code"
    deactivate SF

    C->>IH: is_harmful("Text with code_block and inline_code")
    activate IH
    Note right of IH: Receives full content, including text previously stripped from code blocks
    IH-->>C: AssessmentResult
    deactivate IH
Loading

File-Level Changes

Change Details Files
Updated regex for triple backtick code blocks to preserve inner content
  • Changed pattern from [\s\S]*? to (.*?)
  • Replaced full removal with capturing group replacement
tux/utils/functions.py
Updated regex for single backtick code blocks to preserve inner content
  • Changed pattern from [^]+to([^]*)
  • Replaced full removal with capturing group replacement
tux/utils/functions.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @CapnRyna - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -96,9 +96,9 @@ def strip_formatting(content: str) -> str:
The string with formatting stripped.
"""
# Remove triple backtick blocks
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick: Update comment to reflect new behavior

Consider renaming to clarify that only triple backtick formatting is removed, not entire code blocks.

@kzndotsh kzndotsh merged commit a9e9c56 into allthingslinux:main May 30, 2025
3 of 4 checks passed
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