The Black shade analyser and comparison tool.

Last update: Apr 29, 2022

Overview

diff-shades

The Black shade analyser and comparison tool.

AKA Richard's personal take at a better black-primer (by stealing ideas from mypy-primer) :p

Basically runs Black over millions of lines of code from various open source projects. Why? So any changes to Black can be gauged on their relative impact.

Features include:

Simple but readable diffing capabilities
Repeatable analyses via --repeat-projects-from
Structured JSON output
per-project python_requires support
Oh and of course, pretty output!

Potential tasks / additionals:

jupyter notebook support
even more helpful output
stronger diffing abilities
better UX (particularly when things go wrong)
so much code cleanup - like a lot :p

Notice: this is a in-progress rewrite of the original diff-shades. I'm rewriting it as the code was quite unmaintainable as I built it wayy too fast. This time I'm focusing on building a good project structure, prettifying the output, and improving functionality. The thing is that this is a WIP so the claimed features above aren't accurate right now.

Installation

Clone the repository
Do a local pip install in the project root (eg. python -m pip install .)

Usage

todo: finish the readme once done with the rewrite

Comments

Bump actions/checkout from 2 to 3
Bumps actions/checkout from 2 to 3.

Release notes

Sourced from actions/checkout's releases.

v3.0.0

Update default runtime to node16

v2.4.0

Convert SSH URLs like org-<ORG_ID>@github.com: to https://github.com/ - pr

v2.3.5

Update dependencies

v2.3.4

Add missing awaits

Swap to Environment Files

v2.3.3

Remove Unneeded commit information from build logs

Add Licensed to verify third party dependencies

v2.3.2

Add Third Party License Information to Dist Files

v2.3.1

Fix default branch resolution for .wiki and when using SSH

v2.3.0

Fallback to the default branch

v2.2.0

Fetch all history for all tags and branches when fetch-depth=0

v2.1.1

Changes to support GHES (here and here)

v2.1.0

Group output

Changes to support GHES alpha release

Persist core.sshCommand for submodules

Add support ssh

Convert submodule SSH URL to HTTPS, when not using SSH

Add submodule support

Follow proxy settings

Fix ref for pr closed event when a pr is merged

Fix issue checking detached when git less than 2.22

Changelog

Sourced from actions/checkout's changelog.

Changelog

v2.3.1

Fix default branch resolution for .wiki and when using SSH

v2.3.0

Fallback to the default branch

v2.2.0

Fetch all history for all tags and branches when fetch-depth=0

v2.1.1

Changes to support GHES (here and here)

v2.1.0

Group output

Changes to support GHES alpha release

Persist core.sshCommand for submodules

Add support ssh

Convert submodule SSH URL to HTTPS, when not using SSH

Add submodule support

Follow proxy settings

Fix ref for pr closed event when a pr is merged

Fix issue checking detached when git less than 2.22

v2.0.0

Do not pass cred on command line

Add input persist-credentials

Fallback to REST API to download repo

Commits

