kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity
Files
e864b17a5a04bf38853cdfe95cb356e5ce019678
create/src/Tools/updatets.py
David Carter 43337a9045 Material: Update translation paths 
Correct issue where the translations were being generated from the
wrong source. All translatable files were moved to the MatGui library.
2024-07-15 20:59:10 -05:00

458 lines
15 KiB
Python
Executable File
Raw Blame History

#!/usr/bin/python3
# SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * *
# * Copyright (c) 2010 Werner Mayer <wmayer@users.sourceforge.net> *
# * *
# * This file is part of FreeCAD. *
# * *
# * FreeCAD is free software: you can redistribute it and/or modify it *
# * under the terms of the GNU Lesser General Public License as *
# * published by the Free Software Foundation, either version 2.1 of the *
# * License, or (at your option) any later version. *
# * *
# * FreeCAD is distributed in the hope that it will be useful, but *
# * WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
# * Lesser General Public License for more details. *
# * *
# * You should have received a copy of the GNU Lesser General Public *
# * License along with FreeCAD. If not, see *
# * <https://www.gnu.org/licenses/>. *
# * *
# ***************************************************************************
# Changelog:
# 0.5 Add support for Qt 6 lupdate (which fixes MANY bugs and should be preferred)
# 0.4 Refactor to always try both C++ and Python translations
# 0.3 User-friendly output
# Corrections
# Added Changelog
# 0.2 Add Qt5 support
# Add "no obsolete" flags in order to fix 'ghost strings' in Crowdin
# 0.1 Initial Release
Usage = """updatets - update all .ts files found in the source directories
Usage:
updatets
Authors:
(c) 2010 Werner Mayer
(c) 2019 FreeCAD Volunteers
Licence: LGPL
Version:
0.5
"""
import os, sys
import subprocess
import re
import pathlib
directories = [
{"tsname": "App", "workingdir": "./src/App", "tsdir": "Resources/translations"},
{"tsname": "Base", "workingdir": "./src/Base", "tsdir": "Resources/translations"},
{"tsname": "FreeCAD", "workingdir": "./src/Gui", "tsdir": "Language"},
{
"tsname": "AddonManager",
"workingdir": "./src/Mod/AddonManager/",
"tsdir": "Resources/translations",
},
{
"tsname": "Arch",
"workingdir": "./src/Mod/BIM/",
"tsdir": "Resources/translations",
},
{
"tsname": "Assembly",
"workingdir": "./src/Mod/Assembly/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Draft",
"workingdir": "./src/Mod/Draft/",
"tsdir": "Resources/translations",
},
{
"tsname": "Drawing",
"workingdir": "./src/Mod/Drawing/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Fem",
"workingdir": "./src/Mod/Fem/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Inspection",
"workingdir": "./src/Mod/Inspection/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Material",
"workingdir": "./src/Mod/Material/Gui",
"tsdir": "Resources/translations",
},
{
"tsname": "Mesh",
"workingdir": "./src/Mod/Mesh/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "MeshPart",
"workingdir": "./src/Mod/MeshPart/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "OpenSCAD",
"workingdir": "./src/Mod/OpenSCAD/",
"tsdir": "Resources/translations",
},
{
"tsname": "PartDesign",
"workingdir": "./src/Mod/PartDesign/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Part",
"workingdir": "./src/Mod/Part/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "CAM",
"workingdir": "./src/Mod/CAM/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Points",
"workingdir": "./src/Mod/Points/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "ReverseEngineering",
"workingdir": "./src/Mod/ReverseEngineering/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Robot",
"workingdir": "./src/Mod/Robot/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Sketcher",
"workingdir": "./src/Mod/Sketcher/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Spreadsheet",
"workingdir": "./src/Mod/Spreadsheet/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "StartPage",
"workingdir": "./src/Mod/Start/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "TechDraw",
"workingdir": "./src/Mod/TechDraw/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Test",
"workingdir": "./src/Mod/Test/",
"tsdir": "Gui/Resources/translations",
},
{
"tsname": "Tux",
"workingdir": "./src/Mod/Tux/",
"tsdir": "Resources/translations",
},
{
"tsname": "Help",
"workingdir": "./src/Mod/Help/",
"tsdir": "Resources/translations",
},
]
# Exclude these files from consideration
excluded_files = [
("CAM", "UtilsArguments.py"), # Causes lupdate to hang
("CAM", "refactored_centroid_post.py"), # lupdate bug causes failure on line 245
("CAM", "refactored_grbl_post.py"), # lupdate bug causes failure on line 212
("CAM", "refactored_linuxcnc_post.py"), # lupdate bug causes failure on line 178
("CAM", "refactored_mach3_mach4_post.py"), # lupdate bug causes failure on line 186
("CAM", "refactored_test_post.py"), # lupdate bug causes failure on lines 42 and 179
]
# HTML entities that lextract creates and we want to "un-create" (because CrowdIn just displays them as plain text,
# and does not display the entities as their resulting character, so translators see "&quot;" instead of a quote).
html_entities = [
"&apos;",
"&quot;",
]
workbenches_for_html_cleanup = [
"CAM",
]
QMAKE = ""
LUPDATE = ""
PYLUPDATE = ""
LCONVERT = ""
QT_VERSION_MAJOR = ""
def find_tools(noobsolete=True):
print(Usage + "\nFirst, lets find all necessary tools on your system")
global QMAKE, LUPDATE, PYLUPDATE, LCONVERT, QT_VERSION_MAJOR
p = subprocess.run(["lupdate", "-version"], check=True, stdout=subprocess.PIPE)
lupdate_version = p.stdout.decode()
result = re.search(r".* ([456])\.([\d]+)\.([\d]+)", lupdate_version)
if not result:
print(f"Failed to parse version from {lupdate_version}")
QT_VERSION_MAJOR = int(result.group(1))
QT_VERSION_MINOR = int(result.group(2))
QT_VERSION_PATCH = int(result.group(3))
QT_VERSION = f"{QT_VERSION_MAJOR}.{QT_VERSION_MINOR}.{QT_VERSION_PATCH}"
print(f"Found Qt {QT_VERSION}")
if QT_VERSION_MAJOR < 6:
if os.system("lupdate -version") == 0:
LUPDATE = "lupdate"
# TODO: we suppose lupdate is a symlink to lupdate-qt4 for now
if noobsolete:
LUPDATE += " -no-obsolete"
elif os.system("lupdate-qt5 -version") == 0:
LUPDATE = "lupdate-qt5"
if noobsolete:
LUPDATE += " -no-obsolete"
else:
raise Exception("Cannot find lupdate")
else:
LUPDATE = "lupdate"
if QT_VERSION_MAJOR < 6:
if os.system("qmake -version") == 0:
QMAKE = "qmake"
elif os.system("qmake-qt5 -version") == 0:
QMAKE = "qmake-qt5"
else:
raise Exception("Cannot find qmake")
if os.system("pylupdate -version") == 0:
PYLUPDATE = "pylupdate"
elif os.system("pylupdate6 --version") == 0:
PYLUPDATE = "pylupdate6"
if noobsolete:
PYLUPDATE += " -no-obsolete"
elif os.system("pylupdate5 -version") == 0:
PYLUPDATE = "pylupdate5"
if noobsolete:
PYLUPDATE += " -noobsolete"
elif os.system("pyside2-lupdate -version") == 0:
PYLUPDATE = "pyside2-lupdate"
raise Exception(
"Please do not use pyside2-lupdate at the moment, as it shows encoding problems. Please use pylupdate5 or 6 instead."
)
else:
raise Exception("Cannot find pylupdate")
else:
QMAKE = "(qmake not needed for Qt 6 and later)"
PYLUPDATE = "(pylupdate not needed for Qt 6 and later)"
if os.system("lconvert -h") == 0:
LCONVERT = "lconvert"
if noobsolete and QT_VERSION_MAJOR < 6:
LCONVERT += " -no-obsolete"
else:
raise Exception("Cannot find lconvert")
print(
"\nAll Qt tools have been found!\n",
"\t" + QMAKE + "\n",
"\t" + LUPDATE + "\n",
"\t" + PYLUPDATE + "\n",
"\t" + LCONVERT + "\n",
)
print("==============================================\n")
def update_translation(entry):
global QMAKE, LUPDATE, LCONVERT, QT_VERSION_MAJOR
cur = os.getcwd()
log_redirect = f" 2>> {cur}/tsupdate_stderr.log 1>> {cur}/tsupdate_stdout.log"
os.chdir(entry["workingdir"])
existingjsons = [f for f in os.listdir(".") if f.endswith(".json")]
project_filename = entry["tsname"] + ".pro"
tsBasename = os.path.join(entry["tsdir"], entry["tsname"])
if QT_VERSION_MAJOR < 6:
print("\n\n=============================================")
print(f"EXTRACTING STRINGS FOR {entry['tsname']}")
print("=============================================", flush=True)
execline = []
execline.append(
f"touch dummy_cpp_file_for_lupdate.cpp"
) # lupdate 5.x requires at least one source file to process the UI files
execline.append(f"touch {tsBasename}py.ts")
execline.append(f'{PYLUPDATE} `find ./ -name "*.py"` -ts {tsBasename}py.ts {log_redirect}')
execline.append(f"{QMAKE} -project -o {project_filename} -r")
execline.append(f"{LUPDATE} {project_filename} -ts {tsBasename}.ts {log_redirect}")
execline.append(
f"sed 's/<translation.*>.*<\/translation>/<translation type=\"unfinished\"><\/translation>/g' {tsBasename}.ts > {tsBasename}.ts.temp"
)
execline.append(f"mv {tsBasename}.ts.temp {tsBasename}.ts")
execline.append(
f"{LCONVERT} -i {tsBasename}py.ts {tsBasename}.ts -o {tsBasename}.ts {log_redirect}"
)
execline.append(f"rm {tsBasename}py.ts")
execline.append(f"rm dummy_cpp_file_for_lupdate.cpp")
print(f"Executing commands in {entry['workingdir']}:")
for line in execline:
print(line)
os.system(line)
print()
os.remove(project_filename)
# lupdate creates json files since Qt5.something. Remove them here too
for jsonfile in [f for f in os.listdir(".") if f.endswith(".json")]:
if not jsonfile in existingjsons:
os.remove(jsonfile)
elif QT_VERSION_MAJOR == 6:
# In Qt6, QMake project files are deprecated, and lupdate directly scans for source files. The same executable is
# used for all supported programming languages, so it's just a single function call
# For Windows compatibility, do most of the work in Python:
extensions = [
"java",
"jui",
"ui",
"c",
"c++",
"cc",
"cpp",
"cxx",
"ch",
"h",
"h++",
"hh",
"hpp",
"hxx",
"js",
"qs",
"qml",
"qrc",
"py",
]
with open("files_to_translate.txt", "w", encoding="utf-8") as file_list:
for root, dirs, files in os.walk("./"):
for f in files:
skip = False
for exclusion in excluded_files:
if entry["tsname"] == exclusion[0] and f == exclusion[1]:
print(
f" (NOTE: Excluding file {f} because it is in the excluded_files list)"
)
skip = True
break
if not skip and pathlib.Path(f).suffix[1:] in extensions:
file_list.write(os.path.join(root, f) + "\n")
try:
p = subprocess.run(
[
LUPDATE,
"@files_to_translate.txt",
"-I",
"./",
"-recursive",
"-no-sort",
"-ts",
f"{tsBasename}.ts",
],
capture_output=True,
timeout=60,
encoding="utf-8",
)
if not p:
raise RuntimeError("No return result from lupdate")
if not p.stdout:
raise RuntimeError("No stdout from lupdate")
except Exception as e:
print("*" * 80)
print("*" * 80)
print("*" * 80)
print(f"ERROR RUNNING lupdate -- TRANSLATIONS FOR {entry['tsname']} PROBABLY FAILED...")
print(str(e))
print("*" * 80)
print("*" * 80)
print("*" * 80)
os.chdir(cur)
return
with open(f"{cur}/tsupdate_stdout.log", "a", encoding="utf-8") as f:
f.write(p.stdout)
print(p.stdout, flush=True)
with open(f"{cur}/tsupdate_stderr.log", "a", encoding="utf-8") as f:
f.write(p.stderr)
# Strip out obsolete strings, and make sure there are no translations in the main *.ts file
subprocess.run(
[
LCONVERT,
"-drop-translations",
"-i",
f"{tsBasename}.ts",
"-o",
f"{tsBasename}.ts",
]
)
else:
print(
"ERROR: unrecognized version of lupdate -- found Qt {QT_VERSION_MAJOR}, we only support 4, 5 and 6"
)
exit(1)
os.chdir(cur)
def main(mod=None):
find_tools()
path = os.path.realpath(__file__)
path = os.path.dirname(path)
os.chdir(path)
os.chdir("..")
os.chdir("..")
print("\n\n\n BEGINNING TRANSLATION EXTRACTION \n\n")
if mod:
for i in directories:
if i["tsname"] == mod:
print("WARNING - Updating", mod, "ONLY")
update_translation(i)
break
else:
for i in directories:
update_translation(i)
print(
"\nIf updatets.py was run successfully, the next step is to run ./src/Tools/updatecrowdin.py"
)
print("stderr output from lupdate can be found in tsupdate_stderr.log")
print("stdout output from lupdate can be found in tsupdate_stdout.log")
if __name__ == "__main__":
if len(sys.argv[1:]) > 0:
main(sys.argv[1])
else:
main()
Reference in New Issue View Git Blame Copy Permalink