Fix invalid Python file encoding "utf8" (#5252)

Fix invalid Python file encoding "utf8"

.pre-commit-config.yaml

@@ -13,10 +13,11 @@ repos:
         additional_dependencies: [black==19.3b0]
         language_version: python3
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
+    rev: v2.2.2
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
+    -   id: fix-encoding-pragma
     -   id: check-yaml
     -   id: debug-statements
         exclude: _pytest/debugging.py

bench/bench.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import sys
 
 if __name__ == "__main__":

bench/bench_argcomplete.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # 10000 iterations, just for relative comparison
 #                      2.7.5     3.3.2
 # FilesCompleter       75.1109   69.2116

bench/empty.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 for i in range(1000):
     exec("def test_func_%d(): pass" % i)

bench/manyparam.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 

bench/skip.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from six.moves import range
 
 import pytest

doc/en/_themes/flask_theme_support.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # flasky extensions.  flasky pygments style based on tango style
 from pygments.style import Style
 from pygments.token import Comment

doc/en/conftest.py

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 collect_ignore = ["conf.py"]

doc/en/example/assertion/failure_demo.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import _pytest._code
 import pytest
 from pytest import raises

doc/en/example/assertion/global_testmodule_config/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import py
 
 import pytest

doc/en/example/assertion/global_testmodule_config/test_hello_world.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 hello = "world"
 
 

doc/en/example/assertion/test_failures.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import py
 
 failure_demo = py.path.local(__file__).dirpath("failure_demo.py")

doc/en/example/assertion/test_setup_flow_example.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 def setup_module(module):
     module.TestStateFullThing.classcount = 0
 

doc/en/example/conftest.py

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 collect_ignore = ["nonpython"]

doc/en/example/costlysetup/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 

doc/en/example/costlysetup/sub_a/__init__.py

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 #

doc/en/example/costlysetup/sub_a/test_quick.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test_quick(setup):
     pass

doc/en/example/costlysetup/sub_b/__init__.py

@@ -1 +1,2 @@
+# -*- coding: utf-8 -*-
 #

doc/en/example/costlysetup/sub_b/test_two.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 def test_something(setup):
     assert setup.timecostly == 1
 

doc/en/example/multipython.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 module containing a parametrized tests testing cross-python
 serialization via the pickle module.

doc/en/example/nonpython/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # content of conftest.py
 import pytest
 

doc/en/example/py2py3/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import sys
 
 import pytest

doc/en/example/py2py3/test_py3.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 def test_exception_syntax():
     try:
         0 / 0

doc/en/example/pythoncollection.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # run this with $ pytest --collect-only test_collectonly.py
 #
 

doc/en/example/xfail_demo.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 xfail = pytest.mark.xfail

extra/get_issues.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import json
 
 import py

extra/setup-py.test/setup.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import sys
 from distutils.core import setup
 

scripts/release.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 Invoke development tasks.
 """

setup.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from setuptools import setup
 
 # TODO: if py gets upgrade to >=1.6,

src/_pytest/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 __all__ = ["__version__"]
 
 try:

src/_pytest/_argcomplete.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """allow bash-completion for argparse with argcomplete if installed
 needs argcomplete>=0.5.6 for python 3.2/3.3 (older versions fail
 to find the magic string, so _ARGCOMPLETE env. var is never set, and

src/_pytest/_code/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ python inspection/code generation API """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/_code/_py2traceback.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # copied from python-2.7.3's traceback.py
 # CHANGES:
 # - some_str is replaced, trying to create unicode strings

src/_pytest/_code/code.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/_code/source.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/_io/saferepr.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pprint
 
 from six.moves import reprlib

src/_pytest/assertion/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 support for presenting detailed information in failing assertions.
 """

src/_pytest/assertion/rewrite.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """Rewrite assertion AST to produce nice error messages"""
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/assertion/truncate.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 Utilities for truncating assertion output.
 

src/_pytest/assertion/util.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """Utilities for assertion debugging"""
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/cacheprovider.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 merged implementation of the cache provider
 

src/_pytest/capture.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 per-test stdout/stderr capturing mechanism.
 

src/_pytest/compat.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 python version compatibility code
 """

src/_pytest/config/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ command line options, ini-file and conftest.py processing. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/config/argparsing.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import argparse
 import warnings
 

src/_pytest/config/exceptions.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 class UsageError(Exception):
     """ error in pytest usage or invocation"""
 

src/_pytest/config/findpaths.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import os
 
 import py

src/_pytest/debugging.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ interactive debugging with PDB, the Python Debugger. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/deprecated.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 This module contains deprecation messages and bits of code used elsewhere in the codebase
 that is planned to be removed in the next pytest release.

src/_pytest/doctest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ discover and run doctests in modules and test files."""
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/fixtures.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/freeze_support.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 Provides a function to report all internal modules for using freezing tools
 pytest

src/_pytest/helpconfig.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ version info, help messages, tracing configuration.  """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/hookspec.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ hook specifications for pytest plugins, invoked from main.py and builtin plugins.  """
 from pluggy import HookspecMarker
 

src/_pytest/junitxml.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
     report test results in JUnit-XML format,
     for use with Jenkins and build integration servers.

src/_pytest/logging.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ Access and control log capturing. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/main.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ core implementation of testing process: init, session, runtest loop. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/mark/__init__.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ generic mechanism for marking and selecting python functions. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/mark/evaluate.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import os
 import platform
 import sys

src/_pytest/mark/legacy.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 this is a place where we put datastructures used by legacy apis
 we hope ot remove

src/_pytest/mark/structures.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import inspect
 import warnings
 from collections import namedtuple

src/_pytest/monkeypatch.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ monkeypatching and mocking functionality.  """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/nodes.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/nose.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ run test suites written for nose. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/outcomes.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 exception classes and constants handling test outcomes
 as well as functions creating them

src/_pytest/pastebin.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ submit failure or test session information to a pastebin service. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/pathlib.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import atexit
 import errno
 import fnmatch

src/_pytest/pytester.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """(disabled by default) support for testing pytest and pytest plugins."""
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/python.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ Python test discovery, setup and run of test functions. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/python_api.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
 import math

src/_pytest/recwarn.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ recording warnings during test function execution. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/reports.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from pprint import pprint
 
 import py

src/_pytest/resultlog.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ log machine-parseable test session result information in a plain
 text file.
 """

src/_pytest/runner.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ basic collect and runtest protocol implementations """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/setuponly.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/setupplan.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/_pytest/skipping.py

@@ -1,4 +1,4 @@
-# coding=utf8
+# -*- coding: utf-8 -*-
 """ support for skip/xfail functions and markers. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/stepwise.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 

src/_pytest/terminal.py

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 """ terminal reporting of the full testing process.
 
 This is a good source for looking at the various reporting hooks.

src/_pytest/tmpdir.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ support for providing temporary directories to test functions.  """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/unittest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """ discovery and running of std-library "unittest" style tests. """
 from __future__ import absolute_import
 from __future__ import division

src/_pytest/warning_types.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import attr
 
 

src/_pytest/warnings.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

src/pytest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # PYTHON_ARGCOMPLETE_OK
 """
 pytest: unit and functional testing with Python.

testing/code/test_code.py

@@ -1,4 +1,4 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

testing/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 import pytest
 
 

testing/deprecated_test.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function

testing/example_scripts/acceptance/fixture_mock_integration.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """Reproduces issue #3774"""
 
 try:

testing/example_scripts/collect/collect_init_tests/tests/__init__.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test_init():
     pass

testing/example_scripts/collect/collect_init_tests/tests/test_foo.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test_foo():
     pass

testing/example_scripts/collect/package_infinite_recursion/conftest.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def pytest_ignore_collect(path):
     return False

testing/example_scripts/collect/package_infinite_recursion/tests/test_basic.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test():
     pass

testing/example_scripts/collect/package_init_given_as_arg/pkg/test_foo.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test():
     pass

testing/example_scripts/config/collect_pytest_prefix/conftest.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 class pytest_something(object):
     pass

testing/example_scripts/config/collect_pytest_prefix/test_foo.py

@@ -1,2 +1,3 @@
+# -*- coding: utf-8 -*-
 def test_foo():
     pass

testing/example_scripts/conftest_usageerror/conftest.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 def pytest_configure(config):
     import pytest
 

testing/example_scripts/dataclasses/test_compare_dataclasses.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from dataclasses import dataclass
 from dataclasses import field
 

testing/example_scripts/dataclasses/test_compare_dataclasses_field_comparison_off.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from dataclasses import dataclass
 from dataclasses import field
 

testing/example_scripts/dataclasses/test_compare_dataclasses_verbose.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from dataclasses import dataclass
 from dataclasses import field
 

testing/example_scripts/dataclasses/test_compare_two_different_dataclasses.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from dataclasses import dataclass
 from dataclasses import field