Hướng dẫn python cli application example - ví dụ về ứng dụng python cli

Thiết lập môi trường làm việc

Trong phần này, bạn sẽ tạo ra một môi trường ảo Python để làm việc trong dự án việc cần làm của mình. Sử dụng môi trường ảo cho mỗi dự án độc lập là một thực tiễn tốt nhất trong lập trình Python. Nó cho phép bạn cô lập các phụ thuộc dự án của bạn mà không làm lộn xộn cài đặt Python hệ thống của bạn hoặc phá vỡ các dự án khác sử dụng các phiên bản khác nhau của cùng một công cụ và thư viện.

Để tạo môi trường ảo Python, hãy chuyển sang thư mục làm việc yêu thích của bạn và tạo một thư mục gọi là

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

$ cd rptodo_project/
$ python -m venv ./venv
$ source venv/bin/activate
(venv) $

Tại đây, trước tiên bạn nhập thư mục

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

Lệnh thứ ba kích hoạt môi trường ảo bạn vừa tạo. Bạn biết rằng môi trường đang hoạt động vì lời nhắc của bạn thay đổi thành một thứ như

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

Bây giờ bạn có một môi trường ảo hoạt động, bạn cần cài đặt Typer để tạo ứng dụng CLI và pytest để kiểm tra mã ứng dụng của bạn. Để cài đặt Typer với tất cả các phụ thuộc tùy chọn hiện tại của nó, hãy chạy lệnh sau:

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Lệnh này cài đặt Typer và tất cả các phụ thuộc được đề xuất của nó, chẳng hạn như Colorama, đảm bảo rằng màu sắc hoạt động chính xác trên cửa sổ dòng lệnh của bạn.

Để cài đặt pytest, mà bạn sẽ sử dụng sau để kiểm tra ứng dụng việc cần làm của mình, hãy chạy lệnh sau:

(venv) $ python -m pip install pytest==6.2.4

Với lệnh cuối cùng này, bạn đã cài đặt thành công tất cả các công cụ bạn cần để bắt đầu phát triển ứng dụng việc cần làm của mình. Phần còn lại của các thư viện và công cụ bạn sẽ sử dụng là một phần của thư viện tiêu chuẩn Python, vì vậy bạn không phải cài đặt bất cứ thứ gì để sử dụng chúng.

Xác định bố cục dự án

Bước cuối cùng bạn sẽ chạy để hoàn thành việc thiết lập dự án ứng dụng việc cần làm của mình là tạo các gói, mô-đun và tệp sẽ đóng khung bố cục ứng dụng. Gói lõi ứng dụng sẽ sống trong thư mục

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

Tại đây, một mô tả về gói nội dung của gói:

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Bạn cũng sẽ cần một thư mục

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Đi trước và tạo bố cục dự án với cấu trúc sau:

rptodo_project/
│
├── rptodo/
│   ├── __init__.py
│   ├── __main__.py
│   ├── cli.py
│   ├── config.py
│   ├── database.py
│   └── rptodo.py
│
├── tests/
│   ├── __init__.py
│   └── test_rptodo.py
│
├── README.md
└── requirements.txt

Tệp

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Tệp

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Bây giờ người dùng của bạn có thể tự động cài đặt các phụ thuộc được liệt kê bằng cách chạy lệnh sau:

(venv) $ python -m pip install -r requirements.txt

Cung cấp một

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Ngoại trừ

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Tạo ứng dụng Typer CLI

Trong phần này, bạn sẽ tạo một ứng dụng Typer CLI tối thiểu với sự hỗ trợ cho các tùy chọn

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Đi trước và mở

(venv) $ python -m rptodo -v
rptodo v0.1.0

