typer 0.12.dev2__tar.gz → 0.12.1.dev1__tar.gz

{typer-0.12.dev2 → typer-0.12.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: typer
-Version: 0.12.dev2
+Version: 0.12.1.dev1
 Summary: Typer, build great CLIs. Easy to code. Based on Python type hints.
 Home-page: https://github.com/tiangolo/typer
 Author-Email: Sebastián Ramírez <tiangolo@gmail.com>
@@ -26,8 +26,10 @@ Classifier: License :: OSI Approved :: MIT License
 Project-URL: Documentation, https://typer.tiangolo.com/
 Project-URL: Homepage, https://github.com/tiangolo/typer
 Requires-Python: >=3.7
-Requires-Dist: typer-slim[standard]==0.12.dev2
-Requires-Dist: typer-cli==0.12.dev2
+Requires-Dist: click>=8.0.0
+Requires-Dist: typing-extensions>=3.7.4.3
+Requires-Dist: shellingham>=1.3.0
+Requires-Dist: rich>=10.11.0
 Description-Content-Type: text/markdown
 
 <p align="center">

typer-0.12.1.dev1/docs_src/app_dir/tutorial001.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+import typer
+
+APP_NAME = "my-super-cli-app"
+
+
+def main():
+    app_dir = typer.get_app_dir(APP_NAME)
+    config_path: Path = Path(app_dir) / "config.json"
+    if not config_path.is_file():
+        print("Config file doesn't exist yet")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/default/tutorial001.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument("Wade Wilson")):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/default/tutorial001_an.py

@@ -0,0 +1,10 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument()] = "Wade Wilson"):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/default/tutorial002.py

@@ -0,0 +1,15 @@
+import random
+
+import typer
+
+
+def get_name():
+    return random.choice(["Deadpool", "Rick", "Morty", "Hiro"])
+
+
+def main(name: str = typer.Argument(default_factory=get_name)):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/default/tutorial002_an.py

@@ -0,0 +1,16 @@
+import random
+
+import typer
+from typing_extensions import Annotated
+
+
+def get_name():
+    return random.choice(["Deadpool", "Rick", "Morty", "Hiro"])
+
+
+def main(name: Annotated[str, typer.Argument(default_factory=get_name)]):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial001.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", envvar="AWESOME_NAME")):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial001_an.py

@@ -0,0 +1,10 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(envvar="AWESOME_NAME")] = "World"):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial002.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", envvar=["AWESOME_NAME", "GOD_NAME"])):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial002_an.py

@@ -0,0 +1,12 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(
+    name: Annotated[str, typer.Argument(envvar=["AWESOME_NAME", "GOD_NAME"])] = "World",
+):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial003.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", envvar="AWESOME_NAME", show_envvar=False)):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/envvar/tutorial003_an.py

@@ -0,0 +1,14 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(
+    name: Annotated[
+        str, typer.Argument(envvar="AWESOME_NAME", show_envvar=False)
+    ] = "World",
+):
+    print(f"Hello Mr. {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial001.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument(..., help="The name of the user to greet")):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial001_an.py

@@ -0,0 +1,10 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(help="The name of the user to greet")]):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial002.py

@@ -0,0 +1,12 @@
+import typer
+
+
+def main(name: str = typer.Argument(..., help="The name of the user to greet")):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial002_an.py

@@ -0,0 +1,13 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(help="The name of the user to greet")]):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial003.py

@@ -0,0 +1,12 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", help="Who to greet")):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial003_an.py

@@ -0,0 +1,13 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(help="Who to greet")] = "World"):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial004.py

@@ -0,0 +1,12 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", help="Who to greet", show_default=False)):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial004_an.py

@@ -0,0 +1,17 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(
+    name: Annotated[
+        str, typer.Argument(help="Who to greet", show_default=False)
+    ] = "World",
+):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial005.py

@@ -0,0 +1,13 @@
+import typer
+
+
+def main(
+    name: str = typer.Argument(
+        "Wade Wilson", help="Who to greet", show_default="Deadpoolio the amazing's name"
+    ),
+):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial005_an.py

@@ -0,0 +1,17 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(
+    name: Annotated[
+        str,
+        typer.Argument(
+            help="Who to greet", show_default="Deadpoolio the amazing's name"
+        ),
+    ] = "Wade Wilson",
+):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial006.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", metavar="✨username✨")):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial006_an.py

@@ -0,0 +1,10 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(metavar="✨username✨")] = "World"):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial007.py

@@ -0,0 +1,20 @@
+import typer
+
+
+def main(
+    name: str = typer.Argument(..., help="Who to greet"),
+    lastname: str = typer.Argument(
+        "", help="The last name", rich_help_panel="Secondary Arguments"
+    ),
+    age: str = typer.Argument(
+        "", help="The user's age", rich_help_panel="Secondary Arguments"
+    ),
+):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial007_an.py

