Read configuration from pyproject.toml #58

akaihola · 2020-08-16T19:46:54Z

Also dumps configuration on terminal if debug level logging is enabled with the -vv or --verbose --verbose command line option.

akaihola · 2020-08-16T19:50:15Z

I'm drafting a blog post about using darker and pytest-darker together. I realized that the setup I'm going to describe there will require the ability to use a configuration file configure how Darker is run.

akaihola · 2020-08-19T18:22:37Z

@Carreau, are you interested to review this?

(I still can't assign you as a reviewer in the GitHub UI since you haven't accepted the invitation to join as a collaborator. Do you want me to cancel the invitation?)

Carreau · 2020-08-19T18:26:03Z

Sorry I missed the invitation, it has expired now.

Carreau · 2020-08-19T18:28:26Z

did a quick read through, look good to me. I'll look at the blog post.

Carreau · 2020-08-19T18:30:41Z

On the blog post, maybe extend to why one might not want to run darker on that full code base at once.

Also add that with darker enabled the codebase will thus slowly converge to a point where all code is comformant in the limit of all lines having changed.

Also dumps configuration on terminal if debug level logging is enabled with the `-vv` or `--verbose --verbose` command line option.

src/darker/command_line.py

src/darker/config.py

Also: - clean lru_cache from the `black.find_project_root()` function in unit tests - add unit test for handling of positional command line arguments defined in configuration

pyproject.toml

src/darker/config.py

Fails to build wheels for - `regex` - `typed-ast` - `wrapt` - `lazy-object-proxy`

akaihola · 2020-08-25T13:57:30Z

@Carreau I did some major fixes after your review. Do you have time to review again, or would you prefer other contributors to join?

Carreau · 2020-08-26T00:10:29Z

Do you have time to review again, or would you prefer other contributors to join?

I'll try to do that now.

src/darker/command_line.py

Carreau · 2020-08-26T00:22:02Z

Looks good, one suggestion about print()/dumps_config, and one concern about making finding project root without a src

src/darker/config.py

src/darker/__main__.py

The tests broke with the Darker 20.8 update because of the changed formatting rules and the fact that we generated test data using Black. The test data is now hard-coded.

Only if no paths are given on the command line, try to load `pyproject.toml` in the Git root above current working directory, and use the `src =` option from there if available.

akaihola · 2020-08-27T16:27:41Z

Ok @Mystic-Mirage now the build in this branch succeeds. We have mixed Black 19.10/20.8 formatting in the code base, and CI only requires Black 20.8 formatting for lines modified in merge requests.

In a way, Darker is now eating its own dogfood 🐶

Could we merge this instead of #62 in your opinion?

src/darker/black_diff.py

src/darker/command_line.py

src/darker/config.py

src/darker/command_line.py

src/darker/black_diff.py

Sourcery refactoring – shorter code

sourcery-ai · 2020-09-02T17:13:08Z

Sourcery Code Quality Report (beta)

❌ Merging this PR will decrease code quality in the affected files by 0.08 out of 10.

Quality metrics	Before	After	Change
Complexity	1.79	1.76	-0.03 🔵
Method Length	68.81	77.76	8.95 🔴
Quality	8.32	8.24	-0.08 🔴

Other metrics	Before	After	Change
Lines	1040	1380	340

Changed files	Quality Before	Quality After	Quality Change
src/darker/main.py	7.39	7.34	-0.05 🔴
src/darker/argparse_helpers.py	9.25	9.01	-0.24 🔴
src/darker/black_diff.py	8.15	8.25	0.10 🔵
src/darker/command_line.py	7.73	7.85	0.12 🔵
src/darker/linting.py	8.08	8.08	0.00
src/darker/tests/conftest.py	9.21	9.27	0.06 🔵
src/darker/tests/test_command_line.py	8.49	7.98	-0.51 🔴
src/darker/tests/test_diff.py	8.23	8.22	-0.01 🔴
src/darker/tests/test_linting.py	7.74	7.73	-0.01 🔴

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Overall	Recommendation
src/darker/main.py	format_edited_parts	22	226.89	3.87	Split out functionality
src/darker/main.py	main	16	210.79	4.54	Split out functionality
src/darker/tests/test_command_line.py	test_parse_command_line	4	466.77	4.69	Split out functionality
src/darker/command_line.py	make_argument_parser	3	222.30	5.68	Split out functionality
src/darker/tests/test_command_line.py	test_black_options	0	193.48	6.26	Split out functionality

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

akaihola · 2020-09-12T16:23:07Z

@Carreau, I continued the blog post draft – what do you think about it now?

akaihola · 2020-10-18T12:43:43Z

I've now published the blog post Improving Python code incrementally on dev.to.

akaihola added the enhancement New feature or request label Aug 16, 2020

akaihola added this to the 1.2.0 milestone Aug 16, 2020

akaihola self-assigned this Aug 16, 2020

akaihola added this to In progress in Akaihola's Open source work via automation Aug 16, 2020

akaihola linked an issue Aug 16, 2020 that may be closed by this pull request

Configuration file(s) #49

Closed

1 task

