gecko-dev/config/check_js_msg_encoding.py
Ricky Stewart 02a7b4ebdf Bug 1654103: Standardize on Black for Python code in mozilla-central.
Allow-list all Python code in tree for use with the black linter, and re-format all code in-tree accordingly.

To produce this patch I did all of the following:

1. Make changes to tools/lint/black.yml to remove include: stanza and update list of source extensions.

2. Run ./mach lint --linter black --fix

3. Make some ad-hoc manual updates to python/mozbuild/mozbuild/test/configure/test_configure.py -- it has some hard-coded line numbers that the reformat breaks.

4. Make some ad-hoc manual updates to `testing/marionette/client/setup.py`, `testing/marionette/harness/setup.py`, and `testing/firefox-ui/harness/setup.py`, which have hard-coded regexes that break after the reformat.

5. Add a set of exclusions to black.yml. These will be deleted in a follow-up bug (1672023).

# ignore-this-changeset

Differential Revision: https://phabricator.services.mozilla.com/D94045
2020-10-26 18:34:53 +00:00

73 lines
1.8 KiB
Python

# vim: set ts=8 sts=4 et sw=4 tw=99:
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# ----------------------------------------------------------------------------
# This script checks encoding of the files that define JSErrorFormatStrings.
#
# JSErrorFormatString.format member should be in ASCII encoding.
# ----------------------------------------------------------------------------
from __future__ import absolute_import, print_function, unicode_literals
import os
import sys
from mozversioncontrol import get_repository_from_env
scriptname = os.path.basename(__file__)
expected_encoding = "ascii"
# The following files don't define JSErrorFormatString.
ignore_files = [
"dom/base/domerr.msg",
"js/xpconnect/src/xpc.msg",
]
def log_pass(filename, text):
print("TEST-PASS | {} | {} | {}".format(scriptname, filename, text))
def log_fail(filename, text):
print("TEST-UNEXPECTED-FAIL | {} | {} | {}".format(scriptname, filename, text))
def check_single_file(filename):
with open(filename, "rb") as f:
data = f.read()
try:
data.decode(expected_encoding)
except Exception:
log_fail(filename, "not in {} encoding".format(expected_encoding))
log_pass(filename, "ok")
return True
def check_files():
result = True
with get_repository_from_env() as repo:
root = repo.path
for filename, _ in repo.get_tracked_files_finder().find("**/*.msg"):
if filename not in ignore_files:
if not check_single_file(os.path.join(root, filename)):
result = False
return result
def main():
if not check_files():
sys.exit(1)
sys.exit(0)
if __name__ == "__main__":
main()