Updated scripts/linkfix.py

Author: EkremDincel

scripts/linkfix.py

@@ -1,56 +1,71 @@
 import json
 import os
 from os.path import join, dirname
+from color import error, success, warning
 
 file = os.path.realpath(__file__)
 base = dirname(dirname(file))
 source = join(base, "source")
 linkcheck_build = join(base, "build", "linkcheck")
 output_file = join(linkcheck_build, "output.json")
 
-with open(output_file, 'r', encoding = 'utf-8') as f:
-	# sphinx produces multiple records instead of a list of records for broken links
-	records = [json.loads(i) for i in f.readlines()]
+try:
+	with open(output_file, 'r', encoding = 'utf-8') as f:
+		# sphinx produces multiple records instead of a list of records for broken links
+		records = [json.loads(i) for i in f.readlines()]
+except FileNotFoundError:
+	error("ERROR: Run 'make linkcheck' first.")
+	exit()
+
+
+warning("If you do a mistake while replacing the urls you can just terminate the script before it ends (CTRL + C).\n")
 
 cached_replacements = {}
 replacements = []
+broken = 0
 for record in records:
 	status = record['status']
 	uri = record['uri']
+
 	if status == "working":
 		continue
 	elif status == "unchecked":
-		#print("INFO: Url {!r} is not checked.".format(uri))
+		##print("INFO: Url {!r} is not checked.".format(uri))
 		continue
 	elif status == "redirected":
 		# check whether the redirect is permanent
 		if record['code'] != 301:
-			#print("INFO: Passing {!r} since the redirection is not permanent.".format(uri))
+			##print("INFO: Passing {!r} since the redirection is not permanent.".format(uri))
 			continue
 		replace_with = record['info']
 	elif status == "broken":
 		try:
 			replace_with = cached_replacements[uri]
 		except KeyError:
-			replace_with = input("\nThe URL {!r} is broken, what do you want to change it with? You can also pass this question if you want to do nothing.\n > ".format(uri))
-			if not replace_with:
-				print("Passing.")
+			broken += 1
+			print("File:\t" + record['filename'])
+			print("url:\t" + uri)
+			replace_with = input("The above url is broken, what do you want to change it with? You can also pass this question if you want to do nothing.\n > ")
+			if replace_with and not replace_with.isspace():
+				success("Replaced the link.\n\n")
+			else:
+				warning("Passing.\n\n")
 				continue
 	elif status == "ignored":
 		continue
 	else:
-		raise ValueError("ERROR: Unknown status for URL {!r}: {!r}".format(uri, status))
+		raise ValueError("Unknown status for URL {!r}: {!r}".format(uri, status))
 
 	# used for :target: special casing
 	if replace_with == '.':
 		continue
 
 	replacements.append((record, replace_with))
 
-if len(replacements) == 0:
-	print("All links are uptodate, not any broken links.")
+if broken == 0:
+	success("All links are uptodate, not any broken links.")
 else:
-	print(f"Changed {len(replacements)} links.")
+	success(f"Changed {len(replacements)}/{broken} broken links.")
 
 for record, replacement in replacements:
 	rst_file = join(source, record['filename'])
@@ -62,7 +77,7 @@
 	if uri not in data:
 		alternative_uri = uri.split(":", 1)[0]
 		if alternative_uri not in data:
-			print("WARNING: Can't find the URL {!r} in file {}:{}. Might be about a :target: directive.".format(uri, rst_file, record['lineno']))
+			warning("WARNING: Can't find the URL {!r} in file {}:{}. Might be about a :target: directive.".format(uri, rst_file, record['lineno']))
 			continue
 		uri = alternative_uri
 

scripts/move_documents.py

@@ -46,6 +46,7 @@ def check_dir(d, hint = ""):
 
 
 # fix this, we shouldn't be deleting it altogether
+# also we might want to preserve the output files (PDF, EPUB) in a permanent directory in case the script gets killed just after deleting docs
 if exists(docs):
 	shutil.rmtree(docs)