name:pre-commit

on:

push:

branches:

-master

pull_request:

jobs:

pre-commit:

runs-on:ubuntu-20.04

steps:

-uses:actions/checkout@v2

with:

fetch-depth:0

-uses:actions/setup-python@v2

with:

python-version:3.9

-uses:pre-commit/action@v2.0.0

with:

token:${{ secrets.GITHUB_TOKEN }}

repos:

-repo:https://github.com/pre-commit/pre-commit-hooks

rev:v3.4.0

hooks:

-id:check-added-large-files

-id:check-case-conflict

-id:check-json

-id:check-merge-conflict

-id:check-symlinks

-id:check-toml

-repo:https://github.com/pycqa/isort

rev:5.8.0

hooks:

-id:isort

-repo:https://gitlab.com/pycqa/flake8

rev:3.9.0

hooks:

-id:flake8

additional_dependencies:

-flake8-tidy-imports

-{ python: "3.9", env: DJANGO=main }

-{ python: "3.8", env: TOXENV=base }

-{ python: "3.8", env: TOXENV=lint }

-{ python: "3.8", env: TOXENV=docs }

-python:"3.8"

Then clone your fork. The clone command will look like this, with your GitHub

username instead of YOUR-USERNAME:

See GitHub's[_Fork a Repo_][how-to-fork] Guide for more help.

Changes should broadly follow the[PEP 8][pep-8] style conventions, and we recommend you set up your editor to automatically indicate non-conforming styles.

You can check your contributions against these conventions each time you commit using the[pre-commit](https://pre-commit.com/) hooks, which we also run on CI.

To set them up, first ensure you have the pre-commit tool installed, for example:

Then run:

Run the tests using a more concise output style, no coverage, no flake8.

Don't run the flake8 code linting.

Only run the flake8 code linting, don't run the tests.

Run the tests for a given test case.

PYTEST_ARGS= {

'default': [],

'fast': ['-q'],

}

FLAKE8_ARGS= ['rest_framework','tests']

ISORT_ARGS= ['--check-only','--diff','rest_framework','tests']

defexit_on_failure(ret,message=None):

ifret:

sys.exit(ret)

defflake8_main(args):

print('Running flake8 code linting')

ret=subprocess.call(['flake8']+args)

print('flake8 failed'ifretelse'flake8 passed')

defisort_main(args):

print('Running isort code checking')

ret=subprocess.call(['isort']+args)

ifret:

print('isort failed: Some modules have incorrectly ordered imports. Fix by running `isort --recursive .`')

else:

print('isort passed')

defsplit_class_and_function(string):

class_string,function_string=string.split('.',1)

if__name__=="__main__":

try:

sys.argv.remove('--nolint')

exceptValueError:

else:

try:

sys.argv.remove('--lintonly')

exceptValueError:

else:

try:

sys.argv.remove('--fast')

exceptValueError:

else:

iflen(sys.argv)>1:

pytest_args=sys.argv[1:]

first_arg=pytest_args[0]

pytest_args= ['tests','-k',pytest_args[0]]+pytest_args[1:]

else:

pytest_args=PYTEST_ARGS[style]

ifrun_tests:

exit_on_failure(pytest.main(pytest_args))

ifrun_flake8:

exit_on_failure(flake8_main(FLAKE8_ARGS))

ifrun_isort:

exit_on_failure(isort_main(ISORT_ARGS))

sys.exit(pytest.main(pytest_args))

{py36,py37,py38,py39}-django31,

{py36,py37,py38,py39}-django32,

{py38,py39}-djangomain,

base,dist,lint,docs,

base,dist,docs,

DJANGO =

main: djangomain

commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --fast --coverage {posargs}

commands = python -W error::DeprecationWarning -W error::PendingDeprecationWarning runtests.py --coverage {posargs}

envdir = {toxworkdir}/venvs/{envname}

setenv =

PYTHONDONTWRITEBYTECODE=1

-rrequirements/requirements-testing.txt

commands = ./runtests.py --fast --no-pkgroot --staticfiles {posargs}

commands = ./runtests.py --no-pkgroot --staticfiles {posargs}

deps =

django

-rrequirements/requirements-testing.txt

-rrequirements/requirements-optionals.txt

commands = ./runtests.py --lintonly

deps =

-rrequirements/requirements-codestyle.txt

-rrequirements/requirements-testing.txt

skip_install = true

commands = mkdocs build