MZScripts/getPackageDetails.py at master · MarceloCFerraz/MZScripts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
import sys


from utils import files, packages, utils


def get_status_list(statuses):
    """
    Extracts a list of statuses from a string of space-separated statuses.

    Parameters:
    statuses (str): A string of space-separated statuses.

    Returns:
    list: A list of extracted statuses.
    """
    status = ""
    valid_statuses = []

    for char in statuses:
        if char != " ":
            status += char.upper()
        else:
            valid_statuses.append(status)
            status = ""

    # to get the last status provided, since there aren't any spaces left
    valid_statuses.append(status)

    return valid_statuses


def main(key, key_type, statuses):
    """
    Retrieves and processes package details.

    This function prompts the user to select the environment and organization ID. It then retrieves a list of status values based on the provided statuses parameter. Next, it reads a file containing keys and retrieves package details for each key. The function checks if the package status matches the provided status list. If it does, the package details are printed and added to the final response. The function also keeps track of the number of valid and invalid packages.

    Parameters:
    key (str): The key value corresponding to the specified key type.
    key_type (str): The type of key used for package retrieval. Valid options include:
        - "pi" (Package Id)
        - "tn" (Tracking Number)
        - "ci" (Container Id)
        - "bc" (Shipment Barcode)
        - "oi" (Order Id)
        - "ori" (Order Reference Id)
        - "ji" (Job Id)
    statuses (str): A string of space-separated statuses to filter the packages.

    Returns:
    None
    """
    env = utils.select_env()
    orgId = utils.select_org(env)

    valid_statuses = []

    if statuses != "":
        valid_statuses = get_status_list(statuses)

    response = {}
    valid_packages = []
    invalid_packages = 0

    pkgs = packages.get_package_details(env, orgId, key_type, key)
    for package in pkgs:
        status = package["packageStatuses"]["status"]

        if valid_statuses != [] and status not in valid_statuses:
            print(f"Package ignored (not marked as {', '.join(valid_statuses)})")
            invalid_packages += 1
        else:
            packages.print_package_details(package)
            print(f"Package added to final response ({status})")
            valid_packages.append(package)

    response["packageRecords"] = valid_packages
    response["count"] = len(valid_packages)

    print(f"\nValid Packages: {len(valid_packages)}")
    print(f"Invalid Packages: {invalid_packages}\n")

    if valid_packages != [] and len(valid_packages) > 20:
        formatted_response = files.format_json(response)
        files.save_json_to_file(formatted_response, "PKG_DETAILS")


if __name__ == "__main__":
    # get command line argument
    if len(sys.argv) < 3:
        print(
            "\nNO ARGS PROVIDED!\n"
            + "Please, check the correct script usage bellow:\n\n"
            + "SCRIPT USAGE:\n"
            + "--> python getPackageDetails.py <key> <key_type> (OPTIONAL) <statuses>\n\n"
            + "-> Accepted KEY_TYPEs:\n"
            + "\n".join(map(str, packages.VALID_KEY_TYPES))
            + "\n\n--> Valid Statuses:\n"
            + "\n".join(map(str, packages.VALID_STATUSES))
            + "\n\nSCRIPT EXAMPLE:\n"
            + "--> python getPackageDetails.py 8506 bc 'cancelled delivered'\n"
            + "> This will load all the barcodes on 8506.txt, print the HTTP request for "
            + "each of them on a json file and console IF their status corresponds to"
            + " 'CANCELLED' or 'DELIVERED'.\n\n"
            + " If no filter status is informed, all statuses will be displayed\n\n"
            + "NOTES:\n"
            + "> Check comments on code to update relevant data such as key_type (bc, ori, etc)\n"
        )
        sys.exit(1)

    # The file name must be to the requester's hub name (e.g. 8506)
    key = sys.argv[1].replace(".txt", "").replace(".\\", "")
    key_type = sys.argv[2].lower()
    statuses = ""
    try:
        statuses = sys.argv[3]
    except Exception:
        pass
    main(key, key_type, statuses)