Arguments (version 1.0.0)
index
Arguments.html

This package implements tools to build python package and tools.
 
>>> from Arguments import *
>>> a = ArgumentParser()
>>> a.add_password()
(<argparse._MutuallyExclusiveGroup object at 0x00000204D515EA00>, _StoreAction(option_strings=['-p', '--password'], dest='password', nargs=None, const=None, default=None, type=None, choices=None, help=None, metavar=None), _StoreAction(option_strings=['-P', '--password-prompt'], dest='password_prompt', nargs=None, const=None, default=None, type=None, choices=None, help=None, metavar=None))
>>> a.add_input_file("-i")
_StoreAction(option_strings=['-i'], dest='i', nargs='?', const=<_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>, default=None, type=FileType('r'), choices=None, help=None, metavar=None)
>>> a.add_output_file("-o")
_StoreAction(option_strings=['-o'], dest='o', nargs='?', const=None, default=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, type=FileType('w'), choices=None, help=None, metavar=None)
>>> a.add_verbose()
_StoreTrueAction(option_strings=['--verbose', '-v'], dest='verbose', nargs=0, const=True, default=False, type=None, choices=None, help='Active verbose mode.', metavar=None)
>>> a.add_debug()
_StoreTrueAction(option_strings=['--debug', '-d'], dest='debug', nargs=0, const=True, default=False, type=None, choices=None, help='Active debugging mode (set level debug for all loggers).', metavar=None)
>>>
 
>>> a = ArgumentParser(description="description")
>>> a.add_password(password_args=["-a", "--api-key"], prompt_args=["-A", "--api-key-prompt"], prompt_function=input, prompt_function_args="API Key:", password_kwargs={"help": "Help message"}, prompt_kwargs={"help", "Help message"}, mutually_group_kwargs={"required", True})
(<argparse._MutuallyExclusiveGroup object at 0x000001EC567EF730>, _StoreAction(option_strings=['-a', '--api-key'], dest='api_key', nargs=None, const=None, default=None, type=None, choices=None, help='Help message', metavar=None), _StoreAction(option_strings=['-A', '--api-key-prompt'], dest='api_key_prompt', nargs=None, const=None, default=None, type=None, choices=None, help='Help message', metavar=None))
>>> a.add_input_file("-i", "--input", file_args=["rb"], file_kwargs={"encoding": None}, help="Help message")
_StoreAction(option_strings=['-i', '--input'], dest='input', nargs='?', const=<_io.BufferedReader name='<stdin>'>, default=None, type=FileType('rb'), choices=None, help=None, metavar=None)
>>> a.add_output_file("-o", "--output", file_args=["wb"], file_kwargs={"encoding": None}, help="Help message")
_StoreAction(option_strings=['-o', '--output'], dest='output', nargs='?', const=None, default=<_io.BufferedWriter name='<stdout>'>, type=FileType('wb'), choices=None, help='Help message', metavar=None)
>>> a.add_verbose('-V', '--VERBOSE-MODE', function = print, help="Verbose mode.")
_StoreTrueAction(option_strings=['--VERBOSE-MODE', '-V'], dest='VERBOSE_MODE', nargs=0, const=True, default=False, type=None, choices=None, help='Verbose mode.', metavar=None)
>>> a.add_debug('-D', '--DEBUG-MODE', help="Debug mode.")
_StoreTrueAction(option_strings=['--DEBUG-MODE', '-d'], dest='DEBUG_MODE', nargs=0, const=True, default=False, type=None, choices=None, help='Debug mode', metavar=None)
>>>

 
Classes
       
argparse.ArgumentParser(argparse._AttributeHolder, argparse._ActionsContainer)
ArgumentParser

 
class ArgumentParser(argparse.ArgumentParser)
    ArgumentParser(*args, **kwargs)
 
argparse.ArgumentParser + preconfigured and commons arguments.
 
 
Method resolution order:
ArgumentParser
argparse.ArgumentParser
argparse._AttributeHolder
argparse._ActionsContainer
builtins.object

