Undo potentially confusing name change in packaging.

This method was named reinitialize_command in distutils and accompanied
by a comment suggesting to change it to get_reinitialized_command.
Following that, I did the change for distutils2, but it proved
confusing: The Distribution object has an internal cache of command
objects, to make sure only one instance is ever used, and the name
get_reinitialized_command could suggest that the object returned was
independent of that cache, which it was not.  I’m reverting the name
change to make code clearer.
This commit is contained in:
Éric Araujo 2011-11-06 06:54:05 +01:00
parent 4e377f215d
commit a963e0d917
8 changed files with 19 additions and 19 deletions

View File

@ -126,7 +126,7 @@ class bdist(Command):
# Reinitialize and run each command.
for i in range(len(self.formats)):
cmd_name = commands[i]
sub_cmd = self.get_reinitialized_command(cmd_name)
sub_cmd = self.reinitialize_command(cmd_name)
sub_cmd.format = self.formats[i]
# passing the owner and group names for tar archiving

View File

@ -80,8 +80,8 @@ class bdist_dumb(Command):
if not self.skip_build:
self.run_command('build')
install = self.get_reinitialized_command('install_dist',
reinit_subcommands=True)
install = self.reinitialize_command('install_dist',
reinit_subcommands=True)
install.root = self.bdist_dir
install.skip_build = self.skip_build
install.warn_dir = False

View File

@ -183,13 +183,13 @@ class bdist_msi(Command):
if not self.skip_build:
self.run_command('build')
install = self.get_reinitialized_command('install_dist',
reinit_subcommands=True)
install = self.reinitialize_command('install_dist',
reinit_subcommands=True)
install.prefix = self.bdist_dir
install.skip_build = self.skip_build
install.warn_dir = False
install_lib = self.get_reinitialized_command('install_lib')
install_lib = self.reinitialize_command('install_lib')
# we do not want to include pyc or pyo files
install_lib.compile = False
install_lib.optimize = 0

View File

@ -115,14 +115,13 @@ class bdist_wininst(Command):
if not self.skip_build:
self.run_command('build')
install = self.get_reinitialized_command('install',
reinit_subcommands=True)
install = self.reinitialize_command('install', reinit_subcommands=True)
install.root = self.bdist_dir
install.skip_build = self.skip_build
install.warn_dir = False
install.plat_name = self.plat_name
install_lib = self.get_reinitialized_command('install_lib')
install_lib = self.reinitialize_command('install_lib')
# we do not want to include pyc or pyo files
install_lib.compile = False
install_lib.optimize = 0

View File

@ -318,8 +318,8 @@ class Command:
cmd_obj.ensure_finalized()
return cmd_obj
def get_reinitialized_command(self, command, reinit_subcommands=False):
return self.distribution.get_reinitialized_command(
def reinitialize_command(self, command, reinit_subcommands=False):
return self.distribution.reinitialize_command(
command, reinit_subcommands)
def run_command(self, command):

View File

@ -56,7 +56,7 @@ class test(Command):
prev_syspath = sys.path[:]
try:
# build release
build = self.get_reinitialized_command('build')
build = self.reinitialize_command('build')
self.run_command('build')
sys.path.insert(0, build.build_lib)

View File

@ -636,9 +636,9 @@ Common commands: (see '--help-commands' for more)
except ValueError as msg:
raise PackagingOptionError(msg)
def get_reinitialized_command(self, command, reinit_subcommands=False):
def reinitialize_command(self, command, reinit_subcommands=False):
"""Reinitializes a command to the state it was in when first
returned by 'get_command_obj()': ie., initialized but not yet
returned by 'get_command_obj()': i.e., initialized but not yet
finalized. This provides the opportunity to sneak option
values in programmatically, overriding or supplementing
user-supplied values from the config files and command line.
@ -650,10 +650,11 @@ Common commands: (see '--help-commands' for more)
'reinit_subcommands' is true, also reinitializes the command's
sub-commands, as declared by the 'sub_commands' class attribute (if
it has one). See the "install_dist" command for an example. Only
reinitializes the sub-commands that actually matter, ie. those
whose test predicates return true.
reinitializes the sub-commands that actually matter, i.e. those
whose test predicate return true.
Returns the reinitialized command object.
Returns the reinitialized command object. It will be the same
object as the one stored in the self.command_obj attribute.
"""
if not isinstance(command, Command):
command_name = command
@ -671,7 +672,7 @@ Common commands: (see '--help-commands' for more)
if reinit_subcommands:
for sub in command.get_sub_commands():
self.get_reinitialized_command(sub, reinit_subcommands)
self.reinitialize_command(sub, reinit_subcommands)
return command

View File

@ -251,7 +251,7 @@ class DummyCommand:
Useful for mocking one dependency command in the tests for another
command, see e.g. the dummy build command in test_build_scripts.
"""
# XXX does not work with dist.get_reinitialized_command, which typechecks
# XXX does not work with dist.reinitialize_command, which typechecks
# and wants a finalized attribute
def __init__(self, **kwargs):