feature/black command line args #3

CorreyL · 2020-05-07T16:48:02Z

My team wishes to add darker as a pre-commit hook to our Python codebases, but we need support for the --line-length (-l) and --skip-string-normalization (-S) command line arguments to black, as outlined here:

https://black.readthedocs.io/en/stable/installation_and_usage.html#command-line-options

To add support for these options, I modified your invocation of black.FileMode here:

5c606cf#diff-c021797c036b1ba8d6aac676393ca67aR95-R103

To parse the dict that is being now being passed from main, and set the arguments to black.FileMode accordingly.

Note that I've set the defaults for the added command line arguments in accordance with the defaults black uses

class black.FileMode(
  # ...
  line_length: int = 88,
  string_normalization: bool = True,
  # ...
)

Do note that the command line argument is --skip-string-normalization, whereas the argument to black.FileMode is string_normalization, hence the inverse of the darker -S command line argument here:

5c606cf#diff-c021797c036b1ba8d6aac676393ca67aR97-R101

This all being said, there may have been a good reason why you opted not to support these additional command line arguments, in which case I will understand if you choose not to merge this pull requests.

Nevertheless, if you deem this a worthy idea of merging into the main repo, please let me know if I can make any additional adjustments such that you'd agree to merge my added code.

Thanks,
Correy

`black` supports the the command line arguments `--line-length` (-l) and `--skip-string-normalization` (-S), and can be invoked through the `black.FileMode` class As such, add arg parse support for `darker` for `--line-length` and `--skip-string-normalization` to pass into `black.FileMode` Set the default values of the args to their `black` defaults, ensuring that they are not required arguments to run `darker`

* Add an additional `dict` argument to `__main__.format_edited_parts` and `black_diff.run_black` as the parameter to store arguments intended for the `black.FileMode` instantiation used in `run_black` * Parse the args `line_length` and `skip_string_normalization` from `args` in `main`, bundle them in a `dict` and add as a parameter to the invocation of `format_edited_parts`, ensuring that the arguments reach the instantiation of `black.FileMode` in `run_black`

Ensures users are aware of what command line arguments will be forwarded to `black`

akaihola

Thanks @CorreyL, this is a great addition! Please consider my minor suggestions in the review.

README.rst

src/darker/black_diff.py

src/darker/command_line.py

akaihola · 2020-06-21T20:03:21Z

Also @CorreyL there's #1 which adds support for using a Black configuration file. I wonder if there's something these two PRs should take into account considering each other?

akaihola · 2020-06-21T20:35:53Z

Also please add your information to the CONTRIBUTORS.rst file!

akaihola · 2020-06-21T20:38:25Z

This new feature deserves a mention in the change log (CHANGES.rst). Could you add that as well?

- Rename `code` to `code-block` to be consistent with the rest of the README file - Correct the language specifier from `sh` to `shell`, per the specifications of `reStructuredText` Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

Ensure the PEP8 convention is being followed for closing off triple-double-quote blocks Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

For the option `--skip-string-normalization`, use the help string that's used in `black`, for the sake of consistency Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

For the option `--line-length`, use the help string that's used in `black`, for the sake of consistency Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

…ure/black-command-line-args

CorreyL · 2020-06-21T23:01:33Z

This new feature deserves a mention in the change log (CHANGES.rst). Could you add that as well?

I'd be happy to @akaihola! Did you have a version number in mind for this additional feature? I was thinking 0.3.0, following:

MINOR version when you add functionality in a backwards compatible manner

Source: https://semver.org/

But I'm happy to adhere to whatever you'd prefer =)

CorreyL · 2020-06-21T23:04:24Z

Also @CorreyL there's #1 which adds support for using a Black configuration file. I wonder if there's something these two PRs should take into account considering each other?

I'd be happy to integrate the code from #1 into my branch, and make any necessary changes, when it has been approved and merged into master

@akaihola

Per the request of @akaihola in PR akaihola#3

…darker into feature/black-command-line-args

CorreyL · 2020-06-21T23:06:50Z

