- F move verify_argument_parser scrubber to caller

[JayBazuzi]

Not every user of verify_argument_parser wants to scrub the options header, or if they want to scrub it they may want to scrub it differently (e.g. [OPTIONS HEADER]), or they may want to scrub based on the version of Python (if sys.version_info >= (3, 10)...).

[sourcery-ai]

Reviewer's Guide by Sourcery

The PR moves the responsibility of providing the scrubber function from the verify_argument_parser function to its callers. This simplifies the verify_argument_parser implementation by removing the default scrubber logic and making it the caller's responsibility to handle text scrubbing if needed.

Sequence diagram for verify_argument_parser call with scrubber

sequenceDiagram
    participant Caller
    participant verify_argument_parser
    participant Options

    Caller->>verify_argument_parser: Call with parser and Options().with_scrubber(scrubber)
    verify_argument_parser->>Options: Use scrubber from Options
    verify_argument_parser->>verify_argument_parser: Format help with parser
    verify_argument_parser->>Caller: Return verification result

Loading

Updated class diagram for verify_argument_parser function

classDiagram
    class verify_argument_parser {
        -parser: ArgumentParser
        -options: Optional[Options]
        +verify_argument_parser(parser, options)
    }

    class Options {
        +with_scrubber(scrubber)
    }

    verify_argument_parser --> Options: uses
    note for verify_argument_parser "Scrubber logic moved to caller"

Loading

File-Level Changes

Change	Details	Files
Simplified verify_argument_parser by removing built-in scrubber functionality	Removed default Options creation and scrubber function Simplified verify call to only pass parser.format_help() Moved scrubber definition to test files	approvaltests/approvals.py
Updated test files to provide scrubber function explicitly	Added explicit scrubber function definition in test files Modified verify_argument_parser calls to include Options with scrubber	tests/test_verify_argument_parser.py tests/test_find_stale_approved_files.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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[nitsanavni]

@JayBazuzi is this still WIP? or can we merge?

[JayBazuzi]

@JayBazuzi is this still WIP? or can we merge?

It needs discussion. Llewellyn said he likes things as is. Some people I work with have a very slight preference for this proposed change; I thought it might be a blocking concern from them but they decided it was acceptable.