Skip to content
Snippets Groups Projects

Apply black formatting to Python code and add pre-commit hook

Closed Apply black formatting to Python code and add pre-commit hook
generated-differential-D2981-source into generated-differential-D2981-target
Closed Antoine Lambert requested to merge generated-differential-D2981-source into generated-differential-D2981-target

I heard it was time to move to black formatting in all swh components ;-)

That huge diff contains the following:

  • reformat the whole swh-web Python codebase using black tool

  • add pre-commit hook to run black on all changed files

  • update flake8 configuration to match black code style

  • remove a lot of useless '# noqa' comments after new formatting

Migrated from D2981 (view on Phabricator)

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Software Heritage Continuous Integration for public repositories
    Software Heritage Continuous Integration for public repositories @swh-public-ci ·

    Build has FAILED

    Patch application report for D2981 (id=10596)

    Rebasing onto 2251dea5...

    Current branch diff-target is up to date.
    Changes applied before test
    commit 15834b070bf757168bd27deca953867b90ccd7d0
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed Apr 8 15:08:29 2020 +0200

    Apply black formatting to Python code and add pre-commit hook
    
    - reformat the whole swh-web Python codebase using black tool
    
    - add pre-commit hook to run black on all changed files
    
    - update flake8 configuration to match black code style
    
    - remove a lot of useless '# noqa' comments after new formatting

    Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/49/ See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/49/console

  • Antoine R. Dumont
    Antoine R. Dumont @ardumont ·
    Maintainer

    Thanks for this.

    We also agreed, on irc, to not review such a huge diff with mostly formatting changes. So, i guess, let the build finish and if everything is fine, you can push ;)

    I checked the setup-ed files (setup.cfg, ...) and they look quite similar as in other diffs so fine ;)

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    ! In !287 (closed), @ardumont wrote: Thanks for this.

    We also agreed, on irc, to not review such a huge diff with mostly formatting changes. So, i guess, let the build finish and if everything is fine, you can push ;)

    I checked the setup-ed files (setup.cfg, ...) and they look quite similar as in other diffs so.

    I can imagine as the content is pure reformatting ;-) I just need a validation on configuration and test CI build.

  • Software Heritage Continuous Integration for public repositories
    Software Heritage Continuous Integration for public repositories @swh-public-ci ·

    Build has FAILED

    Patch application report for D2981 (id=10596)

    Rebasing onto 2251dea5...

    Current branch diff-target is up to date.
    Changes applied before test
    commit 15834b070bf757168bd27deca953867b90ccd7d0
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed Apr 8 15:08:29 2020 +0200

    Apply black formatting to Python code and add pre-commit hook
    
    - reformat the whole swh-web Python codebase using black tool
    
    - add pre-commit hook to run black on all changed files
    
    - update flake8 configuration to match black code style
    
    - remove a lot of useless '# noqa' comments after new formatting

    Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/50/ See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/50/console

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    Seems the black changes makes the build fail as this error appeared:

    16:16:45    Running setup.py develop for swh.web