Also please add your information to the CONTRIBUTORS.rst file!

Addressed in 74c6c4e

akaihola · 2020-06-24T11:25:22Z

@CorreyL

I'd be happy to integrate the code from #1 into my branch, and make any necessary changes, when it has been approved and merged into master

#1 has now been merged. Go ahead!

Did you have a version number in mind for this additional feature? I was thinking 0.3.0

Seems like a good idea. Actually, merging #1 already bumped the version number to 0.3.0.dev (with .dev to be removed when the release is done).

Into `feature/black-command-line-args` Make `black_args` a temporarily un-used variable for `run_black`, where subsequent commits will re-instate its usage

The default values are now handled inside of `run_black`, since it uses the function `read_pyproject_toml` from `black`, which will handle setting default values if the keys are not defined in a `pyproject.toml` file

Add logic to `run_black`, dictating that if command line arguments for `--line-length` and/or `--skip-string-normalization` were specified, override both the default values and anything specified in a `pyproject.toml` file, per the `black` docs: Command-line options have defaults that you can see in --help. A pyproject.toml can override those defaults. Finally, options provided by the user on the command line override both. Source: https://black.readthedocs.io/en/stable/pyproject_toml.html#lookup-hierarchy

CorreyL · 2020-06-25T04:24:31Z

@akaihola

From PR #1, for the merge conflict that arised in 8b9c0c1, note that I've merged the function signatures such that black_args is still a required param for the relevant functions, and config is still an optional param:

8b9c0c1#diff-1e1c88d1d01cbbcc466495c946c76221R23-R25

8b9c0c1#diff-c021797c036b1ba8d6aac676393ca67aR102

Feel free to let me know if the changes in 0e822e9 or 4422679 could be made more clear.

Per the commit message, the rationale behind the logic in 4422679 can be justified by the black docs:

Command-line options have defaults that you can see in --help. A pyproject.toml can override those defaults. Finally, options provided by the user on the command line override both.

Source: https://black.readthedocs.io/en/stable/pyproject_toml.html#lookup-hierarchy

No need for a separate `config` parameter in - `format_edited_parts()` - `run_black()`

Other options are handled in parts of Black code base which are not run when we call `format_str()` directly.

Override configuration file options first with command line options, then translate the result into parameters for `FileMode()`. This simplifies parameter handling a bit.

CHANGES.rst

README.rst

src/darker/black_diff.py

src/darker/__main__.py

@akaihola

Follow the standard convention @akaihola follows, only setting the version number in the same commit that the release is being made Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

…mand-line-processing

…sing Unify command line processing

Ensures consistency with help text printed from `command_line.py` Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

CorreyL · 2020-06-25T23:34:05Z

Note that I mangled my commit message in feb1dbc, hence the force push of 15cb524

Ensures users are aware that the `-c`/`--config` command that is in `black` is supported by `darker`

CorreyL added 3 commits May 7, 2020 09:09

Add supported black command line args to README

6b2cdb6

Ensures users are aware of what command line arguments will be forwarded to `black`

akaihola requested changes Jun 21, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

src/darker/black_diff.py Show resolved Hide resolved

src/darker/command_line.py Outdated Show resolved Hide resolved

src/darker/command_line.py Outdated Show resolved Hide resolved

CorreyL and others added 5 commits June 21, 2020 15:52

Add empty line before closing triple-double-quote

eea6472

Ensure the PEP8 convention is being followed for closing off triple-double-quote blocks Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

Use help string from black

d31ee37

For the option `--skip-string-normalization`, use the help string that's used in `black`, for the sake of consistency Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

Use help string from black

f5c3b16

For the option `--line-length`, use the help string that's used in `black`, for the sake of consistency Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

Merge remote-tracking branch 'remotes/original-repo/master' into feat…

e17e07a

…ure/black-command-line-args

CorreyL added 2 commits June 21, 2020 16:05

Add CorreyL to list of contributors

74c6c4e

Per the request of @akaihola in PR akaihola#3

Merge branch 'feature/black-command-line-args' of github.com:CorreyL/…

