Skip to main content

Creating command line utility in python



Learning Sections          show

Creating Command Line Utility in Python

Introduction

Creating a command line utility in Python can simplify tasks and automate workflows. Python provides several libraries to help create command line interfaces (CLI) easily, such as argparse, click, and typer.

Using argparse

The argparse module is part of the Python standard library and helps create simple to complex command line interfaces.

Example with argparse

import argparse

# Create the parser
parser = argparse.ArgumentParser("CLI Example")

# Add arguments
parser.add_argument("--name", type=str, required=True, help="Name of the user")
parser.add_argument("--age", type=int, help="Age of the user")

# Parse the arguments
args = parser.parse_args()

# Use the arguments
print(f"Name: {args.name}")
print(f"Age: {args.age}")

Using click

The click library is a package for creating command line interfaces in a composable way with as little code as necessary.

Example with click

import click

@click.command()
@click.option("--name", prompt="Your name", help="Name of the user")
@click.option("--age", default=0, help="Age of the user")
def cli(name, age):
    click.echo(f"Name: {name}")
    click.echo(f"Age: {age}")

if __name__ == "__main__":
    cli()

Using typer

The typer library is a newer library for creating command line interfaces. It's designed to be easy to use and leverages Python's type hints.

Example with typer

import typer

app = typer.Typer()

@app.command()
def cli(name: str, age: int = 0):
    typer.echo(f"Name: {name}")
    typer.echo(f"Age: {age}")

if __name__ == "__main__":
    app.run()
Labels:

Popular posts from this blog

Learn Python

  Learning Sections Introduction to Python Comment, escape sequence and print statement in Python Variables and Data Types in Python Typecasting in Python User input in Python String slicing and operations on string in Python String methods in Python If else conditional statements in Python Match case statement in Python For loops in Python While loops in Python Break and continue statement in Python Functions in Python Function Arguments in Python introduction to lists in Python List methods in Python Tuples in Python Operations on tuple in Python f strings in Python Docstrings in Python Recursion in Python Sets in Python Set methods in Python Dictionaries in Python for Loop with else in Python Exception Handling in Python Finally keyword in Python Raising custom errors in Python Short hand if else statements Enumerate Function in Python Virtual Environment in Python How import works in Python if __nam...
Read more

MultiProcessing in Python

  Learning Sections          show MultiProcessing in Python Multiprocessing in Python involves using the multiprocessing module to run multiple processes concurrently, taking advantage of multiple CPU cores. This module provides a higher level of concurrency than threading and is especially useful for CPU-bound tasks. Creating Processes You can create and start a new process by using the multiprocessing module: import multiprocessing def print_numbers (): for i in range ( 10 ): print ( i ) p1 = multiprocessing.Process ( target = print_numbers ) p1 . start () p1 . join () # Wait for the process to complete Using Process Pools The multiprocessing module provides a Pool class, which allows you to manage a pool of worker processes: from multiprocessing import Pool def square ( n ): return n * n with Pool ( 4 ) as pool : result = pool.map ( square , range (...
Read more

Match Case Statement in Python

  Learning Sections      show Match-Case Statements In Python 3.10 and later, the match-case statement was introduced as a way to perform pattern matching, similar to switch-case statements in other programming languages. It allows you to check the value of a variable against multiple patterns and execute corresponding blocks of code. Basic Match-Case Statement The match statement is followed by an expression and several case clauses. Each case specifies a pattern and an action to be taken if the pattern matches the value of the expression. # Basic match-case statement example command = "start" match command : case "start" : print ( "Starting..." ) case "stop" : print ( "Stopping..." ) case "pause" : print ( "Pausing..." ) case _: print ( "Unknown command" ) Matching Multiple Patterns Using the pipe sy...
Read more