Read configuration from pyproject.toml (#49)

dce884b

Also dumps configuration on terminal if debug level logging is enabled with the `-vv` or `--verbose --verbose` command line option.

akaihola force-pushed the config-file branch from 465bef2 to dce884b Compare August 19, 2020 18:41

akaihola added 2 commits August 19, 2020 22:24

Move argparse log level action to helpers module

0d53c71

Order and drop unused imports

4576337

akaihola commented Aug 19, 2020

View reviewed changes

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

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

akaihola requested a review from Carreau August 19, 2020 20:00

akaihola added 4 commits August 19, 2020 23:08

Add Darker configuration for the project itself

78d2914

Satisfy pylint on modified lines

8de70ab

Refactor into function to avoid three repetitions

a52adf6

In configuration, allow to define paths to process

9f4b078

Also: - clean lru_cache from the `black.find_project_root()` function in unit tests - add unit test for handling of positional command line arguments defined in configuration

akaihola commented Aug 23, 2020

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

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

Disable Travis CI build for Python nightly

2ba5d6f

Fails to build wheels for - `regex` - `typed-ast` - `wrapt` - `lazy-object-proxy`

Carreau reviewed Aug 26, 2020

View reviewed changes

src/darker/command_line.py Show resolved Hide resolved

Carreau reviewed Aug 26, 2020

View reviewed changes

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

src/darker/__main__.py Show resolved Hide resolved

akaihola added 3 commits August 26, 2020 20:34

Fix configuration dump TOML list format - commas!

714f7b4

Return TOML dump as string, print by caller

fce9e92

Format modifications with Black 20.8b1 rules

799216e

akaihola added 2 commits August 27, 2020 19:21

Fix diff tests

2385000

The tests broke with the Darker 20.8 update because of the changed formatting rules and the fact that we generated test data using Black. The test data is now hard-coded.

Find pyproject.toml based on paths to process

cfb1b5b

Only if no paths are given on the command line, try to load `pyproject.toml` in the Git root above current working directory, and use the `src =` option from there if available.

akaihola force-pushed the config-file branch from 2f8b59a to cfb1b5b Compare August 27, 2020 16:21

akaihola requested a review from Mystic-Mirage August 27, 2020 16:24

Mystic-Mirage reviewed Aug 27, 2020

View reviewed changes

src/darker/black_diff.py Show resolved Hide resolved

akaihola and others added 2 commits August 27, 2020 19:35

Change log for Travis CI using Darker itself

0d38c1c

Fix pyproject.toml reading using black 20.8b1

d8f3991

akaihola commented Aug 27, 2020

View reviewed changes

Unit test for make_argument_parser()

9ea5a3c

akaihola mentioned this pull request Aug 28, 2020

Add info for vim in readme. #61

Closed

akaihola added 2 commits August 28, 2020 08:32

Unit test for TomlArrayLinesEncoder

8a93b8b

Unit test for replace_log_level_name()

990b294

sourcery-ai bot mentioned this pull request Aug 28, 2020

Read configuration from pyproject.toml (Sourcery refactored) #65

Merged

akaihola and others added 4 commits August 28, 2020 09:27

Unit test for load_config()

dfa1c32

Unit test for get_effective_config()

818071d

Unit test for get_modified_config()

cf5fab2

'Refactored by Sourcery'

15e4752

akaihola mentioned this pull request Aug 28, 2020

Support commit ranges for -r / --revision #66

Merged

akaihola added 3 commits September 2, 2020 19:08

Merge pull request #65 from akaihola/sourcery/config-file

a99676d

Sourcery refactoring – shorter code

Unit test for dump_config()

bce3b22

Unit test for parse_command_line()

fc6c800

akaihola merged commit cc414a0 into master Sep 2, 2020

Akaihola's Open source work automation moved this from In progress to Done Sep 2, 2020

akaihola deleted the config-file branch September 2, 2020 18:09

akaihola mentioned this pull request Feb 18, 2022

Guard against breaking changes in isort's Python API #262

Closed

akaihola mentioned this pull request Mar 25, 2023

Guard against breaking changes in Flynt's Python API #473

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read configuration from pyproject.toml #58

Read configuration from pyproject.toml #58

akaihola commented Aug 16, 2020

akaihola commented Aug 16, 2020

akaihola commented Aug 19, 2020

Carreau commented Aug 19, 2020

Carreau commented Aug 19, 2020

Carreau commented Aug 19, 2020

akaihola commented Aug 25, 2020

Carreau commented Aug 26, 2020

Carreau commented Aug 26, 2020

akaihola commented Aug 27, 2020

sourcery-ai bot commented Sep 2, 2020

akaihola commented Sep 12, 2020

akaihola commented Oct 18, 2020

Read configuration from pyproject.toml #58

Read configuration from pyproject.toml #58

Conversation

akaihola commented Aug 16, 2020

akaihola commented Aug 16, 2020

akaihola commented Aug 19, 2020

Carreau commented Aug 19, 2020

Carreau commented Aug 19, 2020

Carreau commented Aug 19, 2020

akaihola commented Aug 25, 2020

Carreau commented Aug 26, 2020

Carreau commented Aug 26, 2020

akaihola commented Aug 27, 2020

sourcery-ai bot commented Sep 2, 2020

Sourcery Code Quality Report (beta)

akaihola commented Sep 12, 2020

akaihola commented Oct 18, 2020