Skip to content

ags4_cli.py

main()

A tool to read, write, and check AGS4 files.

Source code in python_ags4/ags4_cli.py 
36
37
38
39
40
@click.group()
def main():
    '''A tool to read, write, and check AGS4 files.
    '''
    pass

convert(input_file, output_file, format_columns, dictionary, rename_duplicate_headers, sort_tables)

Convert .ags file to .xlsx file or vice versa.

INPUT_FILE Path to input file. The file should be either .ags or .xlsx

OUTPUT_FILE Path to output file. The file should be either .ags or .xlsx

e.g.

Linux/Mac: ags4_cli convert ~/temp/data.ags ~/temp/data.xlsx

Windows: ags4_cli convert c:\Temp\data.ags c:\Temp\data.xlsx

Exit codes: 0 - Conversion succeeded 1 - Conversion failed

Source code in python_ags4/ags4_cli.py 
 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
121
122
123
124
125
126
127
128
@main.command()
@click.argument('input_file', type=click.Path('r'))
@click.argument('output_file', type=click.Path(writable=True))
@click.option('-f', '--format_columns', type=click.BOOL, default=True,
              help='Format numeric data based on TYPE values if converting from .xlsx to .ags (default True)')
@click.option('-d', '--dictionary', type=click.File('r'), default=None,
              help="Path to AGS4 dictionary file. Numeric data will be formatted based on TYPE values from this file if converting from .xlsx to .ags.")
@click.option('-r', '--rename_duplicate_headers', type=click.BOOL, default=True,
              help="Rename duplicate headers when converting to Excel (default True)")
@click.option('-s', '--sort_tables', type=click.BOOL, default=False,
              help="Alphabetically sort worksheets Excel file. (WARNING: Original table/group order will be lost) (default False)")
def convert(input_file, output_file, format_columns, dictionary, rename_duplicate_headers, sort_tables):
    '''Convert .ags file to .xlsx file or vice versa.

    INPUT_FILE   Path to input file. The file should be either .ags or .xlsx

    OUTPUT_FILE  Path to output file. The file should be either .ags or .xlsx

    e.g.

    Linux/Mac: ags4_cli convert ~/temp/data.ags ~/temp/data.xlsx

    Windows:   ags4_cli convert c:\Temp\data.ags c:\Temp\data.xlsx

    Exit codes:
        0 - Conversion succeeded
        1 - Conversion failed
    '''

    try:
        if input_file.endswith('.ags') & output_file.endswith('.xlsx'):
            console.print(f'[green]Opening file... [bold]{input_file}[/bold][/green]')
            console.print(f'[green]Exporting data to... [bold]{output_file}[/bold][/green]')
            print('')

            AGS4.AGS4_to_excel(input_file, output_file, rename_duplicate_headers=rename_duplicate_headers,
                               sort_tables=sort_tables)
            console.print('\n[green]File conversion complete! :heavy_check_mark:[/green]\n')
            sys.exit(0)

        elif input_file.endswith('.xlsx') & output_file.endswith('.ags'):
            console.print(f'[green]Opening file... [bold]{input_file}[/bold][/green]')
            console.print(f'[green]Exporting data to... [bold]{output_file}[/bold][/green]')
            print('')

            if dictionary is not None:
                dictionary = dictionary.name

            # Call export function
            AGS4.excel_to_AGS4(input_file, output_file, format_numeric_columns=format_columns,
                               dictionary=dictionary)

            console.print('\n[green]File conversion complete! :heavy_check_mark:[/green]\n')
            sys.exit(0)

        elif (input_file.endswith('.ags') & output_file.endswith('.ags')) | (input_file.endswith('.xlsx') & output_file.endswith('.xlsx')):
            file_type = input_file.split('.')[-1]
            console.print(f'[yellow]Both input and output files are of the same type (i.e. [bold].{file_type}[/bold]). No conversion necessary.[/yellow]')

        elif input_file.endswith('.ags'):
            console.print('[red]Please provide an output file with a [bold].xlsx[/bold] extension.[/red]')

        elif input_file.endswith('.xlsx'):
            console.print('[red]Please provide an output file with a [bold].ags[/bold] extension.[/red]')

        elif output_file.endswith('.ags'):
            console.print('[red]Please provide an input file with a [bold].xlsx[/bold] extension.[/red]')

        elif output_file.endswith('.xlsx'):
            console.print('[red]Please provide an input file with a [bold].ags[/bold] extension.[/red]')

        else:
            input_file_type = input_file.split('.')[-1]
            console.print(f'[red]ERROR: This program cannot convert [bold].{input_file_type}[/bold] files.[/red]')
            console.print('')
            console.print('[yellow]Try "ags4_cli convert --help" to see help and examples.[/yellow]')

    except FileNotFoundError:
        console.print('[red]ERROR: Invalid output file path. Converted file could not be saved.[/red]')
        console.print('[red]       Please ensure that the specified directory exists.[/red]')

    except AGS4.AGS4Error:
        pass

    # All error cases exit here
    sys.exit(1)

