File: README.rst

package info (click to toggle)
python-cyclopts 3.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,288 kB
  • sloc: python: 11,445; makefile: 24
file content (85 lines) | stat: -rw-r--r-- 2,170 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
===========
Subcommands
===========
Arguably parses the command tree based on ``__`` delimited function names.

.. code-block:: python

   import arguably


   @arguably.command
   def ec2__start_instances(*instances):
       """Start instances.

       Args:
           *instances: {instance}s to start
       """
       for inst in instances:
           print(f"Starting {inst}")


   @arguably.command
   def ec2__stop_instances(*instances):
       """Stop instances.

       Args:
           *instances: {instance}s to stop
       """
       for inst in instances:
           print(f"Stopping {inst}")


   if __name__ == "__main__":
       arguably.run()

.. code-block:: console

   $ python main.py ec2 --help
   positional arguments:
      command
        start-instances  start instances.
        stop-instances   stop instances.

Cyclopts handles the command tree by creating and registering recursive :class:`App <cyclopts.App>` objects:

.. code-block:: python

   from cyclopts import App

   app = App()
   app.command(ec2 := App(name="ec2"))


   @ec2.command
   def start_instances(*instances):
       """Start instances.

       Args:
           *instances: {instance}s to start
       """
       for inst in instances:
           print(f"Starting {inst}")


   @ec2.command
   def stop_instances(*instances):
       """Stop instances.

       Args:
           *instances: {instance}s to stop
       """
       for inst in instances:
           print(f"Stopping {inst}")


   if __name__ == "__main__":
       app()

.. code-block:: console

   $ python main.py ec2 --help
   ╭─ Commands ───────────────────────────────────────────────────────────╮
   │ start-instances  start instances.                                    │
   │ stop-instances   stop instances.                                     │
   ╰──────────────────────────────────────────────────────────────────────╯