Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 1 | """Tests for distutils.command.build_py.""" |
| 2 | |
| 3 | import os |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 4 | import sys |
Éric Araujo | 47a4521 | 2011-10-08 00:34:13 +0200 | [diff] [blame] | 5 | import imp |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 6 | import unittest |
| 7 | |
| 8 | from distutils.command.build_py import build_py |
| 9 | from distutils.core import Distribution |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 10 | from distutils.errors import DistutilsFileError |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 11 | |
| 12 | from distutils.tests import support |
Éric Araujo | b344dd0 | 2011-02-02 21:38:37 +0000 | [diff] [blame] | 13 | from test.support import run_unittest |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 14 | |
| 15 | |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 16 | class BuildPyTestCase(support.TempdirManager, |
| 17 | support.LoggingSilencer, |
| 18 | unittest.TestCase): |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 19 | |
| 20 | def test_package_data(self): |
| 21 | sources = self.mkdtemp() |
| 22 | f = open(os.path.join(sources, "__init__.py"), "w") |
Éric Araujo | c6d7ead | 2010-11-06 02:58:56 +0000 | [diff] [blame] | 23 | try: |
| 24 | f.write("# Pretend this is a package.") |
| 25 | finally: |
| 26 | f.close() |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 27 | f = open(os.path.join(sources, "README.txt"), "w") |
Éric Araujo | c6d7ead | 2010-11-06 02:58:56 +0000 | [diff] [blame] | 28 | try: |
| 29 | f.write("Info about this package") |
| 30 | finally: |
| 31 | f.close() |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 32 | |
| 33 | destination = self.mkdtemp() |
| 34 | |
| 35 | dist = Distribution({"packages": ["pkg"], |
| 36 | "package_dir": {"pkg": sources}}) |
| 37 | # script_name need not exist, it just need to be initialized |
| 38 | dist.script_name = os.path.join(sources, "setup.py") |
| 39 | dist.command_obj["build"] = support.DummyCommand( |
| 40 | force=0, |
| 41 | build_lib=destination) |
| 42 | dist.packages = ["pkg"] |
| 43 | dist.package_data = {"pkg": ["README.txt"]} |
| 44 | dist.package_dir = {"pkg": sources} |
| 45 | |
| 46 | cmd = build_py(dist) |
Fred Drake | b3d55d3 | 2004-07-21 18:53:06 +0000 | [diff] [blame] | 47 | cmd.compile = 1 |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 48 | cmd.ensure_finalized() |
| 49 | self.assertEqual(cmd.package_data, dist.package_data) |
| 50 | |
| 51 | cmd.run() |
| 52 | |
Fred Drake | b3d55d3 | 2004-07-21 18:53:06 +0000 | [diff] [blame] | 53 | # This makes sure the list of outputs includes byte-compiled |
| 54 | # files for Python modules but not for package data files |
| 55 | # (there shouldn't *be* byte-code files for those!). |
Fred Drake | b3d55d3 | 2004-07-21 18:53:06 +0000 | [diff] [blame] | 56 | self.assertEqual(len(cmd.get_outputs()), 3) |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 57 | pkgdest = os.path.join(destination, "pkg") |
| 58 | files = os.listdir(pkgdest) |
Éric Araujo | 47a4521 | 2011-10-08 00:34:13 +0200 | [diff] [blame] | 59 | pycache_dir = os.path.join(pkgdest, "__pycache__") |
Éric Araujo | 489c8ff | 2011-05-28 23:32:50 +0200 | [diff] [blame] | 60 | self.assertIn("__init__.py", files) |
| 61 | self.assertIn("README.txt", files) |
Éric Araujo | 489c8ff | 2011-05-28 23:32:50 +0200 | [diff] [blame] | 62 | if sys.dont_write_bytecode: |
Éric Araujo | 47a4521 | 2011-10-08 00:34:13 +0200 | [diff] [blame] | 63 | self.assertFalse(os.path.exists(pycache_dir)) |
Éric Araujo | 489c8ff | 2011-05-28 23:32:50 +0200 | [diff] [blame] | 64 | else: |
Éric Araujo | 47a4521 | 2011-10-08 00:34:13 +0200 | [diff] [blame] | 65 | pyc_files = os.listdir(pycache_dir) |
| 66 | self.assertIn("__init__.%s.pyc" % imp.get_tag(), pyc_files) |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 67 | |
Éric Araujo | 489c8ff | 2011-05-28 23:32:50 +0200 | [diff] [blame] | 68 | def test_empty_package_dir(self): |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 69 | # See bugs #1668596/#1720897 |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 70 | sources = self.mkdtemp() |
| 71 | open(os.path.join(sources, "__init__.py"), "w").close() |
| 72 | |
| 73 | testdir = os.path.join(sources, "doc") |
| 74 | os.mkdir(testdir) |
| 75 | open(os.path.join(testdir, "testfile"), "w").close() |
| 76 | |
| 77 | os.chdir(sources) |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 78 | dist = Distribution({"packages": ["pkg"], |
| 79 | "package_dir": {"pkg": ""}, |
| 80 | "package_data": {"pkg": ["doc/*"]}}) |
| 81 | # script_name need not exist, it just need to be initialized |
| 82 | dist.script_name = os.path.join(sources, "setup.py") |
| 83 | dist.script_args = ["build"] |
| 84 | dist.parse_command_line() |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 85 | |
| 86 | try: |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 87 | dist.run_commands() |
| 88 | except DistutilsFileError: |
| 89 | self.fail("failed package_data test when package_dir is ''") |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 90 | |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 91 | @unittest.skipIf(sys.dont_write_bytecode, 'byte-compile disabled') |
| 92 | def test_byte_compile(self): |
| 93 | project_dir, dist = self.create_dist(py_modules=['boiledeggs']) |
| 94 | os.chdir(project_dir) |
| 95 | self.write_file('boiledeggs.py', 'import antigravity') |
| 96 | cmd = build_py(dist) |
| 97 | cmd.compile = 1 |
| 98 | cmd.build_lib = 'here' |
| 99 | cmd.finalize_options() |
| 100 | cmd.run() |
| 101 | |
| 102 | found = os.listdir(cmd.build_lib) |
| 103 | self.assertEqual(sorted(found), ['__pycache__', 'boiledeggs.py']) |
| 104 | found = os.listdir(os.path.join(cmd.build_lib, '__pycache__')) |
| 105 | self.assertEqual(found, ['boiledeggs.%s.pyc' % imp.get_tag()]) |
| 106 | |
| 107 | @unittest.skipIf(sys.dont_write_bytecode, 'byte-compile disabled') |
| 108 | def test_byte_compile_optimized(self): |
| 109 | project_dir, dist = self.create_dist(py_modules=['boiledeggs']) |
| 110 | os.chdir(project_dir) |
| 111 | self.write_file('boiledeggs.py', 'import antigravity') |
| 112 | cmd = build_py(dist) |
| 113 | cmd.compile = 0 |
| 114 | cmd.optimize = 1 |
| 115 | cmd.build_lib = 'here' |
| 116 | cmd.finalize_options() |
| 117 | cmd.run() |
| 118 | |
| 119 | found = os.listdir(cmd.build_lib) |
| 120 | self.assertEqual(sorted(found), ['__pycache__', 'boiledeggs.py']) |
| 121 | found = os.listdir(os.path.join(cmd.build_lib, '__pycache__')) |
| 122 | self.assertEqual(sorted(found), ['boiledeggs.%s.pyo' % imp.get_tag()]) |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 123 | |
Tarek Ziadé | c76bcea | 2009-10-25 23:16:51 +0000 | [diff] [blame] | 124 | def test_dont_write_bytecode(self): |
| 125 | # makes sure byte_compile is not used |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 126 | dist = self.create_dist()[1] |
Tarek Ziadé | c76bcea | 2009-10-25 23:16:51 +0000 | [diff] [blame] | 127 | cmd = build_py(dist) |
| 128 | cmd.compile = 1 |
| 129 | cmd.optimize = 1 |
| 130 | |
| 131 | old_dont_write_bytecode = sys.dont_write_bytecode |
| 132 | sys.dont_write_bytecode = True |
| 133 | try: |
| 134 | cmd.byte_compile([]) |
| 135 | finally: |
| 136 | sys.dont_write_bytecode = old_dont_write_bytecode |
| 137 | |
Éric Araujo | 489c8ff | 2011-05-28 23:32:50 +0200 | [diff] [blame] | 138 | self.assertIn('byte-compiling is disabled', self.logs[0][1]) |
Tarek Ziadé | c76bcea | 2009-10-25 23:16:51 +0000 | [diff] [blame] | 139 | |
Éric Araujo | c465b2f | 2011-11-03 03:45:33 +0100 | [diff] [blame] | 140 | |
Fred Drake | b849edd | 2004-06-17 20:16:19 +0000 | [diff] [blame] | 141 | def test_suite(): |
| 142 | return unittest.makeSuite(BuildPyTestCase) |
Fred Drake | 2202157 | 2004-06-25 19:04:21 +0000 | [diff] [blame] | 143 | |
| 144 | if __name__ == "__main__": |
Éric Araujo | b344dd0 | 2011-02-02 21:38:37 +0000 | [diff] [blame] | 145 | run_unittest(test_suite()) |