smbclientng.core.ModuleArgumentParser

 1#!/usr/bin/env python3
 2# -*- coding: utf-8 -*-
 3# File name          : ModuleArgumentParser.py
 4# Author             : Podalirius (@podalirius_)
 5# Date created       : 23 may 2024
 6
 7
 8import argparse
 9import sys
10
11
12class ModuleArgumentParser(argparse.ArgumentParser):
13    """
14    A custom argument parser for handling module-specific command-line arguments in the smbclientng application.
15
16    This class extends the argparse.ArgumentParser and provides custom error handling specific to the needs of smbclientng modules.
17    It is designed to provide clear and user-friendly command-line interfaces for various modules within the smbclientng suite.
18
19    Attributes:
20        None
21
22    Methods:
23        error(message: str):
24            Overrides the default error handling to provide a more informative error message and display the help text.
25    """
26
27    exit_on_error = False
28
29    def error(self, message):
30        """
31        Overrides the default error handling of argparse.ArgumentParser to provide a custom error message and help display.
32
33        This method is called when ArgumentParser encounters an error. It writes the error message to stderr,
34        displays the help message, and then exits the program with a status code of 2.
35
36        Args:
37            message (str): The error message to be displayed.
38        """
39
40        self.print_help()
41        sys.stderr.write('\n[!] Error: %s\n' % message)