管理 0.1.15

1. 使用自定义 click_commands 模块（单个文件）

假设您在应用程序中有一个命令模块，您在那里编写自定义命令，manage 将加载它

# myproject/commands.py
import click
@click.command()
@click.option('--name')
@click.option('--passwd')
def create_user(name, passwd):
    """Create a new user"""
    click.echo('Creating the user...')
    mysystem.User.create(name, password)

现在您转到您的 manage.yml 或 .manage.yml 并指定您的自定义命令模块。

click_commands:
  - module: commands

现在您运行 manage –help

$ manage --help
...
Commands:
  create_user  Create a new user
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

使用 click_commands 包（多个文件）

通常会有不同的文件来保存您的命令，因此您可能更喜欢拥有一个 commands/ 包和一些 python 模块在其中保存命令。

# myproject/commands/user.py
import click
@click.command()
@click.option('--name')
@click.option('--passwd')
def create_user(name, passwd):
    """Create a new user"""
    click.echo('Creating the user...')
    mysystem.User.create(name, password)

# myproject/commands/system.py
import click
@click.command()
def clear_cache():
    """Clear the system cache"""
    click.echo('The cache will be erased...')
    mysystem.cache.clear()

现在您想将所有这些命令添加到您的 manage 中，通过编辑 manage 文件来实现。

click_commands:
  - module: commands

现在您运行 manage –help 并您将看到来自这两个模块的命令。

$ manage --help
...
Commands:
  create_user  Create a new user
  clear_cache  Clear the system cache
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

自定义 click_command 名称

有时命令的名称与函数的名称不同，因此您可以自定义它。

click_commands:
  - module: commands.system
    config:
      clear_cache:
        name: reset_cache
        help_text: This resets the cache
  - module: commands.user
    config:
      create_user:
        name: new_user
        help_text: This creates new user

具有不同的命名空间

如果您觉得自定义名称工作量太大，只是试图处理命名冲突，您可以使用命名空间命令。

namespaced: true
click_commands:
  - module: commands

现在您运行 manage –help 并您可以看到同一模块中的所有命令都将以 modulename_ 命名空间。

$ manage --help
...
Commands:
  user_create_user    Create a new user
  system_clear_cache  Clear the system cache
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

您甚至可以分别为每个模块单独自定义命名空间。

click_commands:
  - module: commands.system
    namespace: sys
  - module: commands.user
    namespace: user

现在运行 manage –help，您将看到同一模块中的所有命令都将具有命名空间。

$ manage --help
...
Commands:
  user_create_user  Create a new user
  sys_clear_cache  Clear the system cache
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

2. 在 manage 文件中直接定义您的内联命令

有时您的命令非常简单，您不想（或不能）创建自定义模块，因此您可以直接将所有命令放入 yaml 文件中。

inline_commands:
  - name: clear_cache
    help_text: Executes inline code to clear the cache
    context:
      - sys
      - pprint
    options:
      --days:
        default: 100
    code: |
      pprint.pprint({'clean_days': days, 'path': sys.path})

现在运行 manage –help

$ manage --help
...
Commands:
  clear_cache  Executes inline code to clear the cache
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

并且您可以使用以下方式运行：

$ manage clear_cache --days 15

3. 使用通用函数作为命令

如果您已经定义了一些函数（任何可调用的函数）。

# my_system.functions.py
def create_user(name, password):
    print("Creating user %s" % name)

function_commands:
  - function: my_system.functions.create_user
    name: new_user
    help_text: Create new user
    options:
      --name:
        required: true
      --password:
        required: true

现在运行 manage –help

$ manage --help
...
Commands:
  new_user     Create new user
  debug        Shows the parsed manage file
  init         Initialize a manage shell in current...
  shell        Runs a Python shell with context

$ manage new_user --name=Bruno --password=1234
Creating user Bruno

0.1.15 (2021-02-07)

• 修复 yaml 消息。

• 修复 pypi 中的描述。

0.1.12 (2016-08-15)

• Readline 是可选的，因为与 MacOS 兼容。

0.1.11 (2016-08-15)

• 子模块导入

• 多个 'as' 名称

0.1.10 (2016-07-04)

• Bpython 已添加

0.1.9 (2016-07-03)

• Bpython 已添加

0.1.8 (2016-07-03)

• 修复 Python 3 字典问题

0.1.7 (2016-06-26)

• 修复 py3 中的 exec 错误

0.1.6 (2016-06-26)

• 修复 exec 错误

0.1.5 (2016-06-25)

• 添加对命令收集器的支持（请参阅 quokka cms）

0.1.4 (2016-06-22)

• 修复缺少的依赖项

0.1.3 (2016-06-19)

• 支持 function_commands

0.1.2 (2016-06-17)

• 支持 inline_commands

0.1.1 (2016-06-14)

• 支持自定义和隐藏 manage_file

0.1.0 (2016-06-09)

• 首次发布在 PyPI 上。