Skip to main content

flake8 plugin which checks for misuse of `sys.version` or `sys.version_info`

Project description

Build Status Azure DevOps coverage

flake8-2020

flake8 plugin which checks for misuse of sys.version or sys.version_info

this will become a problem when python3.10 or python4.0 exists (presumably during the year 2020).

you might also find an early build of python3.10 useful

installation

pip install flake8-2020

flake8 codes

Code Description
YTT101 sys.version[:...] referenced (python3.10)
YTT102 sys.version[2] referenced (python3.10)
YTT103 sys.version compared to string (python3.10)
YTT201 sys.version_info[0] == 3 referenced (python4)
YTT202 six.PY3 referenced (python4)
YTT301 sys.version[0] referenced (python10)

rationale

lots of code incorrectly references the sys.version and sys.version_info members. in particular, this will cause some issues when the version of python after python3.9 is released. my current recommendation is 3.10 since I believe it breaks less code, here's a few patterns that will cause issues:

# in python3.10 this will report as '3.1' (should be '3.10')
python_version = sys.version[:3]  # YTT101
# in python3.10 this will report as '1' (should be '10')
py_minor = sys.version[2]
# in python3.10 this will be False (which goes against developer intention)
sys.version >= '3.5'  # YTT103


# correct way to do this
python_version = '{}.{}'.format(*sys.version_info)
py_minor = str(sys.version_info[1])
sys.version_info >= (3, 5)
# in python4 this will report as `False` (and suddenly run python2 code!)
is_py3 = sys.version_info[0] == 3  # YTT201

# in python4 this will report as `False` (six violates YTT201!)
if six.PY3:  # YTT202
    print('python3!')

# correct way to do this
is_py3 = sys.version_info >= (3,)

if not six.PY2:
    print('python3!')
# in python10 this will report as '1'
python_major_version = sys.version[0]  # YTT301

# correct way to do this
python_major_version = str(sys.version_info[0])

as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://gitlab.com/pycqa/flake8
    rev: 3.7.8
    hooks:
    -   id: flake8
        additional_dependencies: [flake8-2020==1.1.0]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_2020-1.1.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

flake8_2020-1.1.0-py2.py3-none-any.whl (4.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flake8_2020-1.1.0.tar.gz.

File metadata

  • Download URL: flake8_2020-1.1.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.6.8

File hashes

Hashes for flake8_2020-1.1.0.tar.gz
Algorithm Hash digest
SHA256 6be3a21ca2c54153e553ee5433a952b4d26a53a9ba4ae365d7cc8e2c41a0ba3c
MD5 799a825dd8d457184bc9746526f62de2
BLAKE2b-256 f85a7b13ae4d9fa995f9d9ccbc58dff1ad7ff4172d64fb6a5621a2ae4892f341

See more details on using hashes here.

Provenance

File details

Details for the file flake8_2020-1.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: flake8_2020-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.6.8

File hashes

Hashes for flake8_2020-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ffb25d09df6a53e255652a0ce4640f2c265b914ffcc8f454c0f9b7d0d4513fe8
MD5 8050e42b7529cbc331b1a092e45a8849
BLAKE2b-256 c722d1cc9587f9c63e92eb7777ab9f63c011899d4a44a842015cc3872daa91c5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page