5e84d3c

…darker into feature/black-command-line-args

CorreyL requested a review from akaihola June 21, 2020 23:07

CorreyL added 3 commits June 24, 2020 21:12

Merge remote-tracking branch 'master'

8b9c0c1

Into `feature/black-command-line-args` Make `black_args` a temporarily un-used variable for `run_black`, where subsequent commits will re-instate its usage

Remove default values for -l and -S

0e822e9

The default values are now handled inside of `run_black`, since it uses the function `read_pyproject_toml` from `black`, which will handle setting default values if the keys are not defined in a `pyproject.toml` file

CorreyL and others added 6 commits June 24, 2020 21:48

Update version # & add new cmd line arg options

588c740

Include black --config in black_args parameter

b6434c8

No need for a separate `config` parameter in - `format_edited_parts()` - `run_black()`

Only get FileMode options from Black config files

8b2d205

Other options are handled in parts of Black code base which are not run when we call `format_str()` directly.

Simpler merge of config file and cmdline options

58e05a2

Override configuration file options first with command line options, then translate the result into parameters for `FileMode()`. This simplifies parameter handling a bit.

Add unit tests for configfile/cmdline processing

be2ddb5

Typing fixes to make Mypy happy

8156c79

akaihola requested changes Jun 25, 2020

View reviewed changes

CHANGES.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

src/darker/black_diff.py Outdated Show resolved Hide resolved

src/darker/__main__.py Outdated Show resolved Hide resolved

CorreyL and others added 4 commits June 25, 2020 16:13

Update CHANGES.rst

175ae0e

Follow the standard convention @akaihola follows, only setting the version number in the same commit that the release is being made Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

Improve suggested typing of black_args parameter

9eecb66

Merge branch 'feature/black-command-line-args' into feature/unify-com…

292c71d

…mand-line-processing

Merge pull request #1 from akaihola/feature/unify-command-line-proces…

4a2567d

…sing Unify command line processing

CorreyL requested a review from akaihola June 25, 2020 23:27

Update -S and -l help text in README

15cb524

Ensures consistency with help text printed from `command_line.py` Co-authored-by: Antti Kaihola <13725+akaihola@users.noreply.github.com>

CorreyL force-pushed the feature/black-command-line-args branch from feb1dbc to 15cb524 Compare June 25, 2020 23:33

Add -c/--config to README black cmd line options

5833bf2

Ensures users are aware that the `-c`/`--config` command that is in `black` is supported by `darker`

akaihola approved these changes Jun 26, 2020

View reviewed changes

akaihola merged commit cdd3369 into akaihola:master Jun 26, 2020

akaihola added this to the 1.0.0 milestone Jul 11, 2020

akaihola added the enhancement New feature or request label Jul 11, 2020

akaihola mentioned this pull request Sep 15, 2024

Remove deprecated options in [tool.darker] #607

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature/black command line args #3

feature/black command line args #3

CorreyL commented May 7, 2020

akaihola left a comment

akaihola commented Jun 21, 2020

akaihola commented Jun 21, 2020

akaihola commented Jun 21, 2020

CorreyL commented Jun 21, 2020

CorreyL commented Jun 21, 2020

CorreyL commented Jun 21, 2020

akaihola commented Jun 24, 2020

CorreyL commented Jun 25, 2020 •

edited

Loading

CorreyL commented Jun 25, 2020

feature/black command line args #3

feature/black command line args #3

Conversation

CorreyL commented May 7, 2020

akaihola left a comment

Choose a reason for hiding this comment

akaihola commented Jun 21, 2020

akaihola commented Jun 21, 2020

akaihola commented Jun 21, 2020

CorreyL commented Jun 21, 2020

CorreyL commented Jun 21, 2020

CorreyL commented Jun 21, 2020

akaihola commented Jun 24, 2020

CorreyL commented Jun 25, 2020 • edited Loading

CorreyL commented Jun 25, 2020

CorreyL commented Jun 25, 2020 •

edited

Loading