(venv) $ python -m rptodo --help
Usage: rptodo [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version         Show the application's version and exit.
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it
                        or customize the installation.

  --help                Show this message and exit.

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

Typer sử dụng gợi ý loại Python rộng rãi, vì vậy trong hướng dẫn này, bạn cũng sẽ sử dụng chúng. Đó là lý do tại sao bạn bắt đầu bằng cách nhập

(venv) $ python -m rptodo -v
rptodo v0.1.0

(venv) $ python -m rptodo --help
Usage: rptodo [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version         Show the application's version and exit.
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it
                        or customize the installation.

  --help                Show this message and exit.

(venv) $ python -m rptodo -v
rptodo v0.1.0

(venv) $ python -m rptodo --help
Usage: rptodo [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version         Show the application's version and exit.
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it
                        or customize the installation.

  --help                Show this message and exit.

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Đây là cách mà phần còn lại của mã hoạt động:

• Dòng 10 tạo ra một ứng dụng Typer rõ ràng,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  04. creates an explicit Typer application,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  04.

• Dòng 12 đến 15 Xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  05. Hàm này có một đối số boolean gọi là

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  06. Nếu

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  06 là

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  08, thì hàm sẽ in tên và phiên bản ứng dụng bằng cách sử dụng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  09. Sau đó, nó làm tăng một ngoại lệ

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  10 để thoát khỏi ứng dụng một cách sạch sẽ. define

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  05. This function takes a Boolean argument called

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  06. If

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  06 is

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  08, then the function prints the application’s name and version using

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  09. After that, it raises a

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  10 exception to exit the application cleanly.

• Các dòng 17 và 18 định nghĩa

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  11 là một cuộc gọi lại Typer bằng cách sử dụng trình trang trí

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  12. define

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  11 as a Typer callback using the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  12 decorator.

• Dòng 19 xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13, thuộc loại

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  14. Điều này có nghĩa là nó có thể là loại

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  15 hoặc

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  16. Đối số

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 mặc định là đối tượng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  18, cho phép bạn tạo các tùy chọn dòng lệnh trong Typer. defines

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13, which is of type

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  14. This means it can be either of

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  15 or

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  16 type. The

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 argument defaults to a

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  18 object, which allows you to create command-line options in Typer.

• Dòng 20 vượt qua

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  16 là đối số đầu tiên cho trình khởi tạo của

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  20. Đối số này là bắt buộc và cung cấp giá trị mặc định của tùy chọn. passes

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  16 as the first argument to the initializer of

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  20. This argument is required and supplies the option’s default value.

• Các dòng 21 và 22 Đặt tên dòng lệnh cho tùy chọn

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13:

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  7 và

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  8. set the command-line names for the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 option:

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  7 and

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  8.

• Dòng 23 cung cấp thông báo

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  24 cho tùy chọn

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13. provides a

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  24 message for the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 option.

• Dòng 24 đính kèm chức năng gọi lại,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  05, vào tùy chọn

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13, có nghĩa là chạy tùy chọn tự động gọi hàm. attaches a callback function,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  05, to the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 option, which means that running the option automatically calls the function.

• Dòng 25 đặt đối số

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  28 thành

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  08. Đối số này cho Typer rằng tùy chọn dòng lệnh

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 được ưu tiên hơn các lệnh khác trong ứng dụng hiện tại. sets the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  28 argument to

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  08. This argument tells Typer that the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  13 command-line option has precedence over other commands in the current application.

Với mã này, bạn đã sẵn sàng để tạo tập lệnh điểm nhập của ứng dụng. Đó là những gì bạn sẽ làm trong phần sau.

Tạo tập lệnh điểm nhập cảnh

Bạn gần như đã sẵn sàng để chạy ứng dụng việc cần làm của mình lần đầu tiên. Trước khi làm điều đó, bạn nên tạo một tập lệnh nhập cảnh cho ứng dụng. Bạn có thể tạo tập lệnh này theo một vài cách khác nhau. Trong hướng dẫn này, bạn sẽ thực hiện nó bằng mô -đun

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

Quay trở lại Trình chỉnh sửa mã của bạn và mở

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Trong

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Với sự bổ sung cuối cùng này, bạn đã sẵn sàng để chạy ứng dụng việc cần làm của mình lần đầu tiên. Di chuyển đến cửa sổ thiết bị đầu cuối của bạn và thực hiện các lệnh sau:

(venv) $ python -m rptodo -v
rptodo v0.1.0

(venv) $ python -m rptodo --help
Usage: rptodo [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --version         Show the application's version and exit.
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it
                        or customize the installation.

  --help                Show this message and exit.

Lệnh đầu tiên chạy tùy chọn

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Thiết lập các bài kiểm tra CLI ban đầu với pytest

Hành động cuối cùng mà bạn sẽ chạy trong phần này là thiết lập bộ thử nghiệm ban đầu cho ứng dụng việc cần làm của bạn. Để kết thúc này, bạn đã tạo gói

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

Kiểm tra ứng dụng Typer rất đơn giản vì thư viện tích hợp khá tốt với pytest. Bạn có thể sử dụng một lớp Typer có tên

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Quay trở lại Trình chỉnh sửa mã của bạn và mở

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

"""RP To-Do entry point script."""
# rptodo/__main__.py

from rptodo import cli, __app_name__

def main():
    cli.app(prog_name=__app_name__)

if __name__ == "__main__":
    main()

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Đây là những gì mã này làm:

• Dòng 3 nhập

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  1 từ

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  55. imports

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  1 from

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  55.
• Dòng 5 nhập một vài đối tượng bắt buộc từ gói

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  6 của bạn. imports a few required objects from your

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  6 package.
• Dòng 7 tạo ra một người chạy CLI bằng cách khởi tạo

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  1. creates a CLI runner by instantiating

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  1.
• Dòng 9 xác định thử nghiệm đơn vị đầu tiên của bạn để kiểm tra phiên bản ứng dụng. defines your first unit test for testing the application’s version.
• Dòng 10 gọi

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  58 trên

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  59 để chạy ứng dụng với tùy chọn

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  8. Bạn lưu trữ kết quả của cuộc gọi này trong

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  61. calls

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  58 on

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  59 to run the application with the

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  8 option. You store the result of this call in

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  61.
• Dòng 11 khẳng định rằng mã thoát của ứng dụng (

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  62) bằng với

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  63 để kiểm tra xem ứng dụng có chạy thành công không. asserts that the application’s exit code (

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  62) is equal to

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  63 to check that the application ran successfully.
• Dòng 12 khẳng định rằng phiên bản ứng dụng có mặt trong đầu ra tiêu chuẩn, có sẵn thông qua

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  64. asserts that the application’s version is present in the standard output, which is available through

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  64.

Typer sườn

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Bây giờ bạn đã thiết lập thử nghiệm đơn vị đầu tiên cho ứng dụng Typer CLI của bạn, bạn có thể chạy thử nghiệm với pytest. Quay trở lại dòng lệnh của bạn và thực thi

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Đó là nó! Bạn đã chạy thành công bộ thử nghiệm của mình lần đầu tiên! Vâng, bạn chỉ có một bài kiểm tra cho đến nay. Tuy nhiên, bạn sẽ thêm nhiều trong số chúng vào các phần sắp tới. Bạn cũng có thể thêm bài kiểm tra của riêng bạn nếu bạn muốn thách thức các kỹ năng kiểm tra của mình.

Với ứng dụng cần làm bộ xương, bây giờ bạn có thể nghĩ về việc thiết lập cơ sở dữ liệu việc cần làm để sẵn sàng sử dụng. Đó là những gì bạn sẽ làm trong phần sau.

Thiết lập các cấu hình ứng dụng

Bạn có thể sử dụng các kỹ thuật khác nhau để xác định cách ứng dụng kết nối và mở tệp trên hệ thống tệp của bạn. Bạn có thể cung cấp đường dẫn tệp một cách linh hoạt, tạo một biến môi trường để giữ đường dẫn tệp, tạo tệp cấu hình trong đó bạn lưu trữ đường dẫn tệp, v.v.

Trong hướng dẫn này, bạn sẽ cung cấp ứng dụng việc cần làm của mình với một tệp cấu hình trong thư mục nhà của bạn để lưu trữ đường dẫn đến cơ sở dữ liệu. Cuối cùng, bạn sẽ sử dụng

"""Top-level package for RP To-Do."""
# rptodo/__init__.py

__app_name__ = "rptodo"
__version__ = "0.1.0"

(
    SUCCESS,
    DIR_ERROR,
    FILE_ERROR,
    DB_READ_ERROR,
    DB_WRITE_ERROR,
    JSON_ERROR,
    ID_ERROR,
) = range(7)

ERRORS = {
    DIR_ERROR: "config directory error",
    FILE_ERROR: "config file error",
    DB_READ_ERROR: "database read error",
    DB_WRITE_ERROR: "database write error",
    ID_ERROR: "to-do id error",
}

typer==0.3.2
colorama==0.4.4
shellingham==1.4.0
pytest==6.2.4

Bây giờ hãy quay lại trình chỉnh sửa mã của bạn và mở

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Ở đây, một sự cố về những gì mã này làm:

• Dòng 4 Nhập khẩu

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  3. Mô -đun này cung cấp lớp

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  78, cho phép bạn xử lý các tệp cấu hình có cấu trúc tương tự như các tệp INI. imports

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  3. This module provides the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  78 class, which allows you to handle config files with a structure similar to INI files.

• Dòng 5 Nhập khẩu

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  79 từ

  """Top-level package for RP To-Do."""
  # rptodo/__init__.py
  
  __app_name__ = "rptodo"
  __version__ = "0.1.0"
  
  (
      SUCCESS,
      DIR_ERROR,
      FILE_ERROR,
      DB_READ_ERROR,
      DB_WRITE_ERROR,
      JSON_ERROR,
      ID_ERROR,
  ) = range(7)
  
  ERRORS = {
      DIR_ERROR: "config directory error",
      FILE_ERROR: "config file error",
      DB_READ_ERROR: "database read error",
      DB_WRITE_ERROR: "database write error",
      ID_ERROR: "to-do id error",
  }
  

  0. Lớp này cung cấp một cách đa nền tảng để xử lý các đường dẫn hệ thống. imports

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  79 from

  """Top-level package for RP To-Do."""
  # rptodo/__init__.py
  
  __app_name__ = "rptodo"
  __version__ = "0.1.0"
  
  (
      SUCCESS,
      DIR_ERROR,
      FILE_ERROR,
      DB_READ_ERROR,
      DB_WRITE_ERROR,
      JSON_ERROR,
      ID_ERROR,
  ) = range(7)
  
  ERRORS = {
      DIR_ERROR: "config directory error",
      FILE_ERROR: "config file error",
      DB_READ_ERROR: "database read error",
      DB_WRITE_ERROR: "database write error",
      ID_ERROR: "to-do id error",
  }
  

  0. This class provides a cross-platform way to handle system paths.

• Dòng 7 Nhập khẩu

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  00. imports

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  00.

• Dòng 9 đến 11 Nhập một loạt các đối tượng cần thiết từ

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  6. import a bunch of required objects from

  typer==0.3.2
  colorama==0.4.4
  shellingham==1.4.0
  pytest==6.2.4
  

  6.

• Dòng 13 tạo ra

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  83 để giữ đường dẫn đến thư mục ứng dụng. Để có được đường dẫn này, bạn gọi

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  84 với tên ứng dụng là một đối số. Hàm này trả về một chuỗi đại diện cho đường dẫn đến một thư mục nơi bạn có thể lưu trữ cấu hình. creates

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  83 to hold the path to the app’s directory. To get this path, you call

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  84 with the application’s name as an argument. This function returns a string representing the path to a directory where you can store configurations.

• Dòng 14 xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  85 để giữ đường dẫn đến chính tệp cấu hình. defines

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  85 to hold the path to the configuration file itself.

• Dòng 16 xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86. Hàm này khởi tạo tệp cấu hình và cơ sở dữ liệu của ứng dụng. defines

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86. This function initializes the application’s configuration file and database.

• Dòng 18 gọi hàm trợ giúp

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  87 mà bạn xác định trong các dòng 26 đến 35. Gọi hàm này tạo thư mục cấu hình bằng cách sử dụng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  88. Nó cũng tạo tệp cấu hình bằng cách sử dụng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  89. Cuối cùng,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  87 trả về mã lỗi thích hợp nếu có điều gì đó sai xảy ra trong quá trình tạo thư mục và tệp. Nó trả về

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 nếu mọi thứ đều ổn. calls the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  87 helper function, which you define in lines 26 to 35. Calling this function creates the configuration directory using

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  88. It also creates the configuration file using

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  89. Finally,

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  87 returns the proper error codes if something wrong happens during the creation of the directory and file. It returns

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 if everything goes okay.

• Dòng 19 Kiểm tra xem có xảy ra lỗi trong quá trình tạo tệp thư mục và cấu hình không và dòng 20 trả về mã lỗi tương ứng. checks if an error occurs during the creation of the directory and configuration file, and line 20 returns the error code accordingly.

• Dòng 21 gọi hàm trợ giúp

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  92, tạo ra cơ sở dữ liệu việc cần làm. Hàm này trả về các mã lỗi thích hợp nếu có điều gì đó xảy ra trong khi tạo cơ sở dữ liệu. Nó trả về

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 nếu quá trình thành công. calls the

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  92 helper function, which creates the to-do database. This function returns the appropriate error codes if something happens while creating the database. It returns

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 if the process succeeds.

• Dòng 22 kiểm tra xem có xảy ra lỗi trong quá trình tạo cơ sở dữ liệu không. Nếu vậy, dòng 23 trả về mã lỗi tương ứng. checks if an error occurs during the creation of the database. If so, then line 23 returns the corresponding error code.

• Dòng 24 trả về

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 nếu mọi thứ chạy ổn. returns

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91 if everything runs okay.

Với mã này, bạn đã hoàn thành việc thiết lập tệp cấu hình ứng dụng để lưu trữ đường dẫn đến cơ sở dữ liệu việc cần làm. Bạn cũng đã thêm mã để tạo cơ sở dữ liệu việc cần làm dưới dạng tệp JSON. Bây giờ bạn có thể viết mã để khởi tạo cơ sở dữ liệu và sẵn sàng sử dụng. Đó là những gì bạn sẽ làm trong phần sau.

Chuẩn bị sẵn sàng sử dụng cơ sở dữ liệu việc cần làm

Để có cơ sở dữ liệu cần làm sẵn sàng để sử dụng, bạn cần thực hiện hai hành động. Đầu tiên, bạn cần một cách để truy xuất đường dẫn tệp cơ sở dữ liệu từ tệp cấu hình ứng dụng. Thứ hai, bạn cần khởi tạo cơ sở dữ liệu để giữ nội dung JSON.

Mở

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Trong tệp này, dòng 4 đến 7 thực hiện nhập khẩu cần thiết. Ở đây, những gì phần còn lại của mã làm:

• Các dòng 9 đến 11 Xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  97 để giữ đường dẫn tệp cơ sở dữ liệu mặc định. Ứng dụng sẽ sử dụng đường dẫn này nếu người dùng không cung cấp tùy chỉnh. define

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  97 to hold the default database file path. The application will use this path if the user doesn’t provide a custom one.

• Dòng 13 đến 17 Xác định

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  98. Hàm này đưa đường dẫn đến tệp cấu hình ứng dụng làm đối số, đọc tệp đầu vào bằng cách sử dụng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  99 và trả về đối tượng

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  79 đại diện cho đường dẫn đến cơ sở dữ liệu cần làm trên hệ thống tệp của bạn. Ví dụ

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  78 lưu trữ dữ liệu trong một từ điển. Khóa

  (venv) $ python -m pip install pytest==6.2.4
  

  02 đại diện cho phần tệp lưu trữ thông tin cần thiết. Khóa

  (venv) $ python -m pip install pytest==6.2.4
  

  03 lấy đường dẫn cơ sở dữ liệu. define

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  98. This function takes the path to the app’s config file as an argument, reads the input file using

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  99, and returns a

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  79 object representing the path to the to-do database on your file system. The

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  78 instance stores the data in a dictionary. The

  (venv) $ python -m pip install pytest==6.2.4
  

  02 key represents the file section that stores the required information. The

  (venv) $ python -m pip install pytest==6.2.4
  

  03 key retrieves the database path.

• Dòng 19 đến 25 Xác định

  (venv) $ python -m pip install pytest==6.2.4
  

  04. Hàm này lấy một đường dẫn cơ sở dữ liệu và ghi một chuỗi đại diện cho một danh sách trống. Bạn gọi

  (venv) $ python -m pip install pytest==6.2.4
  

  05 trên đường dẫn cơ sở dữ liệu và danh sách khởi tạo cơ sở dữ liệu JSON với danh sách việc cần làm trống. Nếu quá trình chạy thành công, thì

  (venv) $ python -m pip install pytest==6.2.4
  

  04 sẽ trả về

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91. Nếu không, nó trả về mã lỗi thích hợp. define

  (venv) $ python -m pip install pytest==6.2.4
  

  04. This function takes a database path and writes a string representing an empty list. You call

  (venv) $ python -m pip install pytest==6.2.4
  

  05 on the database path, and the list initializes the JSON database with an empty to-do list. If the process runs successfully, then

  (venv) $ python -m pip install pytest==6.2.4
  

  04 returns

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  91. Otherwise, it returns the appropriate error code.

Mát mẻ! Bây giờ bạn có một cách để truy xuất đường dẫn tệp cơ sở dữ liệu từ tệp cấu hình ứng dụng. Bạn cũng có một cách để khởi tạo cơ sở dữ liệu với một danh sách việc cần làm trống ở định dạng JSON. Đó là thời gian để thực hiện lệnh

(venv) $ python -m pip install -r requirements.txt

Thực hiện lệnh (venv) $ python -m pip install -r requirements.txt 0 CLI

Bước cuối cùng để kết hợp tất cả các mã mà bạn đã viết trong phần này là thêm lệnh

(venv) $ python -m pip install -r requirements.txt

Đi trước và thêm

(venv) $ python -m pip install pytest==6.2.4

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Ở đây, cách thức hoạt động của mã mới này:

• Dòng 4 và 9 cập nhật nhập khẩu cần thiết. update the required imports.

• Các dòng 13 và 14 định nghĩa

  (venv) $ python -m pip install pytest==6.2.4
  

  11 là lệnh Typer bằng cách sử dụng trình trang trí

  (venv) $ python -m pip install pytest==6.2.4
  

  14. define

  (venv) $ python -m pip install pytest==6.2.4
  

  11 as a Typer command using the

  (venv) $ python -m pip install pytest==6.2.4
  

  14 decorator.

• Các dòng 15 đến 20 Xác định một thể hiện Typer

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  20 và gán nó là giá trị mặc định cho

  (venv) $ python -m pip install pytest==6.2.4
  

  16. Để cung cấp giá trị cho tùy chọn này, người dùng của bạn cần sử dụng

  (venv) $ python -m pip install pytest==6.2.4
  

  17 hoặc

  (venv) $ python -m pip install pytest==6.2.4
  

  18 theo sau là đường dẫn cơ sở dữ liệu. Đối số

  (venv) $ python -m pip install pytest==6.2.4
  

  19 hiển thị một lời nhắc yêu cầu vị trí cơ sở dữ liệu. Nó cũng cho phép bạn chấp nhận đường dẫn mặc định bằng cách nhấn Enter. define a Typer

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  20 instance and assign it as a default value to

  (venv) $ python -m pip install pytest==6.2.4
  

  16. To provide a value for this option, your users need to use

  (venv) $ python -m pip install pytest==6.2.4
  

  17 or

  (venv) $ python -m pip install pytest==6.2.4
  

  18 followed by a database path. The

  (venv) $ python -m pip install pytest==6.2.4
  

  19 argument displays a prompt asking for a database location. It also allows you to accept the default path by pressing Enter.

• Dòng 23 gọi

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86 để tạo tệp cấu hình ứng dụng và cơ sở dữ liệu việc cần làm. calls

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86 to create the application’s configuration file and to-do database.

• Các dòng 24 đến 29 Kiểm tra xem cuộc gọi đến

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86 trả về lỗi. Nếu vậy, các dòng 25 đến 28 In một thông báo lỗi. Dòng 29 thoát khỏi ứng dụng với ngoại lệ

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  10 và mã thoát của

  (venv) $ python -m pip install pytest==6.2.4
  

  23 để báo hiệu rằng ứng dụng chấm dứt với lỗi. check if the call to

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  86 returns an error. If so, lines 25 to 28 print an error message. Line 29 exits the app with a

  (venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0
  

  10 exception and an exit code of

  (venv) $ python -m pip install pytest==6.2.4
  

  23 to signal that the application terminated with an error.

• Dòng 30 gọi

  (venv) $ python -m pip install pytest==6.2.4
  

  04 để khởi tạo cơ sở dữ liệu với danh sách việc cần làm trống. calls

  (venv) $ python -m pip install pytest==6.2.4
  

  04 to initialize the database with an empty to-do list.

• Dòng 31 đến 38 Kiểm tra xem cuộc gọi đến

  (venv) $ python -m pip install pytest==6.2.4
  

  04 trả về lỗi. Nếu vậy, các dòng 32 đến 35 hiển thị thông báo lỗi và dòng 36 thoát khỏi ứng dụng. Nếu không, dòng 38 in một thông điệp thành công trong văn bản màu xanh lá cây. check if the call to

  (venv) $ python -m pip install pytest==6.2.4
  

  04 returns an error. If so, then lines 32 to 35 display an error message, and line 36 exits the application. Otherwise, line 38 prints a success message in green text.

Để in các tin nhắn trong mã này, bạn sử dụng

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

Tốt đẹp! Với tất cả mã này, bây giờ bạn có thể thử lệnh

(venv) $ python -m pip install -r requirements.txt

(venv) $ python -m pip install typer==0.3.2 colorama==0.4.4 shellingham==1.4.0

Lệnh này trình bày cho bạn một lời nhắc để nhập một vị trí cơ sở dữ liệu. Bạn có thể nhấn Enter để chấp nhận đường dẫn mặc định trong dấu ngoặc vuông hoặc bạn có thể nhập vào đường dẫn tùy chỉnh và sau đó nhấn Enter. Ứng dụng tạo cơ sở dữ liệu việc cần làm và cho bạn biết nơi nó sẽ cư trú từ thời điểm này.Enter to accept the default path in square brackets, or you can type in a custom path and then press Enter. The application creates the to-do database and tells you where it’ll reside from this point on.

Ngoài ra, bạn có thể cung cấp đường dẫn cơ sở dữ liệu tùy chỉnh trực tiếp bằng cách sử dụng

(venv) $ python -m pip install -r requirements.txt

(venv) $ python -m pip install pytest==6.2.4

(venv) $ python -m pip install pytest==6.2.4

Khi bạn đã chạy lệnh trên, hãy xem thư mục nhà của bạn. Bạn có thể có một tệp JSON được đặt tên theo tên tệp bạn đã sử dụng với

(venv) $ python -m pip install -r requirements.txt

 1"""This module provides the RP To-Do CLI."""
 2# rptodo/cli.py
 3
 4from typing import Optional
 5
 6import typer
 7
 8from rptodo import __app_name__, __version__
 9
10app = typer.Typer()
11
12def _version_callback(value: bool) -> None:
13    if value:
14        typer.echo(f"{__app_name__} v{__version__}")
15        raise typer.Exit()
16
17@app.callback()
18def main(
19    version: Optional[bool] = typer.Option(
20        None,
21        "--version",
22        "-v",
23        help="Show the application's version and exit.",
24        callback=_version_callback,
25        is_eager=True,
26    )
27) -> None:
28    return