summaryrefslogtreecommitdiff
path: root/setuptools/config.py
diff options
context:
space:
mode:
authorPaul Ganssle <pganssle@users.noreply.github.com>2018-10-29 16:38:10 -0400
committerGitHub <noreply@github.com>2018-10-29 16:38:10 -0400
commita50f09b90c4433aa4ef7b50c682413191da0a1d9 (patch)
tree17b5f6a345ca3040b51a922374607121ec006ccd /setuptools/config.py
parent566f3aadfa112b8d6b9a1ecf5178552f6e0f8c6c (diff)
parent1c226bdeb61dbd82419508dcc65b9969d0f42e16 (diff)
downloadpython-setuptools-git-a50f09b90c4433aa4ef7b50c682413191da0a1d9.tar.gz
Merge pull request #1541 from smenon8/deprecate-requires
Deprecate the requires keyword
Diffstat (limited to 'setuptools/config.py')
-rw-r--r--setuptools/config.py22
1 files changed, 21 insertions, 1 deletions
diff --git a/setuptools/config.py b/setuptools/config.py
index 15d18672..d1ac6734 100644
--- a/setuptools/config.py
+++ b/setuptools/config.py
@@ -2,9 +2,12 @@ from __future__ import absolute_import, unicode_literals
import io
import os
import sys
+
+import warnings
import functools
from collections import defaultdict
from functools import partial
+from functools import wraps
from importlib import import_module
from distutils.errors import DistutilsOptionError, DistutilsFileError
@@ -402,6 +405,20 @@ class ConfigHandler:
section_parser_method(section_options)
+ def _deprecated_config_handler(self, func, msg, warning_class):
+ """ this function will wrap around parameters that are deprecated
+
+ :param msg: deprecation message
+ :param warning_class: class of warning exception to be raised
+ :param func: function to be wrapped around
+ """
+ @wraps(func)
+ def config_handler(*args, **kwargs):
+ warnings.warn(msg, warning_class)
+ return func(*args, **kwargs)
+
+ return config_handler
+
class ConfigMetadataHandler(ConfigHandler):
@@ -437,7 +454,10 @@ class ConfigMetadataHandler(ConfigHandler):
'platforms': parse_list,
'keywords': parse_list,
'provides': parse_list,
- 'requires': parse_list,
+ 'requires': self._deprecated_config_handler(parse_list,
+ "The requires parameter is deprecated, please use " +
+ "install_requires for runtime dependencies.",
+ DeprecationWarning),
'obsoletes': parse_list,
'classifiers': self._get_parser_compound(parse_file, parse_list),
'license': parse_file,