checker.py

#!/usr/bin/env python
import os
import yaml
import sets

"""
Check that all translation have proper keys

This script can be used to check that all translations have the same set
of keys as the 'master' locale - English in our case.

Just run the script. No output is good.
"""

master = "en"

def compare_dicts(master, victim, path):
    if type(victim) != dict:
        return ["Victim %s is not a dictionary" % '.'.join(path)]

    master_keys = sets.Set(master.keys())
    victim_keys = sets.Set(victim.keys())

    errors = []
    missing_keys = master_keys - victim_keys
    if missing_keys:
        errors.append("%s is missing keys: %s" % ('.'.join(path), ', '.join(missing_keys)))

    extra_keys = victim_keys - master_keys
    if extra_keys:
        errors.append("%s has extra keys: %s" % ('.'.join(path), ', '.join(extra_keys)))

    for k in master_keys & victim_keys:
        subpath = path[:]
        subpath.append(k)
        type_master = type(master[k])
        type_victim = type(victim[k])
        if type_master == str:
            type_master = unicode
        if type_victim == str:
            type_victim = unicode
        if type_master != type_victim:
            errors.append("%s type is incorrect (%s, should be %s)" %
                    ('.'.join(subpath), type_victim, type_master))
        else:
            if type_master == dict:
                errors.extend(compare_dicts(master[k], victim[k], subpath))

    return errors

if __name__ == "__main__":
    with open(os.path.join(os.path.dirname(__file__), "%s.yml" % master), 'r') as master_file:
        master_data = yaml.load(master_file)[master]

    for filename in os.listdir(os.path.dirname(__file__)):
        if filename == "%s.yml" % master or not filename.endswith('.yml'): continue
        with open(os.path.join(os.path.dirname(__file__), filename), 'r') as f:
            victim_data = yaml.load(f)[filename.replace('.yml','')]
            errors = compare_dicts(master_data, victim_data, [])
            if errors:
                print "Errors found in %s:" % filename
                for error in errors:
                    print "- %s" % error