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.

Sign up for GitHub

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

Jump to bottom

Handle multiline options #3400

Merged
merged 6 commits into from
Apr 10, 2024
Merged

Handle multiline options #3400

merged 6 commits into from
Apr 10, 2024

Commits on Apr 10, 2024

  1. Add tests to exhibit the issue with multiline options

    @DimitriPapadopoulos
    DimitriPapadopoulos committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    dcc28c1 View commit details
    Browse the repository at this point in the history

  2. Handle multiline options 

    Clean up options expecting lists before using them, as they may contain
newlines.

Examples:
* Enclosing command-line arguments in quotes may introduce newlines in
  option values:
  	$ codespell -S "A, B,
  	>               C, D, E"
* INI files may contain multiline values:
  	[codespell]
  	skip = A, B,
  	       C, D, E,

In all the above cases, the option parsing mechanism keeps the newlines
(and spaces). We need to clean up, by splitting on commas and stripping
each resulting item from newlines (and spaces).
    @DimitriPapadopoulos
    DimitriPapadopoulos committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    51f9160 View commit details
    Browse the repository at this point in the history

  3. FIX: Simplify

    @larsoner
    larsoner committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    95c83ac View commit details
    Browse the repository at this point in the history

  4. [pre-commit.ci] auto fixes from pre-commit.com hooks 

    for more information, see https://pre-commit.ci
    @pre-commit-ci
    pre-commit-ci[bot] committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    a49d77a View commit details
    Browse the repository at this point in the history

  5. FIX: Literal

    @larsoner
    larsoner committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    f3ea6ce View commit details
    Browse the repository at this point in the history

  6. Default arguments should not be mutable 

    https://florimond.dev/en/posts/2018/08/python-mutable-defaults-are-the-source-of-all-evil
    @DimitriPapadopoulos
    DimitriPapadopoulos committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    17da0fe View commit details
    Browse the repository at this point in the history