test_setupcfg.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980
  1. import configparser
  2. import contextlib
  3. import inspect
  4. import re
  5. from pathlib import Path
  6. from unittest.mock import Mock, patch
  7. import pytest
  8. from packaging.requirements import InvalidRequirement
  9. from setuptools.config.setupcfg import ConfigHandler, Target, read_configuration
  10. from setuptools.dist import Distribution, _Distribution
  11. from setuptools.warnings import SetuptoolsDeprecationWarning
  12. from ..textwrap import DALS
  13. from distutils.errors import DistutilsFileError, DistutilsOptionError
  14. class ErrConfigHandler(ConfigHandler[Target]):
  15. """Erroneous handler. Fails to implement required methods."""
  16. section_prefix = "**err**"
  17. def make_package_dir(name, base_dir, ns=False):
  18. dir_package = base_dir
  19. for dir_name in name.split('/'):
  20. dir_package = dir_package.mkdir(dir_name)
  21. init_file = None
  22. if not ns:
  23. init_file = dir_package.join('__init__.py')
  24. init_file.write('')
  25. return dir_package, init_file
  26. def fake_env(
  27. tmpdir, setup_cfg, setup_py=None, encoding='ascii', package_path='fake_package'
  28. ):
  29. if setup_py is None:
  30. setup_py = 'from setuptools import setup\nsetup()\n'
  31. tmpdir.join('setup.py').write(setup_py)
  32. config = tmpdir.join('setup.cfg')
  33. config.write(setup_cfg.encode(encoding), mode='wb')
  34. package_dir, init_file = make_package_dir(package_path, tmpdir)
  35. init_file.write(
  36. 'VERSION = (1, 2, 3)\n'
  37. '\n'
  38. 'VERSION_MAJOR = 1'
  39. '\n'
  40. 'def get_version():\n'
  41. ' return [3, 4, 5, "dev"]\n'
  42. '\n'
  43. )
  44. return package_dir, config
  45. @contextlib.contextmanager
  46. def get_dist(tmpdir, kwargs_initial=None, parse=True):
  47. kwargs_initial = kwargs_initial or {}
  48. with tmpdir.as_cwd():
  49. dist = Distribution(kwargs_initial)
  50. dist.script_name = 'setup.py'
  51. parse and dist.parse_config_files()
  52. yield dist
  53. def test_parsers_implemented():
  54. with pytest.raises(NotImplementedError):
  55. handler = ErrConfigHandler(None, {}, False, Mock())
  56. handler.parsers
  57. class TestConfigurationReader:
  58. def test_basic(self, tmpdir):
  59. _, config = fake_env(
  60. tmpdir,
  61. '[metadata]\n'
  62. 'version = 10.1.1\n'
  63. 'keywords = one, two\n'
  64. '\n'
  65. '[options]\n'
  66. 'scripts = bin/a.py, bin/b.py\n',
  67. )
  68. config_dict = read_configuration(str(config))
  69. assert config_dict['metadata']['version'] == '10.1.1'
  70. assert config_dict['metadata']['keywords'] == ['one', 'two']
  71. assert config_dict['options']['scripts'] == ['bin/a.py', 'bin/b.py']
  72. def test_no_config(self, tmpdir):
  73. with pytest.raises(DistutilsFileError):
  74. read_configuration(str(tmpdir.join('setup.cfg')))
  75. def test_ignore_errors(self, tmpdir):
  76. _, config = fake_env(
  77. tmpdir,
  78. '[metadata]\nversion = attr: none.VERSION\nkeywords = one, two\n',
  79. )
  80. with pytest.raises(ImportError):
  81. read_configuration(str(config))
  82. config_dict = read_configuration(str(config), ignore_option_errors=True)
  83. assert config_dict['metadata']['keywords'] == ['one', 'two']
  84. assert 'version' not in config_dict['metadata']
  85. config.remove()
  86. class TestMetadata:
  87. def test_basic(self, tmpdir):
  88. fake_env(
  89. tmpdir,
  90. '[metadata]\n'
  91. 'version = 10.1.1\n'
  92. 'description = Some description\n'
  93. 'long_description_content_type = text/something\n'
  94. 'long_description = file: README\n'
  95. 'name = fake_name\n'
  96. 'keywords = one, two\n'
  97. 'provides = package, package.sub\n'
  98. 'license = otherlic\n'
  99. 'download_url = http://test.test.com/test/\n'
  100. 'maintainer_email = test@test.com\n',
  101. )
  102. tmpdir.join('README').write('readme contents\nline2')
  103. meta_initial = {
  104. # This will be used so `otherlic` won't replace it.
  105. 'license': 'BSD 3-Clause License',
  106. }
  107. with get_dist(tmpdir, meta_initial) as dist:
  108. metadata = dist.metadata
  109. assert metadata.version == '10.1.1'
  110. assert metadata.description == 'Some description'
  111. assert metadata.long_description_content_type == 'text/something'
  112. assert metadata.long_description == 'readme contents\nline2'
  113. assert metadata.provides == ['package', 'package.sub']
  114. assert metadata.license == 'BSD 3-Clause License'
  115. assert metadata.name == 'fake_name'
  116. assert metadata.keywords == ['one', 'two']
  117. assert metadata.download_url == 'http://test.test.com/test/'
  118. assert metadata.maintainer_email == 'test@test.com'
  119. def test_license_cfg(self, tmpdir):
  120. fake_env(
  121. tmpdir,
  122. DALS(
  123. """
  124. [metadata]
  125. name=foo
  126. version=0.0.1
  127. license=Apache 2.0
  128. """
  129. ),
  130. )
  131. with get_dist(tmpdir) as dist:
  132. metadata = dist.metadata
  133. assert metadata.name == "foo"
  134. assert metadata.version == "0.0.1"
  135. assert metadata.license == "Apache 2.0"
  136. def test_file_mixed(self, tmpdir):
  137. fake_env(
  138. tmpdir,
  139. '[metadata]\nlong_description = file: README.rst, CHANGES.rst\n\n',
  140. )
  141. tmpdir.join('README.rst').write('readme contents\nline2')
  142. tmpdir.join('CHANGES.rst').write('changelog contents\nand stuff')
  143. with get_dist(tmpdir) as dist:
  144. assert dist.metadata.long_description == (
  145. 'readme contents\nline2\nchangelog contents\nand stuff'
  146. )
  147. def test_file_sandboxed(self, tmpdir):
  148. tmpdir.ensure("README")
  149. project = tmpdir.join('depth1', 'depth2')
  150. project.ensure(dir=True)
  151. fake_env(project, '[metadata]\nlong_description = file: ../../README\n')
  152. with get_dist(project, parse=False) as dist:
  153. with pytest.raises(DistutilsOptionError):
  154. dist.parse_config_files() # file: out of sandbox
  155. def test_aliases(self, tmpdir):
  156. fake_env(
  157. tmpdir,
  158. '[metadata]\n'
  159. 'author_email = test@test.com\n'
  160. 'home_page = http://test.test.com/test/\n'
  161. 'summary = Short summary\n'
  162. 'platform = a, b\n'
  163. 'classifier =\n'
  164. ' Framework :: Django\n'
  165. ' Programming Language :: Python :: 3.5\n',
  166. )
  167. with get_dist(tmpdir) as dist:
  168. metadata = dist.metadata
  169. assert metadata.author_email == 'test@test.com'
  170. assert metadata.url == 'http://test.test.com/test/'
  171. assert metadata.description == 'Short summary'
  172. assert metadata.platforms == ['a', 'b']
  173. assert metadata.classifiers == [
  174. 'Framework :: Django',
  175. 'Programming Language :: Python :: 3.5',
  176. ]
  177. def test_multiline(self, tmpdir):
  178. fake_env(
  179. tmpdir,
  180. '[metadata]\n'
  181. 'name = fake_name\n'
  182. 'keywords =\n'
  183. ' one\n'
  184. ' two\n'
  185. 'classifiers =\n'
  186. ' Framework :: Django\n'
  187. ' Programming Language :: Python :: 3.5\n',
  188. )
  189. with get_dist(tmpdir) as dist:
  190. metadata = dist.metadata
  191. assert metadata.keywords == ['one', 'two']
  192. assert metadata.classifiers == [
  193. 'Framework :: Django',
  194. 'Programming Language :: Python :: 3.5',
  195. ]
  196. def test_dict(self, tmpdir):
  197. fake_env(
  198. tmpdir,
  199. '[metadata]\n'
  200. 'project_urls =\n'
  201. ' Link One = https://example.com/one/\n'
  202. ' Link Two = https://example.com/two/\n',
  203. )
  204. with get_dist(tmpdir) as dist:
  205. metadata = dist.metadata
  206. assert metadata.project_urls == {
  207. 'Link One': 'https://example.com/one/',
  208. 'Link Two': 'https://example.com/two/',
  209. }
  210. def test_version(self, tmpdir):
  211. package_dir, config = fake_env(
  212. tmpdir, '[metadata]\nversion = attr: fake_package.VERSION\n'
  213. )
  214. sub_a = package_dir.mkdir('subpkg_a')
  215. sub_a.join('__init__.py').write('')
  216. sub_a.join('mod.py').write('VERSION = (2016, 11, 26)')
  217. sub_b = package_dir.mkdir('subpkg_b')
  218. sub_b.join('__init__.py').write('')
  219. sub_b.join('mod.py').write(
  220. 'import third_party_module\nVERSION = (2016, 11, 26)'
  221. )
  222. with get_dist(tmpdir) as dist:
  223. assert dist.metadata.version == '1.2.3'
  224. config.write('[metadata]\nversion = attr: fake_package.get_version\n')
  225. with get_dist(tmpdir) as dist:
  226. assert dist.metadata.version == '3.4.5.dev'
  227. config.write('[metadata]\nversion = attr: fake_package.VERSION_MAJOR\n')
  228. with get_dist(tmpdir) as dist:
  229. assert dist.metadata.version == '1'
  230. config.write('[metadata]\nversion = attr: fake_package.subpkg_a.mod.VERSION\n')
  231. with get_dist(tmpdir) as dist:
  232. assert dist.metadata.version == '2016.11.26'
  233. config.write('[metadata]\nversion = attr: fake_package.subpkg_b.mod.VERSION\n')
  234. with get_dist(tmpdir) as dist:
  235. assert dist.metadata.version == '2016.11.26'
  236. def test_version_file(self, tmpdir):
  237. fake_env(tmpdir, '[metadata]\nversion = file: fake_package/version.txt\n')
  238. tmpdir.join('fake_package', 'version.txt').write('1.2.3\n')
  239. with get_dist(tmpdir) as dist:
  240. assert dist.metadata.version == '1.2.3'
  241. tmpdir.join('fake_package', 'version.txt').write('1.2.3\n4.5.6\n')
  242. with pytest.raises(DistutilsOptionError):
  243. with get_dist(tmpdir) as dist:
  244. dist.metadata.version
  245. def test_version_with_package_dir_simple(self, tmpdir):
  246. fake_env(
  247. tmpdir,
  248. '[metadata]\n'
  249. 'version = attr: fake_package_simple.VERSION\n'
  250. '[options]\n'
  251. 'package_dir =\n'
  252. ' = src\n',
  253. package_path='src/fake_package_simple',
  254. )
  255. with get_dist(tmpdir) as dist:
  256. assert dist.metadata.version == '1.2.3'
  257. def test_version_with_package_dir_rename(self, tmpdir):
  258. fake_env(
  259. tmpdir,
  260. '[metadata]\n'
  261. 'version = attr: fake_package_rename.VERSION\n'
  262. '[options]\n'
  263. 'package_dir =\n'
  264. ' fake_package_rename = fake_dir\n',
  265. package_path='fake_dir',
  266. )
  267. with get_dist(tmpdir) as dist:
  268. assert dist.metadata.version == '1.2.3'
  269. def test_version_with_package_dir_complex(self, tmpdir):
  270. fake_env(
  271. tmpdir,
  272. '[metadata]\n'
  273. 'version = attr: fake_package_complex.VERSION\n'
  274. '[options]\n'
  275. 'package_dir =\n'
  276. ' fake_package_complex = src/fake_dir\n',
  277. package_path='src/fake_dir',
  278. )
  279. with get_dist(tmpdir) as dist:
  280. assert dist.metadata.version == '1.2.3'
  281. def test_unknown_meta_item(self, tmpdir):
  282. fake_env(tmpdir, '[metadata]\nname = fake_name\nunknown = some\n')
  283. with get_dist(tmpdir, parse=False) as dist:
  284. dist.parse_config_files() # Skip unknown.
  285. def test_usupported_section(self, tmpdir):
  286. fake_env(tmpdir, '[metadata.some]\nkey = val\n')
  287. with get_dist(tmpdir, parse=False) as dist:
  288. with pytest.raises(DistutilsOptionError):
  289. dist.parse_config_files()
  290. def test_classifiers(self, tmpdir):
  291. expected = set([
  292. 'Framework :: Django',
  293. 'Programming Language :: Python :: 3',
  294. 'Programming Language :: Python :: 3.5',
  295. ])
  296. # From file.
  297. _, config = fake_env(tmpdir, '[metadata]\nclassifiers = file: classifiers\n')
  298. tmpdir.join('classifiers').write(
  299. 'Framework :: Django\n'
  300. 'Programming Language :: Python :: 3\n'
  301. 'Programming Language :: Python :: 3.5\n'
  302. )
  303. with get_dist(tmpdir) as dist:
  304. assert set(dist.metadata.classifiers) == expected
  305. # From list notation
  306. config.write(
  307. '[metadata]\n'
  308. 'classifiers =\n'
  309. ' Framework :: Django\n'
  310. ' Programming Language :: Python :: 3\n'
  311. ' Programming Language :: Python :: 3.5\n'
  312. )
  313. with get_dist(tmpdir) as dist:
  314. assert set(dist.metadata.classifiers) == expected
  315. def test_interpolation(self, tmpdir):
  316. fake_env(tmpdir, '[metadata]\ndescription = %(message)s\n')
  317. with pytest.raises(configparser.InterpolationMissingOptionError):
  318. with get_dist(tmpdir):
  319. pass
  320. def test_non_ascii_1(self, tmpdir):
  321. fake_env(tmpdir, '[metadata]\ndescription = éàïôñ\n', encoding='utf-8')
  322. with get_dist(tmpdir):
  323. pass
  324. def test_non_ascii_3(self, tmpdir):
  325. fake_env(tmpdir, '\n# -*- coding: invalid\n')
  326. with get_dist(tmpdir):
  327. pass
  328. def test_non_ascii_4(self, tmpdir):
  329. fake_env(
  330. tmpdir,
  331. '# -*- coding: utf-8\n[metadata]\ndescription = éàïôñ\n',
  332. encoding='utf-8',
  333. )
  334. with get_dist(tmpdir) as dist:
  335. assert dist.metadata.description == 'éàïôñ'
  336. def test_not_utf8(self, tmpdir):
  337. """
  338. Config files encoded not in UTF-8 will fail
  339. """
  340. fake_env(
  341. tmpdir,
  342. '# vim: set fileencoding=iso-8859-15 :\n[metadata]\ndescription = éàïôñ\n',
  343. encoding='iso-8859-15',
  344. )
  345. with pytest.raises(UnicodeDecodeError):
  346. with get_dist(tmpdir):
  347. pass
  348. @pytest.mark.parametrize(
  349. ("error_msg", "config", "invalid"),
  350. [
  351. (
  352. "Invalid dash-separated key 'author-email' in 'metadata' (setup.cfg)",
  353. DALS(
  354. """
  355. [metadata]
  356. author-email = test@test.com
  357. maintainer_email = foo@foo.com
  358. """
  359. ),
  360. {"author-email": "test@test.com"},
  361. ),
  362. (
  363. "Invalid uppercase key 'Name' in 'metadata' (setup.cfg)",
  364. DALS(
  365. """
  366. [metadata]
  367. Name = foo
  368. description = Some description
  369. """
  370. ),
  371. {"Name": "foo"},
  372. ),
  373. ],
  374. )
  375. def test_invalid_options_previously_deprecated(
  376. self, tmpdir, error_msg, config, invalid
  377. ):
  378. # This test and related methods can be removed when no longer needed.
  379. # Deprecation postponed due to push-back from the community in
  380. # https://github.com/pypa/setuptools/issues/4910
  381. fake_env(tmpdir, config)
  382. with pytest.warns(SetuptoolsDeprecationWarning, match=re.escape(error_msg)):
  383. dist = get_dist(tmpdir).__enter__()
  384. tmpdir.join('setup.cfg').remove()
  385. for field, value in invalid.items():
  386. attr = field.replace("-", "_").lower()
  387. assert getattr(dist.metadata, attr) == value
  388. class TestOptions:
  389. def test_basic(self, tmpdir):
  390. fake_env(
  391. tmpdir,
  392. '[options]\n'
  393. 'zip_safe = True\n'
  394. 'include_package_data = yes\n'
  395. 'package_dir = b=c, =src\n'
  396. 'packages = pack_a, pack_b.subpack\n'
  397. 'namespace_packages = pack1, pack2\n'
  398. 'scripts = bin/one.py, bin/two.py\n'
  399. 'eager_resources = bin/one.py, bin/two.py\n'
  400. 'install_requires = docutils>=0.3; pack ==1.1, ==1.3; hey\n'
  401. 'setup_requires = docutils>=0.3; spack ==1.1, ==1.3; there\n'
  402. 'dependency_links = http://some.com/here/1, '
  403. 'http://some.com/there/2\n'
  404. 'python_requires = >=1.0, !=2.8\n'
  405. 'py_modules = module1, module2\n',
  406. )
  407. deprec = pytest.warns(SetuptoolsDeprecationWarning, match="namespace_packages")
  408. with deprec, get_dist(tmpdir) as dist:
  409. assert dist.zip_safe
  410. assert dist.include_package_data
  411. assert dist.package_dir == {'': 'src', 'b': 'c'}
  412. assert dist.packages == ['pack_a', 'pack_b.subpack']
  413. assert dist.namespace_packages == ['pack1', 'pack2']
  414. assert dist.scripts == ['bin/one.py', 'bin/two.py']
  415. assert dist.dependency_links == ([
  416. 'http://some.com/here/1',
  417. 'http://some.com/there/2',
  418. ])
  419. assert dist.install_requires == ([
  420. 'docutils>=0.3',
  421. 'pack==1.1,==1.3',
  422. 'hey',
  423. ])
  424. assert dist.setup_requires == ([
  425. 'docutils>=0.3',
  426. 'spack ==1.1, ==1.3',
  427. 'there',
  428. ])
  429. assert dist.python_requires == '>=1.0, !=2.8'
  430. assert dist.py_modules == ['module1', 'module2']
  431. def test_multiline(self, tmpdir):
  432. fake_env(
  433. tmpdir,
  434. '[options]\n'
  435. 'package_dir = \n'
  436. ' b=c\n'
  437. ' =src\n'
  438. 'packages = \n'
  439. ' pack_a\n'
  440. ' pack_b.subpack\n'
  441. 'namespace_packages = \n'
  442. ' pack1\n'
  443. ' pack2\n'
  444. 'scripts = \n'
  445. ' bin/one.py\n'
  446. ' bin/two.py\n'
  447. 'eager_resources = \n'
  448. ' bin/one.py\n'
  449. ' bin/two.py\n'
  450. 'install_requires = \n'
  451. ' docutils>=0.3\n'
  452. ' pack ==1.1, ==1.3\n'
  453. ' hey\n'
  454. 'setup_requires = \n'
  455. ' docutils>=0.3\n'
  456. ' spack ==1.1, ==1.3\n'
  457. ' there\n'
  458. 'dependency_links = \n'
  459. ' http://some.com/here/1\n'
  460. ' http://some.com/there/2\n',
  461. )
  462. deprec = pytest.warns(SetuptoolsDeprecationWarning, match="namespace_packages")
  463. with deprec, get_dist(tmpdir) as dist:
  464. assert dist.package_dir == {'': 'src', 'b': 'c'}
  465. assert dist.packages == ['pack_a', 'pack_b.subpack']
  466. assert dist.namespace_packages == ['pack1', 'pack2']
  467. assert dist.scripts == ['bin/one.py', 'bin/two.py']
  468. assert dist.dependency_links == ([
  469. 'http://some.com/here/1',
  470. 'http://some.com/there/2',
  471. ])
  472. assert dist.install_requires == ([
  473. 'docutils>=0.3',
  474. 'pack==1.1,==1.3',
  475. 'hey',
  476. ])
  477. assert dist.setup_requires == ([
  478. 'docutils>=0.3',
  479. 'spack ==1.1, ==1.3',
  480. 'there',
  481. ])
  482. def test_package_dir_fail(self, tmpdir):
  483. fake_env(tmpdir, '[options]\npackage_dir = a b\n')
  484. with get_dist(tmpdir, parse=False) as dist:
  485. with pytest.raises(DistutilsOptionError):
  486. dist.parse_config_files()
  487. def test_package_data(self, tmpdir):
  488. fake_env(
  489. tmpdir,
  490. '[options.package_data]\n'
  491. '* = *.txt, *.rst\n'
  492. 'hello = *.msg\n'
  493. '\n'
  494. '[options.exclude_package_data]\n'
  495. '* = fake1.txt, fake2.txt\n'
  496. 'hello = *.dat\n',
  497. )
  498. with get_dist(tmpdir) as dist:
  499. assert dist.package_data == {
  500. '': ['*.txt', '*.rst'],
  501. 'hello': ['*.msg'],
  502. }
  503. assert dist.exclude_package_data == {
  504. '': ['fake1.txt', 'fake2.txt'],
  505. 'hello': ['*.dat'],
  506. }
  507. def test_packages(self, tmpdir):
  508. fake_env(tmpdir, '[options]\npackages = find:\n')
  509. with get_dist(tmpdir) as dist:
  510. assert dist.packages == ['fake_package']
  511. def test_find_directive(self, tmpdir):
  512. dir_package, config = fake_env(tmpdir, '[options]\npackages = find:\n')
  513. make_package_dir('sub_one', dir_package)
  514. make_package_dir('sub_two', dir_package)
  515. with get_dist(tmpdir) as dist:
  516. assert set(dist.packages) == set([
  517. 'fake_package',
  518. 'fake_package.sub_two',
  519. 'fake_package.sub_one',
  520. ])
  521. config.write(
  522. '[options]\n'
  523. 'packages = find:\n'
  524. '\n'
  525. '[options.packages.find]\n'
  526. 'where = .\n'
  527. 'include =\n'
  528. ' fake_package.sub_one\n'
  529. ' two\n'
  530. )
  531. with get_dist(tmpdir) as dist:
  532. assert dist.packages == ['fake_package.sub_one']
  533. config.write(
  534. '[options]\n'
  535. 'packages = find:\n'
  536. '\n'
  537. '[options.packages.find]\n'
  538. 'exclude =\n'
  539. ' fake_package.sub_one\n'
  540. )
  541. with get_dist(tmpdir) as dist:
  542. assert set(dist.packages) == set(['fake_package', 'fake_package.sub_two'])
  543. def test_find_namespace_directive(self, tmpdir):
  544. dir_package, config = fake_env(
  545. tmpdir, '[options]\npackages = find_namespace:\n'
  546. )
  547. make_package_dir('sub_one', dir_package)
  548. make_package_dir('sub_two', dir_package, ns=True)
  549. with get_dist(tmpdir) as dist:
  550. assert set(dist.packages) == {
  551. 'fake_package',
  552. 'fake_package.sub_two',
  553. 'fake_package.sub_one',
  554. }
  555. config.write(
  556. '[options]\n'
  557. 'packages = find_namespace:\n'
  558. '\n'
  559. '[options.packages.find]\n'
  560. 'where = .\n'
  561. 'include =\n'
  562. ' fake_package.sub_one\n'
  563. ' two\n'
  564. )
  565. with get_dist(tmpdir) as dist:
  566. assert dist.packages == ['fake_package.sub_one']
  567. config.write(
  568. '[options]\n'
  569. 'packages = find_namespace:\n'
  570. '\n'
  571. '[options.packages.find]\n'
  572. 'exclude =\n'
  573. ' fake_package.sub_one\n'
  574. )
  575. with get_dist(tmpdir) as dist:
  576. assert set(dist.packages) == {'fake_package', 'fake_package.sub_two'}
  577. def test_extras_require(self, tmpdir):
  578. fake_env(
  579. tmpdir,
  580. '[options.extras_require]\n'
  581. 'pdf = ReportLab>=1.2; RXP\n'
  582. 'rest = \n'
  583. ' docutils>=0.3\n'
  584. ' pack ==1.1, ==1.3\n',
  585. )
  586. with get_dist(tmpdir) as dist:
  587. assert dist.extras_require == {
  588. 'pdf': ['ReportLab>=1.2', 'RXP'],
  589. 'rest': ['docutils>=0.3', 'pack==1.1,==1.3'],
  590. }
  591. assert set(dist.metadata.provides_extras) == {'pdf', 'rest'}
  592. @pytest.mark.parametrize(
  593. "config",
  594. [
  595. "[options.extras_require]\nfoo = bar;python_version<'3'",
  596. "[options.extras_require]\nfoo = bar;os_name=='linux'",
  597. "[options.extras_require]\nfoo = bar;python_version<'3'\n",
  598. "[options.extras_require]\nfoo = bar;os_name=='linux'\n",
  599. "[options]\ninstall_requires = bar;python_version<'3'",
  600. "[options]\ninstall_requires = bar;os_name=='linux'",
  601. "[options]\ninstall_requires = bar;python_version<'3'\n",
  602. "[options]\ninstall_requires = bar;os_name=='linux'\n",
  603. ],
  604. )
  605. def test_raises_accidental_env_marker_misconfig(self, config, tmpdir):
  606. fake_env(tmpdir, config)
  607. match = (
  608. r"One of the parsed requirements in `(install_requires|extras_require.+)` "
  609. "looks like a valid environment marker.*"
  610. )
  611. with pytest.raises(InvalidRequirement, match=match):
  612. with get_dist(tmpdir) as _:
  613. pass
  614. @pytest.mark.parametrize(
  615. "config",
  616. [
  617. "[options.extras_require]\nfoo = bar;python_version<3",
  618. "[options.extras_require]\nfoo = bar;python_version<3\n",
  619. "[options]\ninstall_requires = bar;python_version<3",
  620. "[options]\ninstall_requires = bar;python_version<3\n",
  621. ],
  622. )
  623. def test_warn_accidental_env_marker_misconfig(self, config, tmpdir):
  624. fake_env(tmpdir, config)
  625. match = (
  626. r"One of the parsed requirements in `(install_requires|extras_require.+)` "
  627. "looks like a valid environment marker.*"
  628. )
  629. with pytest.warns(SetuptoolsDeprecationWarning, match=match):
  630. with get_dist(tmpdir) as _:
  631. pass
  632. @pytest.mark.parametrize(
  633. "config",
  634. [
  635. "[options.extras_require]\nfoo =\n bar;python_version<'3'",
  636. "[options.extras_require]\nfoo = bar;baz\nboo = xxx;yyy",
  637. "[options.extras_require]\nfoo =\n bar;python_version<'3'\n",
  638. "[options.extras_require]\nfoo = bar;baz\nboo = xxx;yyy\n",
  639. "[options.extras_require]\nfoo =\n bar\n python_version<3\n",
  640. "[options]\ninstall_requires =\n bar;python_version<'3'",
  641. "[options]\ninstall_requires = bar;baz\nboo = xxx;yyy",
  642. "[options]\ninstall_requires =\n bar;python_version<'3'\n",
  643. "[options]\ninstall_requires = bar;baz\nboo = xxx;yyy\n",
  644. "[options]\ninstall_requires =\n bar\n python_version<3\n",
  645. ],
  646. )
  647. @pytest.mark.filterwarnings("error::setuptools.SetuptoolsDeprecationWarning")
  648. def test_nowarn_accidental_env_marker_misconfig(self, config, tmpdir, recwarn):
  649. fake_env(tmpdir, config)
  650. num_warnings = len(recwarn)
  651. with get_dist(tmpdir) as _:
  652. pass
  653. # The examples are valid, no warnings shown
  654. assert len(recwarn) == num_warnings
  655. def test_dash_preserved_extras_require(self, tmpdir):
  656. fake_env(tmpdir, '[options.extras_require]\nfoo-a = foo\nfoo_b = test\n')
  657. with get_dist(tmpdir) as dist:
  658. assert dist.extras_require == {'foo-a': ['foo'], 'foo_b': ['test']}
  659. def test_entry_points(self, tmpdir):
  660. _, config = fake_env(
  661. tmpdir,
  662. '[options.entry_points]\n'
  663. 'group1 = point1 = pack.module:func, '
  664. '.point2 = pack.module2:func_rest [rest]\n'
  665. 'group2 = point3 = pack.module:func2\n',
  666. )
  667. with get_dist(tmpdir) as dist:
  668. assert dist.entry_points == {
  669. 'group1': [
  670. 'point1 = pack.module:func',
  671. '.point2 = pack.module2:func_rest [rest]',
  672. ],
  673. 'group2': ['point3 = pack.module:func2'],
  674. }
  675. expected = (
  676. '[blogtool.parsers]\n'
  677. '.rst = some.nested.module:SomeClass.some_classmethod[reST]\n'
  678. )
  679. tmpdir.join('entry_points').write(expected)
  680. # From file.
  681. config.write('[options]\nentry_points = file: entry_points\n')
  682. with get_dist(tmpdir) as dist:
  683. assert dist.entry_points == expected
  684. def test_case_sensitive_entry_points(self, tmpdir):
  685. fake_env(
  686. tmpdir,
  687. '[options.entry_points]\n'
  688. 'GROUP1 = point1 = pack.module:func, '
  689. '.point2 = pack.module2:func_rest [rest]\n'
  690. 'group2 = point3 = pack.module:func2\n',
  691. )
  692. with get_dist(tmpdir) as dist:
  693. assert dist.entry_points == {
  694. 'GROUP1': [
  695. 'point1 = pack.module:func',
  696. '.point2 = pack.module2:func_rest [rest]',
  697. ],
  698. 'group2': ['point3 = pack.module:func2'],
  699. }
  700. def test_data_files(self, tmpdir):
  701. fake_env(
  702. tmpdir,
  703. '[options.data_files]\n'
  704. 'cfg =\n'
  705. ' a/b.conf\n'
  706. ' c/d.conf\n'
  707. 'data = e/f.dat, g/h.dat\n',
  708. )
  709. with get_dist(tmpdir) as dist:
  710. expected = [
  711. ('cfg', ['a/b.conf', 'c/d.conf']),
  712. ('data', ['e/f.dat', 'g/h.dat']),
  713. ]
  714. assert sorted(dist.data_files) == sorted(expected)
  715. def test_data_files_globby(self, tmpdir):
  716. fake_env(
  717. tmpdir,
  718. '[options.data_files]\n'
  719. 'cfg =\n'
  720. ' a/b.conf\n'
  721. ' c/d.conf\n'
  722. 'data = *.dat\n'
  723. 'icons = \n'
  724. ' *.ico\n'
  725. 'audio = \n'
  726. ' *.wav\n'
  727. ' sounds.db\n',
  728. )
  729. # Create dummy files for glob()'s sake:
  730. tmpdir.join('a.dat').write('')
  731. tmpdir.join('b.dat').write('')
  732. tmpdir.join('c.dat').write('')
  733. tmpdir.join('a.ico').write('')
  734. tmpdir.join('b.ico').write('')
  735. tmpdir.join('c.ico').write('')
  736. tmpdir.join('beep.wav').write('')
  737. tmpdir.join('boop.wav').write('')
  738. tmpdir.join('sounds.db').write('')
  739. with get_dist(tmpdir) as dist:
  740. expected = [
  741. ('cfg', ['a/b.conf', 'c/d.conf']),
  742. ('data', ['a.dat', 'b.dat', 'c.dat']),
  743. ('icons', ['a.ico', 'b.ico', 'c.ico']),
  744. ('audio', ['beep.wav', 'boop.wav', 'sounds.db']),
  745. ]
  746. assert sorted(dist.data_files) == sorted(expected)
  747. def test_python_requires_simple(self, tmpdir):
  748. fake_env(
  749. tmpdir,
  750. DALS(
  751. """
  752. [options]
  753. python_requires=>=2.7
  754. """
  755. ),
  756. )
  757. with get_dist(tmpdir) as dist:
  758. dist.parse_config_files()
  759. def test_python_requires_compound(self, tmpdir):
  760. fake_env(
  761. tmpdir,
  762. DALS(
  763. """
  764. [options]
  765. python_requires=>=2.7,!=3.0.*
  766. """
  767. ),
  768. )
  769. with get_dist(tmpdir) as dist:
  770. dist.parse_config_files()
  771. def test_python_requires_invalid(self, tmpdir):
  772. fake_env(
  773. tmpdir,
  774. DALS(
  775. """
  776. [options]
  777. python_requires=invalid
  778. """
  779. ),
  780. )
  781. with pytest.raises(Exception):
  782. with get_dist(tmpdir) as dist:
  783. dist.parse_config_files()
  784. def test_cmdclass(self, tmpdir):
  785. module_path = Path(tmpdir, "src/custom_build.py") # auto discovery for src
  786. module_path.parent.mkdir(parents=True, exist_ok=True)
  787. module_path.write_text(
  788. "from distutils.core import Command\nclass CustomCmd(Command): pass\n",
  789. encoding="utf-8",
  790. )
  791. setup_cfg = """
  792. [options]
  793. cmdclass =
  794. customcmd = custom_build.CustomCmd
  795. """
  796. fake_env(tmpdir, inspect.cleandoc(setup_cfg))
  797. with get_dist(tmpdir) as dist:
  798. cmdclass = dist.cmdclass['customcmd']
  799. assert cmdclass.__name__ == "CustomCmd"
  800. assert cmdclass.__module__ == "custom_build"
  801. assert module_path.samefile(inspect.getfile(cmdclass))
  802. def test_requirements_file(self, tmpdir):
  803. fake_env(
  804. tmpdir,
  805. DALS(
  806. """
  807. [options]
  808. install_requires = file:requirements.txt
  809. [options.extras_require]
  810. colors = file:requirements-extra.txt
  811. """
  812. ),
  813. )
  814. tmpdir.join('requirements.txt').write('\ndocutils>=0.3\n\n')
  815. tmpdir.join('requirements-extra.txt').write('colorama')
  816. with get_dist(tmpdir) as dist:
  817. assert dist.install_requires == ['docutils>=0.3']
  818. assert dist.extras_require == {'colors': ['colorama']}
  819. saved_dist_init = _Distribution.__init__
  820. class TestExternalSetters:
  821. # During creation of the setuptools Distribution() object, we call
  822. # the init of the parent distutils Distribution object via
  823. # _Distribution.__init__ ().
  824. #
  825. # It's possible distutils calls out to various keyword
  826. # implementations (i.e. distutils.setup_keywords entry points)
  827. # that may set a range of variables.
  828. #
  829. # This wraps distutil's Distribution.__init__ and simulates
  830. # pbr or something else setting these values.
  831. def _fake_distribution_init(self, dist, attrs):
  832. saved_dist_init(dist, attrs)
  833. # see self._DISTUTILS_UNSUPPORTED_METADATA
  834. dist.metadata.long_description_content_type = 'text/something'
  835. # Test overwrite setup() args
  836. dist.metadata.project_urls = {
  837. 'Link One': 'https://example.com/one/',
  838. 'Link Two': 'https://example.com/two/',
  839. }
  840. @patch.object(_Distribution, '__init__', autospec=True)
  841. def test_external_setters(self, mock_parent_init, tmpdir):
  842. mock_parent_init.side_effect = self._fake_distribution_init
  843. dist = Distribution(attrs={'project_urls': {'will_be': 'ignored'}})
  844. assert dist.metadata.long_description_content_type == 'text/something'
  845. assert dist.metadata.project_urls == {
  846. 'Link One': 'https://example.com/one/',
  847. 'Link Two': 'https://example.com/two/',
  848. }