Message extraction command for use in setup.py scripts.
If correctly installed, this command is available to Setuptools-using
setup scripts automatically. For projects using plain old distutils,
the command needs to be registered explicitly in setup.py:
initialize_options(self)
Set default values for all the options that this command
supports.
finalize_options(self)
Set final values for all the options that this command supports.
run(self)
A command's raison d'etre: carry out the action it exists to
perform, controlled by the options initialized in
'initialize_options()', customized by other commands, the setup
script, the command-line, and config files, and finalized in
'finalize_options()'.
Inherited from distutils.cmd.Command:
sub_commands
Method Details
initialize_options(self)
Set default values for all the options that this command
supports. Note that these defaults may be overridden by other
commands, by the setup script, by config files, or by the
command-line. Thus, this is not the place to code dependencies
between options; generally, 'initialize_options()' implementations
are just a bunch of "self.foo = None" assignments.
This method must be implemented by all command classes.
Set final values for all the options that this command supports.
This is always called as late as possible, ie. after any option
assignments from the command-line or from other commands have been
done. Thus, this is the place to code option dependencies: if
'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as
long as 'foo' still has the same value it was assigned in
'initialize_options()'.
This method must be implemented by all command classes.
Overrides:
distutils.cmd.Command.finalize_options
(inherited documentation)
run(self)
A command's raison d'etre: carry out the action it exists to
perform, controlled by the options initialized in
'initialize_options()', customized by other commands, the setup
script, the command-line, and config files, and finalized in
'finalize_options()'. All terminal output and filesystem
interaction should be done by 'run()'.
This method must be implemented by all command classes.
Overrides:
distutils.cmd.Command.run
(inherited documentation)
Class Variable Details
user_options
Value:
[('charset=', None, 'charset to use in the output file'),('keywords=','k','space-separated list of keywords to look for in addition to the defaults'),('no-default-keywords', None, 'do not include the default keywords'),('mapping-file=', 'F', 'path to the mapping configuration file'),('no-location', None, 'do not include location comments with filename...