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

Introduction to OOPs in Python

  Learning Sections          show Introduction to Object-Oriented Programming (OOP) Object-Oriented Programming (OOP) is a programming paradigm that organizes software design around objects rather than actions and data rather than logic. It revolves around the concept of "objects", which are instances of classes. These objects encapsulate data, in the form of attributes or properties, and behaviors, in the form of methods or functions. OOP promotes modularity, reusability, and extensibility in software development. Key Concepts of OOP: Class: A class is a blueprint or template for creating objects. It defines the attributes (data) and methods (functions) that will characterize any object instantiated from that class. Object: An object is an instance of a class. It is a concrete realization of the class blueprint, containing actual values instead of placeholders for attributes. Encapsulation: Encapsulation is ...
Read more

Classes and Objects in Python

  Learning Sections          show Classes and Objects in Python In Python, a class is a blueprint for creating objects. An object is an instance of a class. Classes allow you to logically group data and functions in a way that is easy to manage and reuse. 1. Defining a Class To define a class in Python, you use the class keyword followed by the class name and a colon. Inside the class, you can define attributes and methods. Example: # Define a class class Person : # Class attribute species = 'Human' # Class method def greet ( self ): return 'Hello, I am a person.' # Create an object of the class person1 = Person () # Access class attribute print ( person1 . species ) # Output: Human # Call class method print ( person1 . greet ()) # Output: Hello, I am a person. 2. Creating Objects To create an object of a class, you simply call the class name followed by paren...
Read more

Exception Handling in Python

  Learning sections          show Exception Handling in Python Exception handling in Python is done through the use of try , except , else , and finally blocks. This allows you to catch and handle errors gracefully. Below are some examples and explanations: 1. Basic Try-Except The try block lets you test a block of code for errors. The except block lets you handle the error. # Example of basic try-except try : result = 10 / 0 except ZeroDivisionError : print ( "Cannot divide by zero!" ) # Output: # Cannot divide by zero! 2. Handling Multiple Exceptions You can catch multiple exceptions by specifying multiple except blocks. # Example of handling multiple exceptions try : result = 10 / 0 except ZeroDivisionError : print ( "Cannot divide by zero!" ) except TypeError : print ( "Invalid operation!" ) # Output: # Cannot divide by zero! 3. Using Else The e...
Read more