Skip to content

Custom Filters cannot be passed in from the command line #202

Description

@a-weiss-programmer
  • I'm submitting a ...

    • bug report
    • feature request
  • What is the current behavior?
    Adding a custom filter by file when doing a command line scan is not working. When trying to pass a custom filter as described in the document, a command line usage error comes back saying "detect-secrets scan: error: argument -f/--filter: Did not specify function name for imported file."

  • If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

  1. Install bc-detect-secrets
  2. Create a custom_filter.py script with the given filter in the documentation
  3. Invoke the command below the example script provided in the filter documentation
    ax8YXP0dQN
  • What is the expected behavior?
    The expected behavior is that the filter would be picked up properly. This functionality works when invoking detect secrets from a separate python program.

  • What is the motivation / use case for changing the behavior?
    Allows for proper usage of the command line behavior provided

  • Please tell us about your environment:

    • detect-secrets Version: 1.5.5
    • Python Version: 3.11.8
    • OS Version: Ubuntu 22.04.4 LTS (Windows Subsystem for Linux)
    • File type (if applicable):
  • Other information
    This is most likely an issue with urllib parsing of the file in the filters usage file, as urlparse returns a ParseResult where the netloc property is populated with the filepath instead of the path property, since the scheme is file based.

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions