Add missing encoding to setuptools tests

Author: abravalheri

setuptools/tests/config/test_pyprojecttoml.py

@@ -174,7 +174,7 @@ class TestEntryPoints:
     def write_entry_points(self, tmp_path):
         entry_points = ConfigParser()
         entry_points.read_dict(ENTRY_POINTS)
-        with open(tmp_path / "entry-points.txt", "w") as f:
+        with open(tmp_path / "entry-points.txt", "w", encoding="utf-8") as f:
             entry_points.write(f)
 
     def pyproject(self, dynamic=None):

setuptools/tests/test_build_meta.py

@@ -296,7 +296,7 @@ def test_build_with_existing_file_present(self, build_type, tmpdir_cwd):
         first_result = build_method(dist_dir)
 
         # Change version.
-        with open("VERSION", "wt") as version_file:
+        with open("VERSION", "wt", encoding="utf-8") as version_file:
             version_file.write("0.0.2")
 
         # Build a *second* sdist/wheel.
@@ -306,7 +306,7 @@ def test_build_with_existing_file_present(self, build_type, tmpdir_cwd):
         assert first_result != second_result
 
         # And if rebuilding the exact same sdist/wheel?
-        open(os.path.join(dist_dir, second_result), 'w').close()
+        open(os.path.join(dist_dir, second_result), 'w', encoding="utf-8").close()
         third_result = build_method(dist_dir)
         assert third_result == second_result
         assert os.path.getsize(os.path.join(dist_dir, third_result)) > 0
@@ -568,9 +568,9 @@ def test_build_sdist_version_change(self, build_backend):
         if not os.path.exists(setup_loc):
             setup_loc = os.path.abspath("setup.cfg")
 
-        with open(setup_loc, 'rt') as file_handler:
+        with open(setup_loc, 'rt', encoding="utf-8") as file_handler:
             content = file_handler.read()
-        with open(setup_loc, 'wt') as file_handler:
+        with open(setup_loc, 'wt', encoding="utf-8") as file_handler:
             file_handler.write(content.replace("version='0.0.0'", "version='0.0.1'"))
 
         shutil.rmtree(sdist_into_directory)

setuptools/tests/test_build_py.py

@@ -49,7 +49,7 @@ def test_recursive_in_package_data_glob(tmpdir_cwd):
         )
     )
     os.makedirs('path/subpath/subsubpath')
-    open('path/subpath/subsubpath/data', 'w').close()
+    open('path/subpath/subsubpath/data', 'w', encoding="utf-8").close()
 
     dist.parse_command_line()
     dist.run_commands()
@@ -77,8 +77,8 @@ def test_read_only(tmpdir_cwd):
         )
     )
     os.makedirs('pkg')
-    open('pkg/__init__.py', 'w').close()
-    open('pkg/data.dat', 'w').close()
+    open('pkg/__init__.py', 'w', encoding="utf-8").close()
+    open('pkg/data.dat', 'w', encoding="utf-8").close()
     os.chmod('pkg/__init__.py', stat.S_IREAD)
     os.chmod('pkg/data.dat', stat.S_IREAD)
     dist.parse_command_line()
@@ -108,8 +108,8 @@ def test_executable_data(tmpdir_cwd):
         )
     )
     os.makedirs('pkg')
-    open('pkg/__init__.py', 'w').close()
-    open('pkg/run-me', 'w').close()
+    open('pkg/__init__.py', 'w', encoding="utf-8").close()
+    open('pkg/run-me', 'w', encoding="utf-8").close()
     os.chmod('pkg/run-me', 0o700)
 
     dist.parse_command_line()

setuptools/tests/test_config_discovery.py

@@ -591,7 +591,7 @@ def _write_setupcfg(root, options):
             setupcfg["options"][key] = "\n" + str_value
         else:
             setupcfg["options"][key] = str(value)
-    with open(root / "setup.cfg", "w") as f:
+    with open(root / "setup.cfg", "w", encoding="utf-8") as f:
         setupcfg.write(f)
     print("~~~~~ setup.cfg ~~~~~")
     print((root / "setup.cfg").read_text())

setuptools/tests/test_easy_install.py

@@ -467,7 +467,7 @@ def distutils_package():
         'from distutils.core import setup',
     )
     with contexts.tempdir(cd=os.chdir):
-        with open('setup.py', 'w') as f:
+        with open('setup.py', 'w', encoding="utf-8") as f:
             f.write(distutils_setup_py)
         yield
 
@@ -784,7 +784,7 @@ def test_setup_requires_honors_pip_env(self, mock_index, monkeypatch):
                     setup_attrs=dict(dependency_links=[]),
                 )
                 test_setup_cfg = os.path.join(test_pkg, 'setup.cfg')
-                with open(test_setup_cfg, 'w') as fp:
+                with open(test_setup_cfg, 'w', encoding="utf-8") as fp:
                     fp.write(
                         DALS(
                             """
@@ -918,7 +918,7 @@ def test_setup_requires_with_find_links_in_setup_cfg(
                 test_setup_py = os.path.join(test_pkg, 'setup.py')
                 test_setup_cfg = os.path.join(test_pkg, 'setup.cfg')
                 os.mkdir(test_pkg)
-                with open(test_setup_py, 'w') as fp:
+                with open(test_setup_py, 'w', encoding="utf-8") as fp:
                     if with_dependency_links_in_setup_py:
                         dependency_links = [os.path.join(temp_dir, 'links')]
                     else:
@@ -932,7 +932,7 @@ def test_setup_requires_with_find_links_in_setup_cfg(
                         """
                         ).format(dependency_links=dependency_links)
                     )
