def setUp(self):
token = os.getenv('TX_TOKEN')
assert token is not None
self.t = Transifex(organization='pytransifex', api_token=token)
self.project_slug = 'pytransifex-test-project'
self.project_name = 'PyTransifex Test project'
self.source_lang = 'fr_FR'
def __init__(self,
parameters: Parameters,
transifex_token: str,
create_project: bool = True):
"""
Parameters
----------
parameters:
transifex_token:
Transifex API token
create_project:
if True, it will create the project, resource and language on Transifex
"""
self.parameters = parameters
self._t = Transifex(transifex_token,
parameters.transifex_organization,
i18n_type='QT')
assert self._t.ping()
self.ts_file = '{dir}/i18n/{res}_{lan}.ts'.format(
dir=self.parameters.plugin_path,
res=self.parameters.transifex_resource,
lan=self.parameters.translation_source_language)
if self._t.project_exists(parameters.transifex_project):
print('Project {o}/{p} exists on Transifex'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
elif create_project:
print(
'project does not exists on Transifex, creating one as {o}/{p}'
.format(o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
self._t.create_project(
slug=self.parameters.transifex_project,
repository_url=self.parameters.repository_url,
source_language_code=parameters.translation_source_language)
self.update_strings()
print('creating resource in {o}/{p}/{r} with {f}'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project,
r=self.parameters.transifex_resource,
f=self.ts_file))
self._t.create_resource(
project_slug=self.parameters.transifex_project,
path_to_file=self.ts_file,
resource_slug=self.parameters.transifex_resource)
print('OK')
else:
raise TranslationFailed(
'Project {o}/{p} does not exists on Transifex'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
class TestTranslation(unittest.TestCase):
def setUp(self):
token = os.getenv('TX_TOKEN')
assert token is not None
self.t = Transifex(organization='pytransifex', api_token=token)
self.project_slug = 'pytransifex-test-project'
self.project_name = 'PyTransifex Test project'
self.source_lang = 'fr_FR'
def tearDown(self):
try:
self.t.delete_project(self.project_slug)
except PyTransifexException:
pass
try:
self.t.delete_team('{}-team'.format(self.project_slug))
except PyTransifexException:
pass
def test_creation(self):
self.tearDown()
self.t.create_project(
name=self.project_name,
slug=self.project_slug,
source_language_code=self.source_lang,
private=False,
repository_url='https://www.github.com/opengisch/pytransifex')
self.assertTrue(self.t.project_exists(self.project_slug))
class Translation:
def __init__(self,
parameters: Parameters,
transifex_token: str,
create_project: bool = True):
"""
Parameters
----------
parameters:
transifex_token:
Transifex API token
create_project:
if True, it will create the project, resource and language on Transifex
"""
self.parameters = parameters
self._t = Transifex(transifex_token,
parameters.transifex_organization,
i18n_type='QT')
assert self._t.ping()
self.ts_file = '{dir}/i18n/{res}_{lan}.ts'.format(
dir=self.parameters.plugin_path,
res=self.parameters.transifex_resource,
lan=self.parameters.translation_source_language)
if self._t.project_exists(parameters.transifex_project):
print('Project {o}/{p} exists on Transifex'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
elif create_project:
print(
'project does not exists on Transifex, creating one as {o}/{p}'
.format(o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
self._t.create_project(
slug=self.parameters.transifex_project,
repository_url=self.parameters.repository_url,
source_language_code=parameters.translation_source_language)
self.update_strings()
print('creating resource in {o}/{p}/{r} with {f}'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project,
r=self.parameters.transifex_resource,
f=self.ts_file))
self._t.create_resource(
project_slug=self.parameters.transifex_project,
path_to_file=self.ts_file,
resource_slug=self.parameters.transifex_resource)
print('OK')
else:
raise TranslationFailed(
'Project {o}/{p} does not exists on Transifex'.format(
o=self.parameters.transifex_organization,
p=self.parameters.transifex_project))
def update_strings(self):
"""
Update TS files from plugin source strings
"""
source_files = []
relative_path = './{plugin_path}'.format(
plugin_path=self.parameters.plugin_path)
for ext in ('py', 'ui'):
for file in glob.glob('{dir}/**/*.{ext}'.format(
dir=self.parameters.plugin_path, ext=ext),
recursive=True):
source_files.append(str(Path(file).relative_to(relative_path)))
touch_file(self.ts_file)
project_file = Path(
self.parameters.plugin_path).joinpath(self.parameters.plugin_name +
'.pro')
with open(project_file, 'w') as f:
assert f.write('CODECFORTR = UTF-8\n')
assert f.write('SOURCES = {}\n'.format(' '.join(source_files)))
assert f.write('TRANSLATIONS = {}\n'.format(
Path(self.ts_file).relative_to(relative_path)))
f.flush()
f.close()
cmd = [
self.parameters.pylupdate5_path, '-noobsolete',
str(project_file)
]
output = subprocess.run(cmd, capture_output=True, text=True)
project_file.unlink()
if output.returncode != 0:
raise TranslationFailed(output.stderr)
else:
print('Successfully run pylupdate5: {}'.format(output.stdout))
def compile_strings(self):
"""
Compile TS file into QM files
"""
cmd = [self.parameters.lrelease_path]
for file in glob.glob(
'{dir}/i18n/*.ts'.format(dir=self.parameters.plugin_path)):
cmd.append(file)
output = subprocess.run(cmd, capture_output=True, text=True)
if output.returncode != 0:
raise TranslationFailed(output.stderr)
else:
print('Successfully run lrelease: {}'.format(output.stdout))
def pull(self):
"""
Pull TS files from Transifex
"""
resource = self.__get_resource()
existing_langs = self._t.list_languages(
project_slug=self.parameters.transifex_project,
resource_slug=resource['slug'])
existing_langs.remove(self.parameters.translation_source_language)
print('{c} languages found for resource '
'{s}'
' ({langs})'.format(s=resource['slug'],
c=len(existing_langs),
langs=existing_langs))
for lang in self.parameters.translation_languages:
if lang not in existing_langs:
print('creating missing language: {}'.format(lang))
self._t.create_language(
self.parameters.transifex_project, lang,
[self.parameters.transifex_coordinator])
existing_langs.append(lang)
for lang in existing_langs:
ts_file = '{dir}/i18n/{res}_{lan}.ts'.format(
dir=self.parameters.plugin_path,
res=self.parameters.transifex_resource,
lan=lang)
print('downloading translation file: {}'.format(ts_file))
self._t.get_translation(self.parameters.transifex_project,
resource['slug'], lang, ts_file)
def push(self):
resource = self.__get_resource()
print('pushing resource: {} with file {}'.format(
self.parameters.transifex_resource, self.ts_file))
result = self._t.update_source_translation(
project_slug=self.parameters.transifex_project,
resource_slug=resource['slug'],
path_to_file=self.ts_file)
print('done: {}'.format(result))
def __get_resource(self) -> dict:
resources = self._t.list_resources(self.parameters.transifex_project)
if len(resources) == 0:
raise TransifexNoResource(
"project '{}' has no resource on Transifex".format(
self.parameters.transifex_project))
if len(resources) > 1:
for resource in resources:
if resource['name'] == self.parameters.transifex_resource:
return resource
raise TransifexManyResources(
"project '{p}' has several resources on Transifex "
"and none is named as the project slug."
"Specify one in the parameters with transifex_resource."
"These resources have been found: {r}".format(
p=self.parameters.transifex_project,
r=', '.join([r['name'] for r in resources])))
return resources[0]