python-click:格式化帮助文本 [英] python-click: formatting help text
问题描述
此问题与点击程序包有关:
- 长文本的帮助未按要求显示.
- 我也尝试使用
/b，但似乎影响不大. -
cmd和powershell对于相同的代码都有不同的结果，为什么?
- Long text of help is not being displayed as desired.
- I tried using
/bas well but does not seem to affect much. cmdandpowershellboth have different results for same code, why?
import click
def command_required_option_from_option(require_name, require_map):
class CommandOptionRequiredClass(click.Command):
def invoke(self, ctx):
require = ctx.params[require_name]
if require not in require_map:
raise click.ClickException(
"Unexpected value for --'{}': {}".format(
require_name, require))
if ctx.params[require_map[require]] is None:
raise click.ClickException(
"With {}={} must specify option --{}".format(
require_name, require, require_map[require]))
super(CommandOptionRequiredClass, self).invoke(ctx)
return CommandOptionRequiredClass
required_options = {
1: 'gs', # generator_string
2: 'nosp', # number_of_sample_points
3: 'nocp', # number_of_center_points
}
@click.command(context_settings=dict(max_content_width=800), cls=command_required_option_from_option('doe', required_options))
@click.option('--input', required=True, type=click.Path(exists=True), metavar='FILE', help="""\b
Path to csv file""" )
@click.option('--doe', required=True, type=int, help="""
\b
Select DOE algorithm:
1 Full factorial
2 2-level fractional factorial
3 Plackett-Burman
4 Sukharev grid
5 Box-Behnken
6 Box-Wilson (Central-composite) with center-faced option
7 Box-Wilson (Central-composite) with center inscribed
8 Box-Wilson (Central-composite) with centser-circumscribed option
9 Latin hypercube (simple)
10 Latin hypercube (space-filling)
11 Random k-means cluster
12 Maximin reconstruction
13 Halton sequence based
14 Uniform random matrix
...
""",)
@click.option( '--gs', required=False, type=str, help="""\b
Generator string for the fractional factorial build""")
@click.option( '--nosp', required=False, type=int, help="""\b
Number of random sample points""")
@click.option( '--nocp', required=False, type=int, help="""\b
Number of center points to be repeated (if more than one):""")
def main(input, doe, gs, nosp, nocp):
click.echo('input: {}'.format(input))
click.echo('doe: {}'.format(doe))
click.echo('generator_string: {}'.format(gs))
click.echo('Num of sample_points: {}'.format(nosp))
click.echo('Num of center_points: {}'.format(nocp))
if __name__ == "__main__":
main()
推荐答案
如果钩住click.formatting.wrap_text，则可以更改click.Command.get_help使用的换行器的行为.
If you hook click.formatting.wrap_text you can change the behavior of the line wrapper that click.Command.get_help uses.
由于您已经继承了click.Command，因此我们可以构建自己的get_help()版本来挂接换行器，例如:
Since you have already inherited from click.Command we can build our own version of get_help() to hook the line wrapper like:
def command_required_option_from_option(require_name, require_map):
class CommandOptionRequiredClass(click.Command):
def get_help(self, ctx):
orig_wrap_test = click.formatting.wrap_text
def wrap_text(text, width=78, initial_indent='',
subsequent_indent='',
preserve_paragraphs=False):
return orig_wrap_test(text.replace('\n', '\n\n'), width,
initial_indent=initial_indent,
subsequent_indent=subsequent_indent,
preserve_paragraphs=True
).replace('\n\n', '\n')
click.formatting.wrap_text = wrap_text
return super(CommandOptionRequiredClass, self).get_help(ctx)
return CommandOptionRequiredClass
这是如何工作的?
之所以有用，是因为click是一个设计良好的OO框架. @click.command()装饰器通常实例化click.Command对象，但允许使用cls参数覆盖此行为.因此，在我们自己的类中从click.Command继承并超越所需的方法是相对容易的事情.
How does this work?
This works because click is a well designed OO framework. The @click.command() decorator usually instantiates a click.Command object but allows this behavior to be over ridden with the cls parameter. So it is a relatively easy matter to inherit from click.Command in our own class and over ride desired methods.
在这种情况下，我们将覆盖click.Command.get_help().然后在我们的get_help()中，钩住click.formatting.wrap_text().在我们的钩子中，然后将preserve_paragraphs标志设置为True.另外，我们replace()所有\n都带有\n\n，因为这是原始wrap_text()期望标记段落的方式.
In this case, we override click.Command.get_help(). In our get_help() we then hook click.formatting.wrap_text(). In our hook, we then set the preserve_paragraphs flag to True. In addition we replace() all \n with \n\n as this is how the original wrap_text() expects paragraphs to be marked.
import click
required_options = {
1: 'gs', # generator_string
2: 'nosp', # number_of_sample_points
3: 'nocp', # number_of_center_points
}
@click.command(context_settings=dict(max_content_width=800),
cls=command_required_option_from_option('doe', required_options))
@click.option('--input', required=True, type=click.Path(exists=True),
metavar='FILE', help="""\b
Path to csv file""" )
@click.option('--doe', required=True, type=int, help="""
Select DOE algorithm:
1 Full factorial
2 2-level fractional factorial
3 Plackett-Burman
4 Sukharev grid
5 Box-Behnken
6 Box-Wilson (Central-composite) with center-faced option
7 Box-Wilson (Central-composite) with center inscribed
8 Box-Wilson (Central-composite) with center-circumscribed option
9 Latin hypercube (simple)
10 Latin hypercube (space-filling)
11 Random k-means cluster
12 Maximin reconstruction
13 Halton sequence based
14 Uniform random matrix
...
""",)
@click.option( '--gs', required=False, type=str, help="""\b
Generator string for the fractional factorial build""")
@click.option( '--nosp', required=False, type=int, help="""\b
Number of random sample points""")
@click.option( '--nocp', required=False, type=int, help="""\b
Number of center points to be repeated (if more than one):""")
def main(input, doe, gs, nosp, nocp):
click.echo('input: {}'.format(input))
click.echo('doe: {}'.format(doe))
click.echo('generator_string: {}'.format(gs))
click.echo('Num of sample_points: {}'.format(nosp))
click.echo('Num of center_points: {}'.format(nocp))
if __name__ == "__main__":
main(['--help'])
结果:
Usage: test.py [OPTIONS]
Options:
--input FILE
Path to csv file [required]
--doe INTEGER Select DOE algorithm:
1 Full factorial
2 2-level fractional factorial
3 Plackett-Burman
4 Sukharev grid
5 Box-Behnken
6 Box-Wilson (Central-composite) with center-faced option
7 Box-Wilson (Central-composite) with center inscribed
8 Box-Wilson (Central-composite) with center-circumscribed
option
9 Latin hypercube (simple)
10 Latin hypercube (space-filling)
11 Random k-means cluster
12 Maximin reconstruction
13 Halton sequence based
14 Uniform random matrix
... [required]
--gs TEXT
Generator string for the fractional factorial build
--nosp INTEGER
Number of random sample points
--nocp INTEGER
Number of center points to be repeated (if more than one):
--help Show this message and exit.
这篇关于python-click:格式化帮助文本的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