-                with open(test_setup_cfg, 'w') as fp:
+                with open(test_setup_cfg, 'w', encoding="utf-8") as fp:
                     fp.write(
                         DALS(
                             """
@@ -984,7 +984,7 @@ def test_setup_requires_with_transitive_extra_dependency(self, monkeypatch):
                 test_pkg = os.path.join(temp_dir, 'test_pkg')
                 test_setup_py = os.path.join(test_pkg, 'setup.py')
                 os.mkdir(test_pkg)
-                with open(test_setup_py, 'w') as fp:
+                with open(test_setup_py, 'w', encoding="utf-8") as fp:
                     fp.write(
                         DALS(
                             """
@@ -1068,7 +1068,7 @@ class epcmd(build_py):
                 test_pkg = os.path.join(temp_dir, 'test_pkg')
                 test_setup_py = os.path.join(test_pkg, 'setup.py')
                 os.mkdir(test_pkg)
-                with open(test_setup_py, 'w') as fp:
+                with open(test_setup_py, 'w', encoding="utf-8") as fp:
                     fp.write(
                         DALS(
                             """
@@ -1244,7 +1244,7 @@ def create_setup_requires_package(
         )
     else:
         test_setup_cfg_contents = ''
-    with open(os.path.join(test_pkg, 'setup.cfg'), 'w') as f:
+    with open(os.path.join(test_pkg, 'setup.cfg'), 'w', encoding="utf-8") as f:
         f.write(test_setup_cfg_contents)
 
     # setup.py
@@ -1255,7 +1255,7 @@ def create_setup_requires_package(
             setuptools.setup(**%r)
         """
         )
-    with open(os.path.join(test_pkg, 'setup.py'), 'w') as f:
+    with open(os.path.join(test_pkg, 'setup.py'), 'w', encoding="utf-8") as f:
         f.write(setup_py_template % test_setup_attrs)
 
     foobar_path = os.path.join(path, '%s-%s.tar.gz' % (distname, version))

setuptools/tests/test_egg_info.py

@@ -94,7 +94,7 @@ def test_egg_info_save_version_info_setup_empty(self, tmpdir_cwd, env):
         ei.initialize_options()
         ei.save_version_info(setup_cfg)
 
-        with open(setup_cfg, 'r') as f:
+        with open(setup_cfg, 'r', encoding="utf-8") as f:
             content = f.read()
 
         assert '[egg_info]' in content
@@ -139,7 +139,7 @@ def test_egg_info_save_version_info_setup_defaults(self, tmpdir_cwd, env):
         ei.initialize_options()
         ei.save_version_info(setup_cfg)
 
-        with open(setup_cfg, 'r') as f:
+        with open(setup_cfg, 'r', encoding="utf-8") as f:
             content = f.read()
 
         assert '[egg_info]' in content
@@ -251,7 +251,7 @@ def test_manifest_template_is_read(self, tmpdir_cwd, env):
         self._run_egg_info_command(tmpdir_cwd, env)
         egg_info_dir = os.path.join('.', 'foo.egg-info')
         sources_txt = os.path.join(egg_info_dir, 'SOURCES.txt')
-        with open(sources_txt) as f:
+        with open(sources_txt, encoding="utf-8") as f:
             assert 'docs/usage.rst' in f.read().split('\n')
 
     def _setup_script_with_requires(self, requires, use_setup_cfg=False):
@@ -492,7 +492,7 @@ def test_requires(
         egg_info_dir = os.path.join('.', 'foo.egg-info')
         requires_txt = os.path.join(egg_info_dir, 'requires.txt')
         if os.path.exists(requires_txt):
-            with open(requires_txt) as fp:
+            with open(requires_txt, encoding="utf-8") as fp:
                 install_requires = fp.read()
         else:
             install_requires = ''
@@ -538,7 +538,7 @@ def test_provides_extra(self, tmpdir_cwd, env):
             env=environ,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         assert 'Provides-Extra: foobar' in pkg_info_lines
         assert 'Metadata-Version: 2.1' in pkg_info_lines
@@ -557,7 +557,7 @@ def test_doesnt_provides_extra(self, tmpdir_cwd, env):
             env=environ,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_text = pkginfo_file.read()
         assert 'Provides-Extra:' not in pkg_info_text
 
@@ -636,7 +636,7 @@ def test_setup_cfg_license_file(self, tmpdir_cwd, env, files, license_in_sources
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
 
-        with open(os.path.join(egg_info_dir, 'SOURCES.txt')) as sources_file:
+        with open(os.path.join(egg_info_dir, 'SOURCES.txt'), encoding="utf-8") as sources_file:
             sources_text = sources_file.read()
 
         if license_in_sources:
@@ -849,7 +849,7 @@ def test_setup_cfg_license_files(
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
 
-        with open(os.path.join(egg_info_dir, 'SOURCES.txt')) as sources_file:
+        with open(os.path.join(egg_info_dir, 'SOURCES.txt'), encoding="utf-8") as sources_file:
             sources_lines = list(line.strip() for line in sources_file)
 
         for lf in incl_licenses:
@@ -1033,7 +1033,7 @@ def test_setup_cfg_license_file_license_files(
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
 
-        with open(os.path.join(egg_info_dir, 'SOURCES.txt')) as sources_file:
+        with open(os.path.join(egg_info_dir, 'SOURCES.txt'), encoding="utf-8") as sources_file:
             sources_lines = list(line.strip() for line in sources_file)
 
         for lf in incl_licenses:
@@ -1065,7 +1065,7 @@ def test_license_file_attr_pkg_info(self, tmpdir_cwd, env):
             pypath=os.pathsep.join([env.paths['lib'], str(tmpdir_cwd)]),
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         license_file_lines = [
             line for line in pkg_info_lines if line.startswith('License-File:')
@@ -1086,7 +1086,7 @@ def test_metadata_version(self, tmpdir_cwd, env):
             data_stream=1,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         # Update metadata version if changed
         assert self._extract_mv_version(pkg_info_lines) == (2, 1)
@@ -1112,7 +1112,7 @@ def test_long_description_content_type(self, tmpdir_cwd, env):
             env=environ,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         expected_line = 'Description-Content-Type: text/markdown'
         assert expected_line in pkg_info_lines
@@ -1133,7 +1133,7 @@ def test_long_description(self, tmpdir_cwd, env):
             data_stream=1,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         assert 'Metadata-Version: 2.1' in pkg_info_lines
         assert '' == pkg_info_lines[-1]  # last line should be empty
@@ -1165,7 +1165,7 @@ def test_project_urls(self, tmpdir_cwd, env):
             env=environ,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         expected_line = 'Project-URL: Link One, https://example.com/one/'
         assert expected_line in pkg_info_lines
@@ -1182,7 +1182,7 @@ def test_license(self, tmpdir_cwd, env):
             data_stream=1,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         assert 'License: MIT' in pkg_info_lines
 
@@ -1197,7 +1197,7 @@ def test_license_escape(self, tmpdir_cwd, env):
             data_stream=1,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
 
         assert 'License: This is a long license text ' in pkg_info_lines
@@ -1216,7 +1216,7 @@ def test_python_requires_egg_info(self, tmpdir_cwd, env):
             env=environ,
         )
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         assert 'Requires-Python: >=2.7.12' in pkg_info_lines
         assert self._extract_mv_version(pkg_info_lines) >= (1, 2)
@@ -1240,7 +1240,7 @@ def test_egg_info_includes_setup_py(self, tmpdir_cwd):
 
         assert 'setup.py' in egg_info_instance.filelist.files
 
-        with open(egg_info_instance.egg_info + "/SOURCES.txt") as f:
+        with open(egg_info_instance.egg_info + "/SOURCES.txt", encoding="utf-8") as f:
             sources = f.read().split('\n')
             assert 'setup.py' in sources
 
@@ -1277,7 +1277,7 @@ def test_egg_info_tag_only_once(self, tmpdir_cwd, env):
         })
         self._run_egg_info_command(tmpdir_cwd, env)
         egg_info_dir = os.path.join('.', 'foo.egg-info')
-        with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file:
+        with open(os.path.join(egg_info_dir, 'PKG-INFO'), encoding="utf-8") as pkginfo_file:
             pkg_info_lines = pkginfo_file.read().split('\n')
         assert 'Version: 0.0.0.dev0' in pkg_info_lines
 

setuptools/tests/test_find_packages.py

@@ -72,8 +72,7 @@ def _mkdir(self, path, parent_dir=None):
     def _touch(self, path, dir_=None):
         if dir_:
             path = os.path.join(dir_, path)
-        fp = open(path, 'w')
-        fp.close()
+        open(path, 'wb').close()
         return path
 
     def test_regular_package(self):

setuptools/tests/test_install_scripts.py

@@ -41,7 +41,7 @@ def test_sys_executable_escaping_unix(self, tmpdir, monkeypatch):
         monkeypatch.setattr('sys.executable', self.unix_exe)
         with tmpdir.as_cwd():
             self._run_install_scripts(str(tmpdir))
-            with open(str(tmpdir.join('foo')), 'r') as f:
+            with open(str(tmpdir.join('foo')), 'r', encoding="utf-8") as f:
                 actual = f.readline()
         assert actual == expected
 
@@ -55,7 +55,7 @@ def test_sys_executable_escaping_win32(self, tmpdir, monkeypatch):
         monkeypatch.setattr('sys.executable', self.win32_exe)
         with tmpdir.as_cwd():
             self._run_install_scripts(str(tmpdir))
-            with open(str(tmpdir.join('foo-script.py')), 'r') as f:
+            with open(str(tmpdir.join('foo-script.py')), 'r', encoding="utf-8") as f:
                 actual = f.readline()
         assert actual == expected
 
@@ -69,7 +69,7 @@ def test_executable_with_spaces_escaping_unix(self, tmpdir):
         expected = '#!%s\n' % self.unix_spaces_exe
         with tmpdir.as_cwd():
             self._run_install_scripts(str(tmpdir), self.unix_spaces_exe)
-            with open(str(tmpdir.join('foo')), 'r') as f:
+            with open(str(tmpdir.join('foo')), 'r', encoding="utf-8") as f:
                 actual = f.readline()
         assert actual == expected
 
@@ -83,6 +83,6 @@ def test_executable_arg_escaping_win32(self, tmpdir):
         expected = '#!"%s"\n' % self.win32_exe
         with tmpdir.as_cwd():
             self._run_install_scripts(str(tmpdir), '"' + self.win32_exe + '"')
-            with open(str(tmpdir.join('foo-script.py')), 'r') as f:
+            with open(str(tmpdir.join('foo-script.py')), 'r', encoding="utf-8") as f:
                 actual = f.readline()
         assert actual == expected