check(input_file, output_file, dictionary_path, dictionary_version)

Check .ags file for errors according to AGS4 rules.

INPUT_FILE Path to .ags file to be checked

Exit codes: 0 - All checks passed 1 - Errors found or file read error

Source code in python_ags4/ags4_cli.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
@main.command()
@click.argument('input_file', type=click.Path(exists=True))
@click.option('-o', '--output_file', type=click.Path(writable=True), default=None,
              help="Path to save error log")
@click.option('-d', '--dictionary_path', type=click.File('r'), default=None,
              help="Path to AGS4 dictionary file.")
@click.option('-v', '--dictionary_version',
              type=click.Choice(['4.1.1', '4.1', '4.0.4', '4.0.3', '4.0']),
              help='Version of standard dictionary to use. (Warning: Overrides version specified in TRAN_AGS '
                   'and custom dictionary specifed by --dictionary_path)')
def check(input_file, output_file, dictionary_path, dictionary_version):
    '''Check .ags file for errors according to AGS4 rules.

    INPUT_FILE   Path to .ags file to be checked

    Exit codes:
        0 - All checks passed
        1 - Errors found or file read error
    '''

    if input_file.lower().endswith('.ags'):
        console.print(f'[green]Running [bold]python_ags4 v{__version__}[/bold][/green]')
        console.print(f'[green]Opening file... [bold]{input_file}[/bold][/green]')
        console.print('')

        # Try to check file
        try:
            if dictionary_version:
                ags_errors = AGS4.check_file(input_file, standard_AGS4_dictionary=dictionary_version)
            elif dictionary_path:
                ags_errors = AGS4.check_file(input_file, standard_AGS4_dictionary=dictionary_path.name)
            else:
                ags_errors = AGS4.check_file(input_file)

        # End here with unsuccessful exit code if an exception is raised
        except AGS4.AGS4Error:
            sys.exit(1)

        # Count number of entries in error log
        error_count = 0
        for key, val in ags_errors.items():
            if 'Rule' in key:
                error_count += len(val)

        # Print "All checks passed!" to screen if no errors are found
        if error_count == 0:
            print_to_screen(ags_errors)
            console.print('\n[green]File check complete! All checks passed![/green]')

            if output_file is not None:
                save_to_file(output_file, ags_errors, input_file, error_count)
                console.print(f'\n[green]Report saved in {output_file}[/green]\n')

            # End here with successful exit code if no errors found
            sys.exit(0)

        # Print that checking was aborted if AGS3 file was detected
        elif ('AGS Format Rule 3' in ags_errors) and ('AGS3' in ags_errors['AGS Format Rule 3'][0]['desc']):
            print_to_screen(ags_errors)

            console.print('\n[yellow]Checking aborted as AGS3 files are not supported![/yellow]')

            if output_file is not None:
                save_to_file(output_file, ags_errors, input_file, error_count)
                console.print(f'\n[yellow]Error report saved in {output_file}[/yellow]\n')

        # Print errors to screen if list is short enough
        elif error_count < 100:
            print_to_screen(ags_errors)

            console.print(f'\n[yellow]File check complete! {error_count} errors found![/yellow]')

            if output_file is not None:
                save_to_file(output_file, ags_errors, input_file, error_count)
                console.print(f'\n[yellow]Error report saved in {output_file}[/yellow]\n')

        else:
            # Print only metadata to screen
            print_to_screen({'Metadata': ags_errors['Metadata']})

            console.print(f'\n[yellow]File check complete! {error_count} errors found![/yellow]')
            console.print('\n[yellow]Error report too long to print to screen.[/yellow]')

            # Assign default path if output_file is not provided
            if output_file is None:
                output_dir = os.path.dirname(input_file)
                output_file = os.path.join(output_dir, 'error_log.txt')

            save_to_file(output_file, ags_errors, input_file, error_count)
            console.print(f'\n[yellow]Error report saved in {output_file}[/yellow]\n')

    else:
        console.print('[red]ERROR: Only .ags files are accepted as input.[/red]')

    # Any errors in file or other problems will exit with failure code
    sys.exit(1)

