Classes | Functions | Variables
grepros.main Namespace Reference

Classes

class  HelpFormatter
 

Functions

def flush_stdout ()
 
def make_parser ()
 
def preload_plugins ()
 
def process_args (args)
 
def run ()
 
def validate_args (args)
 

Variables

list __all__
 
dictionary ARGUMENTS
 Configuration for argparse, as {description, epilog, args: [..], groups: {name: [..]}}. More...
 
 CLI_ARGS = None
 List of command-line arguments the program was invoked with. More...
 

Function Documentation

◆ flush_stdout()

def grepros.main.flush_stdout ( )
Writes a linefeed to sdtout if nothing has been printed to it so far.

Definition at line 507 of file main.py.

◆ make_parser()

def grepros.main.make_parser ( )
Returns a configured ArgumentParser instance.

Definition at line 398 of file main.py.

◆ preload_plugins()

def grepros.main.preload_plugins ( )
Imports and initializes plugins from auto-load folder and from arguments.

Definition at line 514 of file main.py.

◆ process_args()

def grepros.main.process_args (   args)
Converts or combines arguments where necessary, returns full args.

@param   args  arguments object like argparse.Namespace

Definition at line 413 of file main.py.

◆ run()

def grepros.main.run ( )
Parses command-line arguments and runs search.

Definition at line 528 of file main.py.

◆ validate_args()

def grepros.main.validate_args (   args)
Validates arguments, prints errors, returns success.

@param   args  arguments object like argparse.Namespace

Definition at line 456 of file main.py.

Variable Documentation

◆ __all__

list grepros.main.__all__
private
Initial value:
1 = [
2  "ARGUMENTS", "CLI_ARGS", "HelpFormatter",
3  "make_parser", "process_args", "validate_args", "flush_stdout", "preload_plugins", "run",
4 ]

Definition at line 583 of file main.py.

◆ ARGUMENTS

dictionary grepros.main.ARGUMENTS

Configuration for argparse, as {description, epilog, args: [..], groups: {name: [..]}}.

Definition at line 33 of file main.py.

◆ CLI_ARGS

grepros.main.CLI_ARGS = None

List of command-line arguments the program was invoked with.

Definition at line 385 of file main.py.



grepros
Author(s): Erki Suurjaak
autogenerated on Sat Jan 6 2024 03:11:30