1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
import email.parser
import email.policy
from io import StringIO
from pathlib import Path
import pytest
from unittest import TestCase
from flit_core import config
from flit_core.common import (
Module, get_info_from_module, InvalidVersion, NoVersionError, check_version,
normalize_file_permissions, Metadata, make_metadata,
)
samples_dir = Path(__file__).parent / 'samples'
class ModuleTests(TestCase):
def test_ns_package_importable(self):
i = Module('ns1.pkg', samples_dir / 'ns1-pkg')
assert i.path == Path(samples_dir, 'ns1-pkg', 'ns1', 'pkg')
assert i.file == Path(samples_dir, 'ns1-pkg', 'ns1', 'pkg', '__init__.py')
assert i.is_package
assert i.in_namespace_package
assert i.namespace_package_name == 'ns1'
def test_package_importable(self):
i = Module('package1', samples_dir)
assert i.path == samples_dir / 'package1'
assert i.file == samples_dir / 'package1' / '__init__.py'
assert i.is_package
def test_module_importable(self):
i = Module('module1', samples_dir)
assert i.path == samples_dir / 'module1.py'
assert not i.is_package
def test_missing_name(self):
with self.assertRaises(ValueError):
i = Module('doesnt_exist', samples_dir)
def test_conflicting_modules(self):
with pytest.raises(ValueError, match="Multiple"):
Module('module1', samples_dir / 'conflicting_modules')
def test_get_info_from_module(self):
info = get_info_from_module(Module('module1', samples_dir))
self.assertEqual(info, {'summary': 'Example module',
'version': '0.1'}
)
info = get_info_from_module(Module('module2', samples_dir))
self.assertEqual(info, {'summary': 'Docstring formatted like this.',
'version': '7.0'}
)
pkg1 = Module('package1', samples_dir)
info = get_info_from_module(pkg1)
self.assertEqual(info, {'summary': 'A sample package',
'version': '0.1'}
)
info = get_info_from_module(pkg1, for_fields=['version'])
self.assertEqual(info, {'version': '0.1'})
info = get_info_from_module(pkg1, for_fields=['description'])
self.assertEqual(info, {'summary': 'A sample package'})
info = get_info_from_module(pkg1, for_fields=[])
self.assertEqual(info, {})
info = get_info_from_module(Module('moduleunimportable', samples_dir))
self.assertEqual(info, {'summary': 'A sample unimportable module',
'version': '0.1'}
)
info = get_info_from_module(Module('moduleunimportabledouble', samples_dir))
self.assertEqual(info, {'summary': 'A sample unimportable module with double assignment',
'version': '0.1'}
)
info = get_info_from_module(Module('module1', samples_dir / 'annotated_version'))
self.assertEqual(info, {'summary': 'This module has a __version__ that has a type annotation',
'version': '0.1'}
)
info = get_info_from_module(Module('module1', samples_dir / 'constructed_version'))
self.assertEqual(info, {'summary': 'This module has a __version__ that requires runtime interpretation',
'version': '1.2.3'}
)
info = get_info_from_module(Module('package1', samples_dir / 'imported_version'))
self.assertEqual(info, {'summary': 'This module has a __version__ that requires a relative import',
'version': '0.5.8'}
)
with self.assertRaises(InvalidVersion):
get_info_from_module(Module('invalid_version1', samples_dir))
def test_version_raise(self):
with pytest.raises(InvalidVersion):
check_version('a.1.0.beta0')
with pytest.raises(InvalidVersion):
check_version('3!')
with pytest.raises(InvalidVersion):
check_version((1, 2))
with pytest.raises(NoVersionError):
check_version(None)
assert check_version('4.1.0beta1') == '4.1.0b1'
assert check_version('v1.2') == '1.2'
def test_normalize_file_permissions():
assert normalize_file_permissions(0o100664) == 0o100644 # regular file
assert normalize_file_permissions(0o40775) == 0o40755 # directory
@pytest.mark.parametrize(
("requires_python", "expected_result"),
[
("", True),
(">2.7", True),
("3", False),
(">= 3.7", False),
("<4, > 3.2", False),
(">3.4", False),
(">=2.7, !=3.0.*, !=3.1.*, !=3.2.*", True),
("== 3.9", False),
("~=2.7", True),
("~=3.9", False),
],
)
def test_supports_py2(requires_python, expected_result):
metadata = object.__new__(Metadata)
metadata.requires_python = requires_python
result = metadata.supports_py2
assert result == expected_result
def test_make_metadata():
project_dir = samples_dir / 'pep621_nodynamic'
ini_info = config.read_flit_config(project_dir / 'pyproject.toml')
module = Module(ini_info.module, project_dir)
print(module.file)
md = make_metadata(module, ini_info)
assert md.version == '0.3'
assert md.summary == "Statically specified description"
def test_metadata_multiline(tmp_path):
d = {
'name': 'foo',
'version': '1.0',
# Example from: https://packaging.python.org/specifications/core-metadata/#author
'author': ('C. Schultz, Universal Features Syndicate\n'
'Los Angeles, CA <cschultz@peanuts.example.com>'),
}
md = Metadata(d)
sio = StringIO()
md.write_metadata_file(sio)
sio.seek(0)
msg = email.parser.Parser(policy=email.policy.compat32).parse(sio)
assert msg['Name'] == d['name']
assert msg['Version'] == d['version']
assert [l.lstrip() for l in msg['Author'].splitlines()] == d['author'].splitlines()
assert not msg.defects
@pytest.mark.parametrize(
("requires_dist", "expected_result"),
[
('foo [extra_1, extra.2, extra-3, extra__4, extra..5, extra--6]', 'foo [extra-1, extra-2, extra-3, extra-4, extra-5, extra-6]'),
('foo', 'foo'),
('foo[bar]', 'foo[bar]'),
# https://packaging.python.org/en/latest/specifications/core-metadata/#requires-dist-multiple-use
('pkginfo', 'pkginfo'),
('zope.interface (>3.5.0)', 'zope.interface (>3.5.0)'),
("pywin32 >1.0; sys_platform == 'win32'", "pywin32 >1.0; sys_platform == 'win32'"),
],
)
def test_metadata_2_3_requires_dist(requires_dist, expected_result):
d = {
'name': 'foo',
'version': '1.0',
'requires_dist': [requires_dist],
}
md = Metadata(d)
sio = StringIO()
md.write_metadata_file(sio)
sio.seek(0)
msg = email.parser.Parser(policy=email.policy.compat32).parse(sio)
assert msg['Requires-Dist'] == expected_result
assert not msg.defects
@pytest.mark.parametrize(
("provides_extra", "expected_result"),
[
('foo', 'foo'),
('foo__bar..baz', 'foo-bar-baz'),
],
)
def test_metadata_2_3_provides_extra(provides_extra, expected_result):
d = {
'name': 'foo',
'version': '1.0',
'provides_extra': [provides_extra],
}
md = Metadata(d)
sio = StringIO()
md.write_metadata_file(sio)
sio.seek(0)
msg = email.parser.Parser(policy=email.policy.compat32).parse(sio)
assert msg['Provides-Extra'] == expected_result
assert not msg.defects
@pytest.mark.parametrize(
('value', 'expected_license', 'expected_license_expression'),
[
({'license': 'MIT'}, 'MIT', None),
({'license': 'MIT OR Apache-2.0'}, 'MIT OR Apache-2.0', None),
({'license': 'MIT AND Apache-2.0'}, 'MIT AND Apache-2.0', None),
({'license_expression': 'MIT'}, None, 'MIT'),
({'license_expression': 'Apache-2.0'}, None, 'Apache-2.0'),
({'license_expression': 'MIT OR Apache-2.0'}, None, 'MIT OR Apache-2.0'),
({'license_expression': 'MIT AND Apache-2.0'}, None, 'MIT AND Apache-2.0'),
],
)
def test_metadata_license(value, expected_license, expected_license_expression):
d = {
'name': 'foo',
'version': '1.0',
**value,
}
md = Metadata(d)
sio = StringIO()
md.write_metadata_file(sio)
sio.seek(0)
msg = email.parser.Parser(policy=email.policy.compat32).parse(sio)
assert msg.get('License') == expected_license
assert msg.get('License-Expression') == expected_license_expression
assert not msg.defects
|