@@ -0,0 +1,22 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(
+    name: Annotated[str, typer.Argument(help="Who to greet")],
+    lastname: Annotated[
+        str, typer.Argument(help="The last name", rich_help_panel="Secondary Arguments")
+    ] = "",
+    age: Annotated[
+        str,
+        typer.Argument(help="The user's age", rich_help_panel="Secondary Arguments"),
+    ] = "",
+):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial008.py

@@ -0,0 +1,12 @@
+import typer
+
+
+def main(name: str = typer.Argument("World", hidden=True)):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/help/tutorial008_an.py

@@ -0,0 +1,13 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument(hidden=True)] = "World"):
+    """
+    Say hi to NAME very gently, like Dirk.
+    """
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/optional/tutorial001.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument()):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/optional/tutorial001_an.py

@@ -0,0 +1,10 @@
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[str, typer.Argument()]):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/optional/tutorial002.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+import typer
+
+
+def main(name: Optional[str] = typer.Argument(default=None)):
+    if name is None:
+        print("Hello World!")
+    else:
+        print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/optional/tutorial002_an.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+import typer
+from typing_extensions import Annotated
+
+
+def main(name: Annotated[Optional[str], typer.Argument()] = None):
+    if name is None:
+        print("Hello World!")
+    else:
+        print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/arguments/optional/tutorial003.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def main(name: str = typer.Argument(default=...)):
+    print(f"Hello {name}")
+
+
+if __name__ == "__main__":
+    typer.run(main)

typer-0.12.1.dev1/docs_src/commands/arguments/tutorial001.py

@@ -0,0 +1,17 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def create(username: str):
+    print(f"Creating user: {username}")
+
+
+@app.command()
+def delete(username: str):
+    print(f"Deleting user: {username}")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/callback/tutorial001.py

@@ -0,0 +1,36 @@
+import typer
+
+app = typer.Typer()
+state = {"verbose": False}
+
+
+@app.command()
+def create(username: str):
+    if state["verbose"]:
+        print("About to create a user")
+    print(f"Creating user: {username}")
+    if state["verbose"]:
+        print("Just created a user")
+
+
+@app.command()
+def delete(username: str):
+    if state["verbose"]:
+        print("About to delete a user")
+    print(f"Deleting user: {username}")
+    if state["verbose"]:
+        print("Just deleted a user")
+
+
+@app.callback()
+def main(verbose: bool = False):
+    """
+    Manage users in the awesome CLI app.
+    """
+    if verbose:
+        print("Will write verbose output")
+        state["verbose"] = True
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/callback/tutorial002.py

@@ -0,0 +1,17 @@
+import typer
+
+
+def callback():
+    print("Running a command")
+
+
+app = typer.Typer(callback=callback)
+
+
+@app.command()
+def create(name: str):
+    print(f"Creating user: {name}")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/callback/tutorial003.py

@@ -0,0 +1,22 @@
+import typer
+
+
+def callback():
+    print("Running a command")
+
+
+app = typer.Typer(callback=callback)
+
+
+@app.callback()
+def new_callback():
+    print("Override callback, running a command")
+
+
+@app.command()
+def create(name: str):
+    print(f"Creating user: {name}")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/callback/tutorial004.py

@@ -0,0 +1,23 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.callback()
+def callback():
+    """
+    Manage users CLI app.
+
+    Use it with the create command.
+
+    A new user with the given NAME will be created.
+    """
+
+
+@app.command()
+def create(name: str):
+    print(f"Creating user: {name}")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/context/tutorial001.py

@@ -0,0 +1,25 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def create(username: str):
+    print(f"Creating user: {username}")
+
+
+@app.command()
+def delete(username: str):
+    print(f"Deleting user: {username}")
+
+
+@app.callback()
+def main(ctx: typer.Context):
+    """
+    Manage users in the awesome CLI app.
+    """
+    print(f"About to execute command: {ctx.invoked_subcommand}")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/context/tutorial002.py

@@ -0,0 +1,25 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def create(username: str):
+    print(f"Creating user: {username}")
+
+
+@app.command()
+def delete(username: str):
+    print(f"Deleting user: {username}")
+
+
+@app.callback(invoke_without_command=True)
+def main():
+    """
+    Manage users in the awesome CLI app.
+    """
+    print("Initializing database")
+
+
+if __name__ == "__main__":
+    app()

typer-0.12.1.dev1/docs_src/commands/context/tutorial003.py

@@ -0,0 +1,26 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def create(username: str):
+    print(f"Creating user: {username}")
+
+
+@app.command()
+def delete(username: str):
+    print(f"Deleting user: {username}")
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context):
+    """
+    Manage users in the awesome CLI app.
+    """
+    if ctx.invoked_subcommand is None:
+        print("Initializing database")
+
+
+if __name__ == "__main__":
+    app()