Skip to main content
https://travis-ci.org/tk0miya/flake8-coding.svg?branch=master https://coveralls.io/repos/tk0miya/flake8-coding/badge.png?branch=master Code Climate

Adds coding magic comment checks (coding:) to flake8.

Install

Install with pip:

$ pip install flake8-coding

You can check that flake8 has picked it up by looking for flake8_coding in the output of --version:

$ flake8 --version
2.5.4 (pep8: 1.7.0, pyflakes: 1.0.0, flake8_coding: 1.1.1, mccabe: 0.4.0) CPython 2.7.11 on Darwin

Options

accept-encodings

A comma-separated list of acceptable source code encodings for the coding: magic comments in files. Default is latin-1, utf-8.

You can pass this as a command-line argument to flake8, e.g. --accept-encodings=utf-8,utf-16, or put it in your config file, e.g.:

[flake8]
accept-encodings = utf-8,utf-16

no-accept-encodings

If activated, this disallows all coding: magic comments, no matter their encoding. This might be useful for Python 3 projects where UTF-8 is the default and you don’t want other encodings used in your project.

You can pass this as a command-line argument to flake8, e.g. --no-accept-encodings, or put it in your config file, e.g.:

[flake8]
no-accept-encodings

Rules

C101 Coding magic comment not found

No magic encoding comment was found in the file. As per PEP-263, this must be in the first two lines of the file.

C102 Unknown encoding found in coding magic comment

The encoding found in the magic encoding comment did not match the accept-encodings option.

C103 Coding magic comment present

no-accept-encodings is set, and a magic encoding comment was found in the file.

Requirements

  • Python 2.6, 2.7, 3.3, 3.4

  • flake8

License

Apache License 2.0

Download files

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

Source Distribution

flake8-coding-1.2.0.tar.gz (7.3 kB view details)

Uploaded Source

File details

Details for the file flake8-coding-1.2.0.tar.gz.

File metadata

  • Download URL: flake8-coding-1.2.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for flake8-coding-1.2.0.tar.gz
Algorithm Hash digest
SHA256 cd4f41a922e65f92b0613dc130555c5edd0bb1787fd0a1eb9219866433cc70cf
MD5 de2ec4bb9ea7842b9ae2b6fea3b083c7
BLAKE2b-256 cfa5f5231922f5d3ec7c98379b9f1b1cb12c6570e7dddcef4114aa9a131c650b

See more details on using hashes here.

Supported by

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