Methods defined here:
__init__(self, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
add_debug(self, *args, **kwargs) -> argparse._StoreAction
This method adds debug argument to the parser.
add_input_file(self, *args, file_args: List[Any] = [], file_kwargs: Dict[str, Any] = {}, **kwargs) -> argparse._StoreAction
This function add input file argument.
 
By default if not present in the command line
the value is None. If is present in the command line
but no value follow use the stdin. If present with a
value, the ArgumentParser will try to open the file.
 
The function accepts the binary mode ("rb").
add_output_file(self, *args, file_args: List[Any] = ['w'], file_kwargs: Dict[str, Any] = {}, **kwargs) -> argparse._StoreAction
This function add output file argument.
 
By default if not present in the command line
the value is stdout. If is present in the command line
but no value follow use the stdout. If present with a
value, the ArgumentParser will try to open the file.
 
The function accepts the binary mode ("wb").
add_password(self, password_args: List[Any] = ['-p', '--password'], prompt_args: List[Any] = ['-P', '--password-prompt'], prompt_function: collections.abc.Callable = <function win_getpass at 0x000001CA87945AB0>, prompt_function_args: List[Any] = [], prompt_function_kwargs: List[Any] = {}, password_kwargs: Dict[str, Any] = {}, prompt_kwargs: Dict[str, Any] = {}, mutually_group_kwargs: Dict[str, Any] = {}) -> Tuple[argparse._MutuallyExclusiveGroup, argparse._StoreAction, argparse._StoreAction]
This function add password argument and password prompt
arguments.
add_verbose(self, *args, function: collections.abc.Callable = functools.partial(<built-in function print>, '[V]'), **kwargs) -> argparse._StoreAction
This method adds verbose argument to the parser.
parse_args(self, *args, **kwargs) -> argparse.Namespace
This function parse command line arguments.

Methods inherited from argparse.ArgumentParser:
add_subparsers(self, **kwargs)
# ==================================
# Optional/Positional adding methods
# ==================================
convert_arg_line_to_args(self, arg_line)
error(self, message)
error(message: string)
 
Prints a usage message incorporating the message to stderr and
exits.
 
If you override this in a subclass, it should not return -- it
should either exit or raise an exception.
exit(self, status=0, message=None)
# ===============
# Exiting methods
# ===============
format_help(self)
format_usage(self)
# =======================
# Help-formatting methods
# =======================
parse_intermixed_args(self, args=None, namespace=None)
parse_known_args(self, args=None, namespace=None)
parse_known_intermixed_args(self, args=None, namespace=None)
print_help(self, file=None)
print_usage(self, file=None)
# =====================
# Help-printing methods
# =====================

Methods inherited from argparse._AttributeHolder:
__repr__(self)
Return repr(self).

Data descriptors inherited from argparse._AttributeHolder:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from argparse._ActionsContainer:
add_argument(self, *args, **kwargs)
add_argument(dest, ..., name=value, ...)
add_argument(option_string, option_string, ..., name=value, ...)
add_argument_group(self, *args, **kwargs)
add_mutually_exclusive_group(self, **kwargs)
get_default(self, dest)
register(self, registry_name, value, object)
# ====================
# Registration methods
# ====================
set_defaults(self, **kwargs)
# ==================================
# Namespace default accessor methods
# ==================================

 
Functions
       
verbose lambda *x

 
Data
        __all__ = ['ArgumentParser', 'verbose']
__author_email__ = 'mauricelambert434@gmail.com'
__copyright__ = '\nPythonToolsKit Copyright (C) 2022 Maurice Lam...ome to redistribute it\nunder certain conditions.\n'
__description__ = '\nThis package implements tools to build python package and tools.\n'
__license__ = 'GPL-3.0 License'
__maintainer__ = 'Maurice Lambert'
__maintainer_email__ = 'mauricelambert434@gmail.com'
__url__ = 'https://github.com/mauricelambert/PythonToolsKit'

 
Author
        Maurice Lambert