Package babel :: Package messages :: Module frontend :: Class extract_messages |

# Class extract_messages

    distutils.cmd.Command --+
                            |
                           extract_messages

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`:

    from babel.messages.frontend import extract_messages

    setup(
        ...
        cmdclass = {'extract_messages': extract_messages}
    )

See Also:
  Integrating new distutils commands, setuptools

Instance Methods
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`: `__getattr__`, `__init__`, `announce`, `copy_file`, `copy_tree`, `debug_print`, `dump_options`, `ensure_dirname`, `ensure_filename`, `ensure_finalized`, `ensure_string`, `ensure_string_list`, `execute`, `get_command_name`, `get_finalized_command`, `get_sub_commands`, `make_archive`, `make_file`, `mkpath`, `move_file`, `reinitialize_command`, `run_command`, `set_undefined_options`, `spawn`, `warn`

Class Variables
| description = ``'``extract localizable strings from the project code``'``
| user_options = ``[``(``'``charset=``'``,` None`,` `'``charset to use in the outp``...``
| boolean_options = ``[``'``no-default-keywords``'``,` `'``no-location``'``,` `'``omit``...``
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. Overrides: distutils.cmd.Command.initialize_options (inherited documentation)

### finalize_options(self) |
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 def
      aults'),
       ('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
      ...

  ### boolean_options Value:
      ['no-default-keywords',
       'no-location',
       'omit-header',
       'no-wrap',
       'sort-output',
       'sort-by-file',
       'strip-comments']