-
Notifications
You must be signed in to change notification settings - Fork 0
/
nomen-fileren.py
executable file
·131 lines (115 loc) · 5.72 KB
/
nomen-fileren.py
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
121
122
123
124
125
126
127
128
129
130
131
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# ============================================================================
# Nomen - Multi-purpose rename tool
# File Renamer script
# Copyright (C) 2018 by Ralf Kilian
# Distributed under the MIT License (https://opensource.org/licenses/MIT)
#
# GitHub: https://github.com/urbanware-org/nomen
# GitLab: https://gitlab.com/urbanware-org/nomen
# ============================================================================
import os
import sys
def main():
from core import clap
from core import common
from core import fileren
try:
p = clap.Parser()
except Exception as e:
print("%s: error: %s" % (os.path.basename(sys.argv[0]), e))
sys.exit(1)
p.set_description("Rename the base name of files within a directory "
"and (if requested) in all of its sub-directories "
"based on the name of the directory where the files "
"are stored in and add a unique numeric ID.")
p.set_epilog("Further information and usage examples can be found "
"inside the documentation file for this script.")
# Required arguments
p.add_avalue("-d", "--directory", "directory that contains the files "
"to process", "directory", None, True)
p.add_predef("-m", "--rename-mode", "rename mode to use", "rename_mode",
["fill-gaps", "keep-order", "rename-new"], True)
# Optional arguments
p.add_switch("-c", "--case-sensitive", "do not ignore the case of the "
"given exclude or explicit pattern", "case", False, False)
p.add_switch(None, "--confirm", "skip the confirmation prompt and "
"instantly rename files", "confirm", True, False)
p.add_avalue(None, "--custom-name", "custom file name (instead of the "
"directory name where the files are stored in)",
"custom_name", None, False)
p.add_avalue(None, "--exclude", "pattern to exclude certain files "
"(case-insensitive, multiple patterns separated via "
"semicolon)", "exclude_pattern", None, False)
p.add_avalue(None, "--explicit", "explicit pattern to only process "
"certain files (case-insensitive, multiple patterns "
"separated via semicolon)", "explicit_pattern", None, False)
p.add_switch("-h", "--help", "print this help message and exit", None,
True, False)
p.add_switch(None, "--ignore-file-ext", "ignore file extensions when "
"numerating files", "ignore_file_ext", True, False)
p.add_switch(None, "--ignore-symlinks", "ignore symbolic links",
"ignore_symlinks", True, False)
p.add_predef("-o", "--order-by", "order files by last accessed, "
"created or modified date", "order_by",
["accessed", "created", "modified"], False)
p.add_avalue("-p", "--padding", "set a user-defined numeric padding "
"(if no user-defined padding value is given, it will be "
"set automatically based on the amount of files per "
"directory)", "padding", 0, False)
p.add_switch("-r", "--recursive", "process the given directory "
"recursively", "recursive", True, False)
p.add_switch(None, "--regex", "use regex syntax for the exclude or "
"explicit pattern instead of just asterisk wildcards and "
"semicolon separators (for details see the section "
"'Regular expression operations' inside the official "
"Python documentation)", "regex_syntax", True, False)
p.add_avalue("-s", "--separator", "use a user-defined character or "
"string as a separator between the directory name and the "
"unique numeric ID", "separator", " ", False)
p.add_avalue(None, "--simulate", "simulate the rename process and "
"write the details into a report file", "report_file", None,
False)
p.add_avalue(None, "--step", "steps between each numeric ID", "step", 1,
False)
p.add_switch(None, "--version", "print the version number and exit", None,
True, False)
if len(sys.argv) == 1:
p.error("At least one required argument is missing.")
elif ("-h" in sys.argv) or ("--help" in sys.argv):
p.print_help()
sys.exit(0)
elif "--version" in sys.argv:
print(fileren.get_version())
sys.exit(0)
args = p.parse_args()
if args.confirm and args.report_file is not None:
p.error("The confirm and the simulate argument cannot be given at "
"the same time.")
if args.exclude_pattern and args.explicit_pattern:
p.error("The exclude and the explicit pattern argument cannot be "
"given at the same time.")
try:
if not args.confirm and args.report_file is None:
if not common.confirm_notice():
sys.exit(0)
if args.exclude_pattern:
pattern = args.exclude_pattern
exclude = True
elif args.explicit_pattern:
exclude = False
pattern = args.explicit_pattern
else:
exclude = None
pattern = None
fileren.rename_files(args.directory, args.rename_mode, args.separator,
args.recursive, args.padding, exclude, pattern,
args.case, args.regex_syntax, args.report_file,
args.ignore_symlinks, args.ignore_file_ext,
args.custom_name, args.step, args.order_by)
except Exception as e:
p.error(e)
if __name__ == "__main__":
main()
# EOF