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
|
#!/usr/bin/env python3
import argparse
import os
import sys
from pathlib import Path
def open_utf8(file_path, mode):
"""Open a file with UTF-8 encoding."""
return open(file_path, mode, encoding='utf-8')
def format_file_content(full_path, lines):
"""Format the content of lines according to the specified logic."""
ext = os.path.splitext(full_path)[1] if full_path != '-' else '.test' # Assume .test for stdin
if ext not in {'.test', '.test_slow', '.test_coverage', '.benchmark'}:
return None, 0
# Extract group name (use 'unknown' for stdin if no full_path, else derive from path)
group_name = Path(full_path).parent.name if full_path != '-' else 'unknown'
new_path_line = f'# name: {Path(full_path).as_posix()}\n'
new_group_line = f'# group: [{group_name}]\n'
# Find description
found_description = False
new_description_line = None
for line in lines:
if line.lower().startswith(('# description:', '#description:')):
if found_description:
print(
f"Error formatting file {full_path}, multiple lines starting with # description found",
file=sys.stderr,
)
return None, 1
found_description = True
new_description_line = f'# description: {line.split(":", 1)[1].strip()}\n'
# Filter out old metadata lines
meta = ['#name:', '# name:', '#description:', '# description:', '#group:', '# group:']
lines = [line for line in lines if not any(line.lower().startswith(m) for m in meta)]
# Clean up empty leading lines
while lines and not lines[0].strip():
lines.pop(0)
# Construct header
header = [new_path_line]
if found_description:
header.append(new_description_line)
header.append(new_group_line)
header.append('\n')
# Return formatted content
return ''.join(header + lines), 0
def process_file(file_path, inplace, full_path=None):
"""Process a single file or stdin, either in-place or to stdout."""
effective_path = full_path if file_path == '-' and full_path else file_path
effective_path = effective_path.strip()
if file_path == '-':
if inplace:
print("Error: -i cannot be used with stdin", file=sys.stderr)
return 1
lines = sys.stdin.readlines()
formatted_content, status = format_file_content(effective_path, lines)
if formatted_content is not None:
sys.stdout.write(formatted_content)
return status
if not os.path.isfile(file_path):
print(f"Error: {file_path} is not a file", file=sys.stderr)
return 1
with open_utf8(file_path, 'r') as f:
lines = f.readlines()
formatted_content, status = format_file_content(effective_path, lines)
if formatted_content is None:
return status
if inplace:
with open_utf8(file_path, 'w') as f:
f.write(formatted_content)
else:
sys.stdout.write(formatted_content)
return status
def main():
"""Main function to handle command-line arguments and process files."""
parser = argparse.ArgumentParser(description='Format test files with standardized metadata headers.')
parser.add_argument('files', nargs='+', help='Files to format (use - for stdin)')
parser.add_argument('-i', '--inplace', action='store_true', help='Edit files in place')
parser.add_argument('-f', '--full-path', help='Full path to use for stdin (only with -)')
args = parser.parse_args()
# Validate full-path usage
if args.full_path and '-' not in args.files:
print("Error: -f/--full-path can only be used with stdin (-)", file=sys.stderr)
sys.exit(1)
if args.full_path and len(args.files) > 1:
print("Error: -f/--full-path cannot be used with multiple files", file=sys.stderr)
sys.exit(1)
exit_code = 0
for file_path in args.files:
status = process_file(file_path, args.inplace, args.full_path)
exit_code = max(exit_code, status)
sys.exit(exit_code)
if __name__ == '__main__':
main()
|
