From 56a8b90551411024f792efe853c48de5e5097e59 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Thu, 5 May 2022 19:34:46 +0100 Subject: Warn about packages/modules included as package data --- setuptools/command/build_py.py | 56 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 2 deletions(-) (limited to 'setuptools/command') diff --git a/setuptools/command/build_py.py b/setuptools/command/build_py.py index c3fdc092..ba7b7259 100644 --- a/setuptools/command/build_py.py +++ b/setuptools/command/build_py.py @@ -8,6 +8,9 @@ import io import distutils.errors import itertools import stat +import warnings +from pathlib import Path +from setuptools._deprecation_warning import SetuptoolsDeprecationWarning from setuptools.extern.more_itertools import unique_everseen @@ -129,6 +132,7 @@ class build_py(orig.build_py): src_dirs[assert_relative(self.get_package_dir(package))] = package self.run_command('egg_info') + checker = _IncludePackageDataAbuse() ei_cmd = self.get_finalized_command('egg_info') for path in ei_cmd.filelist.files: d, f = os.path.split(assert_relative(path)) @@ -139,8 +143,13 @@ class build_py(orig.build_py): d, df = os.path.split(d) f = os.path.join(df, f) if d in src_dirs: - if path.endswith('.py') and f == oldf: - continue # it's a module, not data + if f == oldf: + if checker.is_module(f): + continue # it's a module, not data + else: + importable = checker.importable_item(src_dirs[d], f) + if importable: + checker.warn(importable) mf.setdefault(src_dirs[d], []).append(path) def get_data_files(self): @@ -240,3 +249,46 @@ def assert_relative(path): % path ) raise DistutilsSetupError(msg) + + +class _IncludePackageDataAbuse: + """Inform users that package or module is included as 'data file'""" + + MESSAGE = """\ + !!\n\n + ################################### + # Package/module would be ignored # + ################################### + Python recognizes {importable!r} as an importable package or module, however + it is included in the distribution as "data". + This behavior is likely to change in future versions of setuptools (and + therefore is considered deprecated). + + Please make sure that {importable!r} is recognized as a package/module by using + setuptools' `packages` configuration field or the proper package discovery methods. + + To find more information, look for "package discovery" and "data files" on + setuptools documentation page. + \n\n!! + """ + + def __init__(self): + self._already_warned = set() + + def is_module(self, file): + return file.endswith(".py") and file[:-len(".py")].isidentifier() + + def importable_item(self, pkg, file): + path = Path(file) + parents = path.parent.parts + module = [path.stem] if tuple(path.suffixes) == (".py",) else [] + parts = list(itertools.takewhile(str.isidentifier, [*parents, *module])) + if parts: + return ".".join([pkg, *parts]) + return None + + def warn(self, importable): + if importable not in self._already_warned: + msg = textwrap.dedent(self.MESSAGE).format(importable=importable) + warnings.warn(msg, SetuptoolsDeprecationWarning, stacklevel=2) + self._already_warned.add(importable) -- cgit v1.2.1 From 2b218927334c58a655fc285a5c241828d394cffe Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 6 May 2022 10:09:48 +0100 Subject: Simplify checks for abuse of include_package_data Previously, the checks would result in a warning per module additionally to the parent package. Now only one warning per parent package is issued. --- setuptools/command/build_py.py | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) (limited to 'setuptools/command') diff --git a/setuptools/command/build_py.py b/setuptools/command/build_py.py index ba7b7259..62f61e04 100644 --- a/setuptools/command/build_py.py +++ b/setuptools/command/build_py.py @@ -132,7 +132,7 @@ class build_py(orig.build_py): src_dirs[assert_relative(self.get_package_dir(package))] = package self.run_command('egg_info') - checker = _IncludePackageDataAbuse() + check = _IncludePackageDataAbuse() ei_cmd = self.get_finalized_command('egg_info') for path in ei_cmd.filelist.files: d, f = os.path.split(assert_relative(path)) @@ -144,12 +144,12 @@ class build_py(orig.build_py): f = os.path.join(df, f) if d in src_dirs: if f == oldf: - if checker.is_module(f): + if check.is_module(f): continue # it's a module, not data else: - importable = checker.importable_item(src_dirs[d], f) + importable = check.importable_subpackage(src_dirs[d], f) if importable: - checker.warn(importable) + check.warn(importable) mf.setdefault(src_dirs[d], []).append(path) def get_data_files(self): @@ -256,19 +256,19 @@ class _IncludePackageDataAbuse: MESSAGE = """\ !!\n\n - ################################### - # Package/module would be ignored # - ################################### - Python recognizes {importable!r} as an importable package or module, however - it is included in the distribution as "data". + ############################ + # Package would be ignored # + ############################ + Python recognizes {importable!r} as an importable package, however it is + included in the distribution as "data". This behavior is likely to change in future versions of setuptools (and therefore is considered deprecated). - Please make sure that {importable!r} is recognized as a package/module by using - setuptools' `packages` configuration field or the proper package discovery methods. + Please make sure that {importable!r} is included as a package by using + setuptools' `packages` configuration field or the proper discovery methods. - To find more information, look for "package discovery" and "data files" on - setuptools documentation page. + You can read more about "package discovery" and "data files" on setuptools + documentation page. \n\n!! """ @@ -278,13 +278,11 @@ class _IncludePackageDataAbuse: def is_module(self, file): return file.endswith(".py") and file[:-len(".py")].isidentifier() - def importable_item(self, pkg, file): - path = Path(file) - parents = path.parent.parts - module = [path.stem] if tuple(path.suffixes) == (".py",) else [] - parts = list(itertools.takewhile(str.isidentifier, [*parents, *module])) + def importable_subpackage(self, parent, file): + pkg = Path(file).parent + parts = list(itertools.takewhile(str.isidentifier, pkg.parts)) if parts: - return ".".join([pkg, *parts]) + return ".".join([parent, *parts]) return None def warn(self, importable): -- cgit v1.2.1