@click.command()<\/p>\n@click.option('--age', type=click.INT, help='Your age.')<\/p>\n
@click.option('--city', type=click.STRING, help='City you live in.')<\/p>\n
def info(age, city):<\/p>\n
click.echo(f'You are {age} years old and live in {city}.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u4f7f\u7528\u5e03\u5c14\u503c\u548c\u6d6e\u70b9\u6570\u7c7b\u578b<\/h4>\n<\/p>\n
\u5e03\u5c14\u503c\u9009\u9879\u901a\u5e38\u7528\u4e8e\u5f00\u5173\u53c2\u6570\uff0c\u6d6e\u70b9\u6570\u7528\u4e8e\u9700\u8981\u5c0f\u6570\u7684\u573a\u666f\uff1a<\/p>\n<\/p>\n
@click.command()<\/p>\n@click.option('--verbose', is_flag=True, help='Enable verbose mode.')<\/p>\n
@click.option('--salary', type=click.FLOAT, help='Your monthly salary.')<\/p>\n
def details(verbose, salary):<\/p>\n
if verbose:<\/p>\n
click.echo('Verbose mode is on.')<\/p>\n
click.echo(f'Your salary is {salary}.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u56db\u3001CLICK\u547d\u4ee4\u5206\u7ec4<\/h3>\n<\/p>\n
Click\u5141\u8bb8\u5c06\u591a\u4e2a\u547d\u4ee4\u5206\u7ec4\u5230\u4e00\u8d77\uff0c\u8fd9\u5bf9\u4e8e\u521b\u5efa\u590d\u6742\u7684CLI\u5de5\u5177\u975e\u5e38\u6709\u7528\u3002\u53ef\u4ee5\u901a\u8fc7click.Group<\/code>\u6765\u5b9e\u73b0\uff1a<\/p>\n<\/p>\n@click.group()<\/p>\ndef cli():<\/p>\n
pass<\/p>\n
@cli.command()<\/p>\n
def greet():<\/p>\n
click.echo('Hello!')<\/p>\n
@cli.command()<\/p>\n
def farewell():<\/p>\n
click.echo('Goodbye!')<\/p>\n
if __name__ == '__main__':<\/p>\n
cli()<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u4e2a\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u5b9a\u4e49\u4e86\u4e00\u4e2a\u547d\u4ee4\u7ec4cli<\/code>\uff0c\u5e76\u5728\u5176\u4e2d\u6dfb\u52a0\u4e86greet<\/code>\u548cfarewell<\/code>\u4e24\u4e2a\u547d\u4ee4\u3002\u8fd0\u884c\u65f6\u53ef\u4ee5\u4f7f\u7528python script.py greet<\/code>\u6216python script.py farewell<\/code>\u6765\u8c03\u7528\u4e0d\u540c\u7684\u547d\u4ee4\u3002<\/p>\n<\/p>\n\u4e94\u3001CLICK\u53c2\u6570\u9a8c\u8bc1\u4e0e\u56de\u8c03<\/h3>\n<\/p>\n
Click\u5141\u8bb8\u5bf9\u53c2\u6570\u8fdb\u884c\u9a8c\u8bc1\uff0c\u5e76\u5728\u53c2\u6570\u89e3\u6790\u540e\u6267\u884c\u56de\u8c03\u51fd\u6570\u3002\u8fd9\u5bf9\u4e8e\u786e\u4fdd\u8f93\u5165\u7684\u6709\u6548\u6027\u975e\u5e38\u91cd\u8981\u3002<\/p>\n<\/p>\n
1. \u53c2\u6570\u9a8c\u8bc1<\/h4>\n<\/p>\n
\u53ef\u4ee5\u901a\u8fc7callback<\/code>\u53c2\u6570\u6765\u5b9e\u73b0\u53c2\u6570\u9a8c\u8bc1\uff1a<\/p>\n<\/p>\ndef validate_age(ctx, param, value):<\/p>\n if value < 0:<\/p>\n
raise click.BadParameter('Age cannot be negative.')<\/p>\n
return value<\/p>\n
@click.command()<\/p>\n
@click.option('--age', type=click.INT, callback=validate_age, help='Your age.')<\/p>\n
def show_age(age):<\/p>\n
click.echo(f'Your age is {age}.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u4f7f\u7528\u56de\u8c03\u51fd\u6570<\/h4>\n<\/p>\n
\u56de\u8c03\u51fd\u6570\u53ef\u4ee5\u5728\u53c2\u6570\u89e3\u6790\u540e\u6267\u884c\uff0c\u7528\u4e8e\u8fdb\u4e00\u6b65\u5904\u7406\u53c2\u6570\uff1a<\/p>\n<\/p>\n
def process_name(ctx, param, value):<\/p>\n return value.upper()<\/p>\n
@click.command()<\/p>\n
@click.option('--name', callback=process_name, help='Your name.')<\/p>\n
def display_name(name):<\/p>\n
click.echo(f'Your name in uppercase is {name}.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u516d\u3001CLICK\u7684\u4e0a\u4e0b\u6587\u5bf9\u8c61<\/h3>\n<\/p>\n
Click\u63d0\u4f9b\u4e86\u4e00\u4e2a\u4e0a\u4e0b\u6587\u5bf9\u8c61\uff0c\u53ef\u4ee5\u5728\u547d\u4ee4\u4e4b\u95f4\u5171\u4eab\u6570\u636e\u6216\u914d\u7f6e\u3002\u53ef\u4ee5\u901a\u8fc7click.Context<\/code>\u6765\u8bbf\u95ee\u4e0a\u4e0b\u6587\u5bf9\u8c61\uff1a<\/p>\n<\/p>\n@click.group()<\/p>\n@click.option('--debug', is_flag=True, help='Enable debug mode.')<\/p>\n
@click.pass_context<\/p>\n
def cli(ctx, debug):<\/p>\n
ctx.ensure_object(dict)<\/p>\n
ctx.obj['DEBUG'] = debug<\/p>\n
@cli.command()<\/p>\n
@click.pass_context<\/p>\n
def status(ctx):<\/p>\n
if ctx.obj['DEBUG']:<\/p>\n
click.echo('Debug mode is on.')<\/p>\n
else:<\/p>\n
click.echo('Debug mode is off.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u4e2a\u793a\u4f8b\u4e2d\uff0c\u6211\u4eec\u5728\u4e0a\u4e0b\u6587\u5bf9\u8c61\u4e2d\u5b58\u50a8\u4e86debug<\/code>\u72b6\u6001\uff0c\u5e76\u5728\u5b50\u547d\u4ee4\u4e2d\u8bbf\u95ee\u5b83\u3002<\/p>\n<\/p>\n\u4e03\u3001CLICK\u7684\u5b50\u547d\u4ee4\u548c\u547d\u4ee4\u94fe<\/h3>\n<\/p>\n
Click\u5141\u8bb8\u5b9a\u4e49\u5b50\u547d\u4ee4\u548c\u547d\u4ee4\u94fe\uff0c\u4f7f\u5f97\u4e00\u4e2a\u547d\u4ee4\u53ef\u4ee5\u8c03\u7528\u5176\u4ed6\u547d\u4ee4\u3002<\/p>\n<\/p>\n
1. \u5b9a\u4e49\u5b50\u547d\u4ee4<\/h4>\n<\/p>\n
\u53ef\u4ee5\u901a\u8fc7\u5c06\u5b50\u547d\u4ee4\u6dfb\u52a0\u5230\u547d\u4ee4\u7ec4\u4e2d\u6765\u5b9e\u73b0\uff1a<\/p>\n<\/p>\n
@click.group()<\/p>\ndef cli():<\/p>\n
pass<\/p>\n
@cli.command()<\/p>\n
def start():<\/p>\n
click.echo('Starting...')<\/p>\n
@cli.command()<\/p>\n
def stop():<\/p>\n
click.echo('Stopping...')<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u5b9e\u73b0\u547d\u4ee4\u94fe<\/h4>\n<\/p>\n
Click\u652f\u6301\u547d\u4ee4\u94fe\uff0c\u8fd9\u610f\u5473\u7740\u4e00\u4e2a\u547d\u4ee4\u53ef\u4ee5\u8c03\u7528\u5176\u4ed6\u547d\u4ee4\u3002\u53ef\u4ee5\u901a\u8fc7invoke<\/code>\u65b9\u6cd5\u6765\u5b9e\u73b0\uff1a<\/p>\n<\/p>\n@click.command()<\/p>\n@click.pass_context<\/p>\n
def parent(ctx):<\/p>\n
click.echo('Running parent command...')<\/p>\n
ctx.invoke(child)<\/p>\n
@click.command()<\/p>\n
def child():<\/p>\n
click.echo('Running child command...')<\/p>\n
if __name__ == '__main__':<\/p>\n
parent()<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u4e2a\u793a\u4f8b\u4e2d\uff0cparent<\/code>\u547d\u4ee4\u8c03\u7528\u4e86child<\/code>\u547d\u4ee4\u3002<\/p>\n<\/p>\n\u516b\u3001CLICK\u4e2d\u7684\u73af\u5883\u53d8\u91cf<\/h3>\n<\/p>\n
Click\u5141\u8bb8\u901a\u8fc7\u73af\u5883\u53d8\u91cf\u6765\u8bbe\u7f6e\u9009\u9879\u7684\u9ed8\u8ba4\u503c\u3002\u53ef\u4ee5\u4f7f\u7528auto_envvar_prefix<\/code>\u53c2\u6570\u6765\u6307\u5b9a\u73af\u5883\u53d8\u91cf\u524d\u7f00\uff1a<\/p>\n<\/p>\n@click.command()<\/p>\n@click.option('--config', envvar='MYAPP_CONFIG', help='Configuration file path.')<\/p>\n
def load_config(config):<\/p>\n
click.echo(f'Loading config from {config}.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u5728\u8fd9\u4e2a\u793a\u4f8b\u4e2d\uff0c\u5982\u679c\u547d\u4ee4\u884c\u4e2d\u6ca1\u6709\u6307\u5b9a--config<\/code>\u9009\u9879\uff0cClick\u5c06\u4ece\u73af\u5883\u53d8\u91cfMYAPP_CONFIG<\/code>\u4e2d\u83b7\u53d6\u9ed8\u8ba4\u503c\u3002<\/p>\n<\/p>\n\u4e5d\u3001CLICK\u7684\u9ad8\u7ea7\u7279\u6027<\/h3>\n<\/p>\n
Click\u8fd8\u63d0\u4f9b\u4e86\u4e00\u4e9b\u9ad8\u7ea7\u7279\u6027\uff0c\u4f8b\u5982\uff1a\u81ea\u5b9a\u4e49\u53c2\u6570\u7c7b\u578b\u3001\u5f02\u6b65\u547d\u4ee4\u3001\u547d\u4ee4\u522b\u540d\u7b49\u3002<\/p>\n<\/p>\n
1. \u81ea\u5b9a\u4e49\u53c2\u6570\u7c7b\u578b<\/h4>\n<\/p>\n
\u53ef\u4ee5\u901a\u8fc7\u7ee7\u627fclick.ParamType<\/code>\u6765\u521b\u5efa\u81ea\u5b9a\u4e49\u53c2\u6570\u7c7b\u578b\uff1a<\/p>\n<\/p>\nclass EvenNumber(click.ParamType):<\/p>\n name = 'even'<\/p>\n
def convert(self, value, param, ctx):<\/p>\n
try:<\/p>\n
ivalue = int(value)<\/p>\n
except ValueError:<\/p>\n
self.fail(f'{value} is not a valid integer', param, ctx)<\/p>\n
if ivalue % 2 != 0:<\/p>\n
self.fail(f'{value} is not an even number', param, ctx)<\/p>\n
return ivalue<\/p>\n
@click.command()<\/p>\n
@click.option('--number', type=EvenNumber(), help='An even number.')<\/p>\n
def check_number(number):<\/p>\n
click.echo(f'{number} is an even number.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
2. \u5f02\u6b65\u547d\u4ee4<\/h4>\n<\/p>\n
Click\u652f\u6301\u5f02\u6b65\u547d\u4ee4\uff0c\u53ef\u4ee5\u901a\u8fc7async<\/code>\u5173\u952e\u5b57\u6765\u5b9a\u4e49\u5f02\u6b65\u51fd\u6570\uff1a<\/p>\n<\/p>\n@click.command()<\/p>\nasync def async_command():<\/p>\n
await asyncio.sleep(1)<\/p>\n
click.echo('Async command completed.')<\/p>\n
<\/code><\/pre>\n<\/p>\n
3. \u547d\u4ee4\u522b\u540d<\/h4>\n<\/p>\n
\u53ef\u4ee5\u4e3a\u547d\u4ee4\u5b9a\u4e49\u522b\u540d\uff0c\u4f7f\u5176\u53ef\u4ee5\u901a\u8fc7\u591a\u79cd\u540d\u79f0\u8c03\u7528\uff1a<\/p>\n<\/p>\n
@click.command(name='start', aliases=['run', 'execute'])<\/p>\ndef start_command():<\/p>\n
click.echo('Starting...')<\/p>\n
<\/code><\/pre>\n<\/p>\n
\u603b\u7ed3<\/h3>\n<\/p>\n
Click\u662f\u4e00\u4e2a\u529f\u80fd\u5f3a\u5927\u4e14\u6613\u4e8e\u4f7f\u7528\u7684Python\u5e93\uff0c\u7528\u4e8e\u521b\u5efa\u547d\u4ee4\u884c\u63a5\u53e3\u3002\u901a\u8fc7\u672c\u6587\u7684\u4ecb\u7ecd\uff0c\u6211\u4eec\u4e86\u89e3\u4e86Click\u7684\u57fa\u672c\u7528\u6cd5\u3001\u53c2\u6570\u7c7b\u578b\u3001\u547d\u4ee4\u5206\u7ec4\u3001\u53c2\u6570\u9a8c\u8bc1\u3001\u4e0a\u4e0b\u6587\u5bf9\u8c61\u3001\u5b50\u547d\u4ee4\u3001\u73af\u5883\u53d8\u91cf\u4ee5\u53ca\u4e00\u4e9b\u9ad8\u7ea7\u7279\u6027\u3002\u901a\u8fc7\u8fd9\u4e9b\u77e5\u8bc6\uff0c\u60a8\u53ef\u4ee5\u521b\u5efa\u529f\u80fd\u4e30\u5bcc\u4e14\u7528\u6237\u53cb\u597d\u7684CLI\u5de5\u5177\u3002\u65e0\u8bba\u662f\u7b80\u5355\u7684\u811a\u672c\u8fd8\u662f\u590d\u6742\u7684\u5e94\u7528\u7a0b\u5e8f\uff0cClick\u90fd\u80fd\u5e2e\u52a9\u60a8\u8f7b\u677e\u5b9e\u73b0\u547d\u4ee4\u884c\u63a5\u53e3\u7684\u5f00\u53d1\u3002<\/p>\n<\/p>\n
\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n \u5982\u4f55\u5728Python\u4e2d\u5b89\u88c5Click\u5e93\uff1f<\/strong>
\u8981\u5728Python\u4e2d\u4f7f\u7528Click\u5e93\uff0c\u9996\u5148\u9700\u8981\u786e\u4fdd\u4f60\u5df2\u7ecf\u5b89\u88c5\u4e86\u5b83\u3002\u53ef\u4ee5\u901a\u8fc7\u5728\u547d\u4ee4\u884c\u4e2d\u8fd0\u884c\u4ee5\u4e0b\u547d\u4ee4\u6765\u5b89\u88c5\uff1a <\/p>\npip install click\n<\/code><\/pre>\n\u5b89\u88c5\u5b8c\u6210\u540e\uff0c\u53ef\u4ee5\u5728\u4f60\u7684Python\u811a\u672c\u4e2d\u5bfc\u5165Click\u5e93\u5e76\u5f00\u59cb\u4f7f\u7528\u3002<\/p>\n
Click\u547d\u4ee4\u884c\u5de5\u5177\u7684\u57fa\u672c\u7528\u6cd5\u662f\u4ec0\u4e48\uff1f<\/strong>
Click\u5141\u8bb8\u5f00\u53d1\u8005\u8f7b\u677e\u521b\u5efa\u547d\u4ee4\u884c\u5de5\u5177\u3002\u57fa\u672c\u4f7f\u7528\u65b9\u6cd5\u5305\u62ec\u5b9a\u4e49\u4e00\u4e2a\u51fd\u6570\uff0c\u5e76\u4f7f\u7528@click.command()<\/code>\u88c5\u9970\u5668\u6765\u5c06\u5176\u8f6c\u6362\u4e3a\u547d\u4ee4\u3002\u53ef\u4ee5\u901a\u8fc7\u6dfb\u52a0\u53c2\u6570\u548c\u9009\u9879\u6765\u589e\u5f3a\u547d\u4ee4\u7684\u529f\u80fd\u3002\u4f8b\u5982\uff1a <\/p>\nimport click\n\n@click.command()\n@click.argument('name')\ndef greet(name):\n click.echo(f'Hello, {name}!')\n\nif __name__ == '__main__':\n greet()\n<\/code><\/pre>\n\u5728\u547d\u4ee4\u884c\u4e2d\u8fd0\u884c\u8fd9\u4e2a\u811a\u672c\u65f6\uff0c\u53ef\u4ee5\u4f20\u5165\u4e00\u4e2a\u540d\u5b57\u4f5c\u4e3a\u53c2\u6570\u3002<\/p>\n
\u5982\u4f55\u4e3aClick\u547d\u4ee4\u6dfb\u52a0\u5e2e\u52a9\u4fe1\u606f\u548c\u9009\u9879\uff1f<\/strong>
Click\u63d0\u4f9b\u4e86\u7b80\u4fbf\u7684\u65b9\u6cd5\u6765\u4e3a\u547d\u4ee4\u6dfb\u52a0\u5e2e\u52a9\u4fe1\u606f\u3002\u53ef\u4ee5\u5728\u88c5\u9970\u5668\u4e2d\u4f7f\u7528help<\/code>\u53c2\u6570\u6765\u63cf\u8ff0\u547d\u4ee4\u7684\u529f\u80fd\uff0c\u6b64\u5916\uff0c\u8fd8\u53ef\u4ee5\u4f7f\u7528@click.option()<\/code>\u6765\u5b9a\u4e49\u9009\u9879\u3002\u4f8b\u5982\uff1a <\/p>\n@click.command(help='Greet a user with their name.')\n@click.option('--times', default=1, help='Number of times to greet.')\n@click.argument('name')\ndef greet(name, times):\n for _ in range(times):\n click.echo(f'Hello, {name}!')\n<\/code><\/pre>\n\u8fd0\u884c\u65f6\uff0c\u53ef\u4ee5\u901a\u8fc7--help<\/code>\u9009\u9879\u67e5\u770b\u5e2e\u52a9\u4fe1\u606f\uff0c\u5e2e\u52a9\u7528\u6237\u4e86\u89e3\u5982\u4f55\u4f7f\u7528\u547d\u4ee4\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"Python\u4e2d\u4f7f\u7528Click\u547d\u4ee4\u7684\u6838\u5fc3\u5728\u4e8e\uff1a\u7b80\u5316\u547d\u4ee4\u884c\u63a5\u53e3\u7684\u521b\u5efa\u3001\u63d0\u4f9b\u5f3a\u5927\u7684\u547d\u4ee4\u884c\u53c2\u6570\u89e3\u6790\u3001\u652f\u6301\u81ea\u52a8\u751f\u6210\u5e2e\u52a9\u6587 […]","protected":false},"author":3,"featured_media":1015975,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1015966"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=1015966"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1015966\/revisions"}],"predecessor-version":[{"id":1015979,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1015966\/revisions\/1015979"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/1015975"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=1015966"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=1015966"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=1015966"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
![\"python\u5982\u4f55\u7528click\u547d\u4ee4\"](\"https:\/\/cdn-kb.worktile.com\/kb\/wp-content\/uploads\/2024\/04\/25095647\/29271711-0b04-4412-a8ab-c7ba5b646386.webp\")
<\/p>\n