16:16:45      ERROR: Command errored out with exit status 1:
16:16:45       command: /usr/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/var/lib/jenkins/workspace/DWAPPS/tests-on-diff/setup.py'"'"'; __file__='"'"'/var/lib/jenkins/workspace/DWAPPS/tests-on-diff/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' develop --no-deps --user --prefix=
16:16:45           cwd: /var/lib/jenkins/workspace/DWAPPS/tests-on-diff/
16:16:45      Complete output (30 lines):
16:16:45      running develop
16:16:45      /tmp/pip-build-env-egnk76io/overlay/lib/python3.7/site-packages/setuptools/dist.py:472: UserWarning: The version specified ('base-revision-50-!287.post1') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
16:16:45        "details." % version
16:16:45      WARNING: The user site-packages directory is disabled.
16:16:45      error: can't create or remove files in install directory
16:16:45      
16:16:45      The following error occurred while trying to add or remove files in the
16:16:45      installation directory:
16:16:45      
16:16:45          [Errno 13] Permission denied: '/usr/local/lib/python3.7/dist-packages/test-easy-install-61.write-test'
16:16:45      
16:16:45      The installation directory you specified (via --install-dir, --prefix, or
16:16:45      the distutils default setting) was:
16:16:45      
16:16:45          /usr/local/lib/python3.7/dist-packages/
16:16:45      
16:16:45      Perhaps your account does not have write access to this directory?  If the
16:16:45      installation directory is a system-owned directory, you may need to sign in
16:16:45      as the administrator or "root" account.  If you do not have administrative
16:16:45      access to this machine, you may wish to choose a different installation
16:16:45      directory, preferably one that is listed in your PYTHONPATH environment
16:16:45      variable.
16:16:45      
16:16:45      For information on other options, you may wish to consult the
16:16:45      documentation at:
16:16:45      
16:16:45        https://setuptools.readthedocs.io/en/latest/easy_install.html
16:16:45      
16:16:45      Please make the appropriate changes for your system and try again.
16:16:45      
16:16:45      ----------------------------------------
16:16:45    ERROR: Can't roll back swh.web; was not uninstalled
16:16:45  ERROR: Command errored out with exit status 1: /usr/bin/python3 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/var/lib/jenkins/workspace/DWAPPS/tests-on-diff/setup.py'"'"'; __file__='"'"'/var/lib/jenkins/workspace/DWAPPS/tests-on-diff/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' develop --no-deps --user --prefix= Check the logs for full command output.

    I need to dig further on this.

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    Update: add black processing in tox

  • Software Heritage Continuous Integration for public repositories
    Software Heritage Continuous Integration for public repositories @swh-public-ci ·

    Build has FAILED

    Patch application report for D2981 (id=10598)

    Rebasing onto 2251dea5...

    Current branch diff-target is up to date.
    Changes applied before test
    commit f70a400e3f70c10ee6eb5abfc4fa825b21efb659
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed Apr 8 15:08:29 2020 +0200

    Apply black formatting to Python code and add pre-commit hook
    
    - reformat the whole swh-web Python codebase using black tool
    
    - add pre-commit hook to run black on all changed files
    
    - update flake8 configuration to match black code style
    
    - remove a lot of useless '# noqa' comments after new formatting
    
    - add black processing in tox

    Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/52/ See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/52/console

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    Update: Unblackify setup.py to check if build still fails

  • Software Heritage Continuous Integration for public repositories
    Software Heritage Continuous Integration for public repositories @swh-public-ci ·

    Build has FAILED

    Patch application report for D2981 (id=10601)

    Rebasing onto 2251dea5...

    Current branch diff-target is up to date.
    Changes applied before test
    commit a9a57aa42b018eb6340003d1ecdbfb5b1ff540bb
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed Apr 8 17:22:18 2020 +0200

    Apply black formatting to Python code and add pre-commit hook
    
    - reformat the whole swh-web Python codebase using black tool
    
    - add pre-commit hook to run black on all changed files
    
    - update flake8 configuration to match black code style
    
    - remove a lot of useless '# noqa' comments after new formatting
    
    - add black processing in tox

    Link to build: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/53/ See console output for more information: https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/53/console

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    Remove pyproject.toml file to check if it has side effect on build

  • Software Heritage Continuous Integration for public repositories
    Software Heritage Continuous Integration for public repositories @swh-public-ci ·

    Build is green

    Patch application report for D2981 (id=10606)

    Rebasing onto 2251dea5...

    Current branch diff-target is up to date.
    Changes applied before test
    commit cb9d52fa3de7bbd17e5011264454ffed921601b1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed Apr 8 17:22:18 2020 +0200

    Apply black formatting to Python code and add pre-commit hook
    
    - reformat the whole swh-web Python codebase using black tool
    
    - add pre-commit hook to run black on all changed files
    
    - update flake8 configuration to match black code style
    
    - remove a lot of useless '# noqa' comments after new formatting
    
    - add black processing in tox

    See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/56/ for more details.

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    ! In !287 (closed), @anlambert wrote: Remove pyproject.toml file to check if it has side effect on build

    Yep, that was the cause of the failing build.

  • Antoine Lambert
    Antoine Lambert @anlambert ·
    Author Maintainer

    Merge request was abandoned

  • Antoine Lambert closed

    closed

  • Phabricator Migration user mentioned in merge request !288 (closed)

    mentioned in merge request !288 (closed)

Please register or sign in to reply