a12a394 update readme for v3 (#708)

8f9e05e Update to node 16 (#689)

230611d Change secret name for PAT to not start with GITHUB_ (#623)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump actions/setup-python from 2 to 3.0.0
Bumps actions/setup-python from 2 to 3.0.0.

Release notes

Sourced from actions/setup-python's releases.

v3.0.0

What's Changed

Update default runtime to node16 (actions/setup-python#340)

Update package-lock.json file version to 2, @types/node to 16.11.25 and typescript to 4.2.3 (actions/setup-python#341)

Remove legacy pypy2 and pypy3 keywords (actions/setup-python#342)

Breaking Changes

With the update to Node 16, all scripts will now be run with Node 16 rather than Node 12.

This new major release removes support of legacy pypy2 and pypy3 keywords. Please use more specific and flexible syntax to specify a PyPy version:

jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: - 'pypy-2.7' # the latest available version of PyPy that supports Python 2.7 - 'pypy-3.8' # the latest available version of PyPy that supports Python 3.8 - 'pypy-3.8-v7.3.8' # Python 3.8 and PyPy 7.3.8 steps: - uses: actions/[email protected] - uses: actions/[email protected] with: python-version: ${{ matrix.python-version }}

See more usage examples in the documentation

Update primary and restore keys for pip

In scope of this release we include a version of python in restore and primary cache keys for pip. Besides, we add temporary fix for Windows caching issue, that the pip cache dir command returns non zero exit code or writes to stderr. Moreover we updated node-fetch dependency.

Update actions/cache version to 1.0.8

We have updated actions/cache dependency version to 1.0.8 to support 10GB cache upload

Support caching dependencies

This release introduces dependency caching support (actions/setup-python#266)

Caching dependencies.

The action has a built-in functionality for caching and restoring pip/pipenv dependencies. The cache input is optional, and caching is turned off by default.

Besides, this release introduces dependency caching support for mono repos and repositories with complex structure.

By default, the action searches for the dependency file (requirements.txt for pip or Pipfile.lock for pipenv) in the whole repository. Use the cache-dependency-path input for cases when you want to override current behaviour and use different file for hash generation (for example requirements-dev.txt). This input supports wildcards or a list of file names for caching multiple dependencies.

Caching pip dependencies:

steps: - uses: actions/[email protected] - uses: actions/[email protected] with: python-version: '3.9' </tr></table>

... (truncated)

Commits

0ebf233 Remove legacy PyPy input (#342)

665cd78 Update lockfileversion (#341)

93cb78f Update to node16 (#340)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 1
Bump actions/setup-python from 2 to 3
Bumps actions/setup-python from 2 to 3.

Release notes

Sourced from actions/setup-python's releases.

v3.0.0

What's Changed

Update default runtime to node16 (actions/setup-python#340)

Update package-lock.json file version to 2, @types/node to 16.11.25 and typescript to 4.2.3 (actions/setup-python#341)

Remove legacy pypy2 and pypy3 keywords (actions/setup-python#342)

Breaking Changes

With the update to Node 16, all scripts will now be run with Node 16 rather than Node 12.

This new major release removes support of legacy pypy2 and pypy3 keywords. Please use more specific and flexible syntax to specify a PyPy version:

jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: - 'pypy-2.7' # the latest available version of PyPy that supports Python 2.7 - 'pypy-3.8' # the latest available version of PyPy that supports Python 3.8 - 'pypy-3.8-v7.3.8' # Python 3.8 and PyPy 7.3.8 steps: - uses: actions/[email protected] - uses: actions/[email protected] with: python-version: ${{ matrix.python-version }}

See more usage examples in the documentation

Update primary and restore keys for pip

In scope of this release we include a version of python in restore and primary cache keys for pip. Besides, we add temporary fix for Windows caching issue, that the pip cache dir command returns non zero exit code or writes to stderr. Moreover we updated node-fetch dependency.

Update actions/cache version to 1.0.8

We have updated actions/cache dependency version to 1.0.8 to support 10GB cache upload

Support caching dependencies

This release introduces dependency caching support (actions/setup-python#266)

Caching dependencies.

The action has a built-in functionality for caching and restoring pip/pipenv dependencies. The cache input is optional, and caching is turned off by default.

Besides, this release introduces dependency caching support for mono repos and repositories with complex structure.

By default, the action searches for the dependency file (requirements.txt for pip or Pipfile.lock for pipenv) in the whole repository. Use the cache-dependency-path input for cases when you want to override current behaviour and use different file for hash generation (for example requirements-dev.txt). This input supports wildcards or a list of file names for caching multiple dependencies.

Caching pip dependencies:

steps: - uses: actions/[email protected] - uses: actions/[email protected] with: python-version: '3.9' </tr></table>

... (truncated)

Commits

0ebf233 Remove legacy PyPy input (#342)

665cd78 Update lockfileversion (#341)

93cb78f Update to node16 (#340)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump actions/setup-python from 3 to 4
Bumps actions/setup-python from 3 to 4.

Release notes

Sourced from actions/setup-python's releases.

v4.0.0

What's Changed

Support for python-version-file input: #336

Example of usage:

- uses: actions/[email protected] with: python-version-file: '.python-version' # Read python version from a file - run: python my_script.py

There is no default python version for this setup-python major version, the action requires to specify either python-version input or python-version-file input. If the python-version input is not specified the action will try to read required version from file from python-version-file input.

Use pypyX.Y for PyPy python-version input: #349

Example of usage:

- uses: actions/[email protected] with: python-version: 'pypy3.9' # pypy-X.Y kept for backward compatibility - run: python my_script.py

RUNNER_TOOL_CACHE environment variable is equal AGENT_TOOLSDIRECTORY: #338

Bugfix: create missing pypyX.Y symlinks: #347

PKG_CONFIG_PATH environment variable: #400

Added python-path output: #405 python-path output contains Python executable path.

Updated zeit/ncc to vercel/ncc package: #393

Bugfix: fixed output for prerelease version of poetry: #409

Made pythonLocation environment variable consistent for Python and PyPy: #418

Bugfix for 3.x-dev syntax: #417

Other improvements: #318 #396 #384 #387 #388

Update actions/cache version to 2.0.2

In scope of this release we updated actions/cache package as the new version contains fixes related to GHES 3.5 (actions/setup-python#382)

Add "cache-hit" output and fix "python-version" output for PyPy

This release introduces new output cache-hit (actions/setup-python#373) and fix python-version output for PyPy (actions/setup-python#365)

The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled.

... (truncated)

Commits

d09bd5e fix: 3.x-dev can install a 3.y version (#417)

f72db17 Made env.var pythonLocation consistent for Python and PyPy (#418)

53e1529 add support for python-version-file (#336)

3f82819 Fix output for prerelease version of poetry (#409)

397252c Update zeit/ncc to vercel/ncc (#393)

de977ad Merge pull request #412 from vsafonkin/v-vsafonkin/fix-poetry-cache-test

22c6af9 Change PyPy version to rebuild cache

081a3cf Merge pull request #405 from mayeut/interpreter-path

ff70656 feature: add a python-path output

fff15a2 Use pypyX.Y for PyPy python-version input (#349)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump pre-commit/action from 2.0.3 to 3.0.0
Bumps pre-commit/action from 2.0.3 to 3.0.0.

Release notes

Sourced from pre-commit/action's releases.

pre-commit/[email protected]

Breaking

remove pushing behaviour.

PR #164 by @asottile.

see README for alternatives

Commits

646c83f v3.0.0

7a7fccb Merge pull request #164 from pre-commit/remove-pushing

f5c2d25 remove pushing behaviour

c674242 Merge pull request #162 from pre-commit/pre-commit-ci-update-config

8a43c84 [pre-commit.ci] pre-commit autoupdate

0932232 Merge pull request #161 from pre-commit/pre-commit-ci-update-config

3945558 [pre-commit.ci] pre-commit autoupdate

d1945e3 Merge pull request #158 from pre-commit/pre-commit-ci-update-config

705d6c1 [pre-commit.ci] pre-commit autoupdate

c81293c Merge pull request #156 from pre-commit/pre-commit-ci-update-config

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Add big codebases that are not formatted with Black
Currently we run diff-shades on repos that are already formatted with Black, but I think it would be useful to add some non-Blackened projects, so we get a sense of how we format code that isn't already mostly Black-like. This is especially relevant for functionality that interacts with the magic trailing comma, like https://github.com/psf/black/pull/2368.

Some ideas:

https://github.com/google/pytype, almost a million lines of two-space indents

CPython, which surely has lots of interesting stuff in its test suite. I think some files there currently crash Black, though.

https://github.com/cython/cython, lots of code but I'm not sure it has anything unique

It looks like diff-shades might get slow enough that we should be selective in what we include.
type: enhancement C: projects
opened by JelleZijlstra 4
✨ Syntax highlighted diff output ✨

A bit hacky but it works, I haven't completely tested it with diff-shades but have tested the _diff.py lib separately.

Btw, I am logged out of discord and can't log in back (my phone broke and I can't find the recovery codes :pensive:), so keep the conversation here.

And happy new year! (a bit late)

opened by Shivansh-007 4

Releases(22.4b1)

22.4b1(Apr 17, 2022)
I know there are quite a few features still unimplemented, but diff-shades is being used in production so it's time to stop pretending it's still in alpha :)

Record tracebacks for failures too. show-failed will show 'em with --show-log although log files take precedence.

Normalize log file paths for AST equivalence / stability check errors to avoid constant run to run differences.

Colour the (allowed) tag green emitted by show-failed so it's more visible

Full Changelog: https://github.com/ichard26/diff-shades/compare/22.3a1...22.4b1
Source code(tar.gz)
Source code(zip)
diff-shades-22.4b1.tar.gz(76.45 KB)
diff_shades-22.4b1-py3-none-any.whl(25.15 KB)
22.3a1(Mar 14, 2022)
There's now a logo for diff-shades! woo!

Added --force-stable-style and --force-preview-style to forcefully set the code style across all projects.

Added -r as a short alias of --repeat-projects-from.

Added --check-allow so pre-existing failures don't cause show-failed --check to return one.

Log files produced when a file fails to format are now recorded and can be pulled via the show or show-failed commands.

--show-locals is also forcefully set on GHA.

Analyses can now be automatically zipped at save time by using the .zip file extension.

Fixed output suppression during project setup, hopefully this is the last fix needed to avoid stray output ^^

Removed --show-project-revision; instead pass -v or --verbose twice to achieve the same effect.

Full Changelog: https://github.com/ichard26/diff-shades/compare/21.12a7...22.3a1
Source code(tar.gz)
Source code(zip)
diff-shades-22.3a1.tar.gz(25.25 KB)
diff_shades-22.3a1-py3-none-any.whl(23.70 KB)
21.12a7(Dec 23, 2021)
Also show how many lines, files, and projects were analyzed in the comparison summary.

Add --show-project-revision as a less noisy alternative to --verbose which ONLY shows the project revisions (and not the result of each file).

@onerandomusername made their first contribution in https://github.com/ichard26/diff-shades/pull/3

Full Changelog: https://github.com/ichard26/diff-shades/compare/21.12a6...21.12a7
Source code(tar.gz)
Source code(zip)
diff-shades-21.12a7.tar.gz(24.61 KB)
diff_shades-21.12a7-py3-none-any.whl(22.59 KB)
21.12a6(Dec 22, 2021)
Don't forcefully set --force-colors if --no-colors was passed on GHA.

Add --quiet to the compare command to suppress the unnecessary log messages.

Source code(tar.gz)
Source code(zip)
diff-shades-21.12a6.tar.gz(21.91 KB)
diff_shades-21.12a6-py3-none-any.whl(21.13 KB)
21.12a5(Dec 22, 2021)
When running on GitHub Actions, --force-colors and the width will be forcefully set for you.

Source code(tar.gz)
Source code(zip)
diff-shades-21.12a5.tar.gz(21.77 KB)
diff_shades-21.12a5-py3-none-any.whl(21.04 KB)
21.12a4(Dec 18, 2021)

First version of diff-shades I'm willing to share publicly!

Thank you to black-primer and mypy-primer for all of their ideas I graciously stole :p
Source code(tar.gz)
Source code(zip)
diff-shades-21.12a4.tar.gz(21.45 KB)
diff_shades-21.12a4-py3-none-any.whl(20.81 KB)