print_to_screen(ags_errors)

Print error report to screen.

Source code in python_ags4/ags4_cli.py 
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def print_to_screen(ags_errors):
    '''Print error report to screen.'''

    console.print('')

    # Print  metadata
    if 'Metadata' in ags_errors.keys():
        for entry in ags_errors['Metadata']:
            click.echo(f'''{entry['line']}: \t {entry['desc']}''')
        console.print('')

    # Print 'General' error messages first if present
    if 'General' in ags_errors.keys():
        console.print('[underline]General[/underline]:')

        for entry in ags_errors['General']:
            console.print(f'''  {entry['desc']}''')
        console.print('')

    # Print other error messages
    for key in [x for x in ags_errors if 'Rule' in x]:
        console.print(f'''[white underline]{key.split('Standard')[-1].strip()}[/white underline]:''')
        for entry in ags_errors[key]:
            console.print(f'''  Line {entry['line']}\t [bold]{entry['group'].strip('"')}[/bold]\t {entry['desc']}''')
        console.print('')

save_to_file(output_file, ags_errors, input_file, error_count)

Save error report to file.

Source code in python_ags4/ags4_cli.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
def save_to_file(output_file, ags_errors, input_file, error_count):
    '''Save error report to file.'''

    try:
        with open(output_file, 'w', newline='', encoding='utf-8') as f:
            # Write metadata
            if 'Metadata' in ags_errors.keys():
                for entry in ags_errors['Metadata']:
                    f.write(f'''{entry['line']+':':<12} {entry['desc']}\n''')
                f.write('\n')

            # Summary of errors log
            if error_count == 0:
                f.write('All checks passed!\n')

            elif ('AGS Format Rule 3' in ags_errors) and ('AGS3' in ags_errors['AGS Format Rule 3'][0]['desc']):
                f.write('Checking aborted as AGS3 files are not supported!\n')
                f.write('\n')

            else:
                f.write(f'{error_count} error(s) found in file!\n')
                f.write('\n')

            # Write 'General' error messages first if present
            if 'General' in ags_errors.keys():
                f.write('General:\n')
                for entry in ags_errors['General']:
                    f.write(f'''  {entry['desc']}\n''')
                f.write('\n')

            # Write other error messages
            for key in [x for x in ags_errors if 'Rule' in x]:
                f.write(f'{key}:\n')
                for entry in ags_errors[key]:
                    f.write(f'''  Line {entry['line']:<8} {entry['group'].strip('"'):<7} {entry['desc']}\n''')
                f.write('\n')

    except FileNotFoundError:
        console.print('[red]\nERROR: Invalid output file path. Error report could not be saved.[/red]')
        console.print('[red]       Please ensure that the specified directory exists.[/red]')