[Python-checkins] r75893 - in python/trunk: Doc/ACKS.txt Doc/distutils/builtdist.rst Doc/install/index.rst Lib/distutils/core.py Lib/distutils/dist.py Lib/distutils/tests/test_dist.py Misc/NEWS
tarek.ziade
python-checkins at python.org
Wed Oct 28 00:06:11 CET 2009
Author: tarek.ziade
Date: Wed Oct 28 00:06:10 2009
New Revision: 75893
Log:
Fixed #1180: Option to ignore ~/.pydistutils.cfg in Distutils
Modified:
python/trunk/Doc/ACKS.txt
python/trunk/Doc/distutils/builtdist.rst
python/trunk/Doc/install/index.rst
python/trunk/Lib/distutils/core.py
python/trunk/Lib/distutils/dist.py
python/trunk/Lib/distutils/tests/test_dist.py
python/trunk/Misc/NEWS
Modified: python/trunk/Doc/ACKS.txt
==============================================================================
--- python/trunk/Doc/ACKS.txt (original)
+++ python/trunk/Doc/ACKS.txt Wed Oct 28 00:06:10 2009
@@ -207,6 +207,7 @@
* Mats Wichmann
* Gerry Wiener
* Timothy Wild
+ * Paul Winkler
* Collin Winter
* Blake Winton
* Dan Wolfe
Modified: python/trunk/Doc/distutils/builtdist.rst
==============================================================================
--- python/trunk/Doc/distutils/builtdist.rst (original)
+++ python/trunk/Doc/distutils/builtdist.rst Wed Oct 28 00:06:10 2009
@@ -241,7 +241,8 @@
configuration file, :file:`setup.cfg`\ ---see section :ref:`setup-config`. If
you distribute or package many Python module distributions, you might want to
put options that apply to all of them in your personal Distutils configuration
-file (:file:`~/.pydistutils.cfg`).
+file (:file:`~/.pydistutils.cfg`). If you want to temporarily disable
+this file, you can pass the --no-user-cfg option to setup.py.
There are three steps to building a binary RPM package, all of which are
handled automatically by the Distutils:
Modified: python/trunk/Doc/install/index.rst
==============================================================================
--- python/trunk/Doc/install/index.rst (original)
+++ python/trunk/Doc/install/index.rst Wed Oct 28 00:06:10 2009
@@ -694,6 +694,9 @@
| local | :file:`setup.cfg` | \(3) |
+--------------+-------------------------------------------------+-------+
+On all platforms, the "personal" file can be temporarily disabled by
+passing the `--no-user-cfg` option.
+
Notes:
(1)
Modified: python/trunk/Lib/distutils/core.py
==============================================================================
--- python/trunk/Lib/distutils/core.py (original)
+++ python/trunk/Lib/distutils/core.py Wed Oct 28 00:06:10 2009
@@ -129,8 +129,9 @@
if _setup_stop_after == "config":
return dist
- # Parse the command line; any command-line errors are the end user's
- # fault, so turn them into SystemExit to suppress tracebacks.
+ # Parse the command line and override config files; any
+ # command-line errors are the end user's fault, so turn them into
+ # SystemExit to suppress tracebacks.
try:
ok = dist.parse_command_line()
except DistutilsArgError, msg:
Modified: python/trunk/Lib/distutils/dist.py
==============================================================================
--- python/trunk/Lib/distutils/dist.py (original)
+++ python/trunk/Lib/distutils/dist.py Wed Oct 28 00:06:10 2009
@@ -56,7 +56,9 @@
('quiet', 'q', "run quietly (turns verbosity off)"),
('dry-run', 'n', "don't actually do anything"),
('help', 'h', "show detailed help message"),
- ]
+ ('no-user-cfg', None,
+ 'ignore pydistutils.cfg in your home directory'),
+ ]
# 'common_usage' is a short (2-3 line) string describing the common
# usage of the setup script.
@@ -264,6 +266,22 @@
else:
sys.stderr.write(msg + "\n")
+ # no-user-cfg is handled before other command line args
+ # because other args override the config files, and this
+ # one is needed before we can load the config files.
+ # If attrs['script_args'] wasn't passed, assume false.
+ #
+ # This also make sure we just look at the global options
+ self.want_user_cfg = True
+
+ if self.script_args is not None:
+ for arg in self.script_args:
+ if not arg.startswith('-'):
+ break
+ if arg == '--no-user-cfg':
+ self.want_user_cfg = False
+ break
+
self.finalize_options()
def get_option_dict(self, command):
@@ -316,7 +334,10 @@
Distutils installation directory (ie. where the top-level
Distutils __inst__.py file lives), a file in the user's home
directory named .pydistutils.cfg on Unix and pydistutils.cfg
- on Windows/Mac, and setup.cfg in the current directory.
+ on Windows/Mac; and setup.cfg in the current directory.
+
+ The file in the user's home directory can be disabled with the
+ --no-user-cfg option.
"""
files = []
check_environ()
@@ -336,15 +357,19 @@
user_filename = "pydistutils.cfg"
# And look for the user config file
- user_file = os.path.join(os.path.expanduser('~'), user_filename)
- if os.path.isfile(user_file):
- files.append(user_file)
+ if self.want_user_cfg:
+ user_file = os.path.join(os.path.expanduser('~'), user_filename)
+ if os.path.isfile(user_file):
+ files.append(user_file)
# All platforms support local setup.cfg
local_file = "setup.cfg"
if os.path.isfile(local_file):
files.append(local_file)
+ if DEBUG:
+ self.announce("using config files: %s" % ', '.join(files))
+
return files
def parse_config_files(self, filenames=None):
Modified: python/trunk/Lib/distutils/tests/test_dist.py
==============================================================================
--- python/trunk/Lib/distutils/tests/test_dist.py (original)
+++ python/trunk/Lib/distutils/tests/test_dist.py Wed Oct 28 00:06:10 2009
@@ -209,6 +209,35 @@
kwargs = {'level': 'ok2'}
self.assertRaises(ValueError, dist.announce, args, kwargs)
+ def test_find_config_files_disable(self):
+ # Ticket #1180: Allow user to disable their home config file.
+ temp_home = self.mkdtemp()
+ if os.name == 'posix':
+ user_filename = os.path.join(temp_home, ".pydistutils.cfg")
+ else:
+ user_filename = os.path.join(temp_home, "pydistutils.cfg")
+
+ with open(user_filename, 'w') as f:
+ f.write('[distutils]\n')
+
+ def _expander(path):
+ return temp_home
+
+ old_expander = os.path.expanduser
+ os.path.expanduser = _expander
+ try:
+ d = distutils.dist.Distribution()
+ all_files = d.find_config_files()
+
+ d = distutils.dist.Distribution(attrs={'script_args':
+ ['--no-user-cfg']})
+ files = d.find_config_files()
+ finally:
+ os.path.expanduser = old_expander
+
+ # make sure --no-user-cfg disables the user cfg file
+ self.assertEquals(len(all_files)-1, len(files))
+
class MetadataTestCase(support.TempdirManager, support.EnvironGuard,
unittest.TestCase):
Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS (original)
+++ python/trunk/Misc/NEWS Wed Oct 28 00:06:10 2009
@@ -427,6 +427,9 @@
Library
-------
+- Issue #1180: Added a new global option to ignore ~/.pydistutils.cfg in
+ Distutils.
+
- Issue #7218: Fix test_site for win32, the directory comparison was done with
an uppercase.
More information about the Python-checkins
mailing list