get_input_args.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# */AIPND-revision/intropyproject-classify-pet-images/get_input_args.py
#
# PROGRAMMER: RobertJ Lambert
# DATE CREATED:  26/06/2020
# REVISED DATE:
# PURPOSE: Create a function that retrieves the following 3 command line inputs
#          from the user using the Argparse Python module. If the user fails to
#          provide some or all of the 3 inputs, then the default values are
#          used for the missing inputs. Command Line Arguments:
#     1. Image Folder as --dir with default value 'pet_images'
#     2. CNN Model Architecture as --arch with default value 'vgg'
#     3. Text File with Dog Names as --dogfile with default value 'dognames.txt'
#
##
# Imports python modules
import argparse


# TODO 1: Define get_input_args function below please be certain to replace None
#       in the return statement with parser.parse_args() parsed argument
#       collection that you created with this function
#
def get_input_args():
    """
    Retrieves and parses the 3 command line arguments provided by the user when
    they run the program from a terminal window. This function uses Python's
    argparse module to created and defined these 3 command line arguments. If
    the user fails to provide some or all of the 3 arguments, then the default
    values are used for the missing arguments.
    Command Line Arguments:
      1. Image Folder as --dir with default value 'pet_images'
      2. CNN Model Architecture as --arch with default value 'vgg'
      3. Text File with Dog Names as --dogfile with default value 'dognames.txt'
    This function returns these arguments as an ArgumentParser object.
    Parameters:
     None - simply using argparse module to create & store command line arguments
    Returns:
     parse_args() -data structure that stores the command line arguments object
    """
    # Create Parse using ArgumentParser
    parser = argparse.ArgumentParser()
    # Create 3 command line arguments as mentioned above using add_argument() from ArguementParser method
    parser.add_argument(
        "--dir",
        type=str,
        default="pet_images/",
        help="path to the folder of pet images",
    )
    parser.add_argument(
        "--arch", type=str, default="vgg", help="CNN  model architecture to use"
    )
    parser.add_argument(
        "--dogfile",
        type=str,
        default="dognames.txt",
        help="the file path that contains list of dognames",
    )
    parser.add_argument(
        "--incorrect-dogs", action="store_true", help="Set to False to not print"
    )
    parser.add_argument(
        "--incorrect-breeds", action="store_true", help="Set to False to not print"
    )
    # Replace None with parser.parse_args() parsed argument collection that
    # you created with this function
    return parser.parse_args()


# in_args = get_input_args()

# for _, value in in_args._get_kwargs():
# if value is not None:
#   print(value)