123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 |
- #!/usr/bin/env python3
- # Copyright 2014 The Chromium Authors. All rights reserved.
- # Use of this source code is governed by a BSD-style license that can be
- # found in the LICENSE file.
- """
- version.py -- Chromium version string substitution utility.
- """
- from __future__ import print_function
- import argparse
- import os
- import sys
- import android_chrome_version
- def FetchValuesFromFile(values_dict, file_name):
- """
- Fetches KEYWORD=VALUE settings from the specified file.
- Everything to the left of the first '=' is the keyword,
- everything to the right is the value. No stripping of
- white space, so beware.
- The file must exist, otherwise you get the Python exception from open().
- """
- with open(file_name, 'r') as f:
- for line in f.readlines():
- key, val = line.rstrip('\r\n').split('=', 1)
- values_dict[key] = val
- def FetchValues(file_list, is_official_build=None):
- """
- Returns a dictionary of values to be used for substitution.
- Populates the dictionary with KEYWORD=VALUE settings from the files in
- 'file_list'.
- Explicitly adds the following value from internal calculations:
- OFFICIAL_BUILD
- """
- CHROME_BUILD_TYPE = os.environ.get('CHROME_BUILD_TYPE')
- if CHROME_BUILD_TYPE == '_official' or is_official_build:
- official_build = '1'
- else:
- official_build = '0'
- values = dict(
- OFFICIAL_BUILD = official_build,
- )
- for file_name in file_list:
- FetchValuesFromFile(values, file_name)
- script_dirname = os.path.dirname(os.path.realpath(__file__))
- lastchange_filename = os.path.join(script_dirname, "LASTCHANGE")
- lastchange_values = {}
- FetchValuesFromFile(lastchange_values, lastchange_filename)
- for placeholder_key, placeholder_value in values.items():
- values[placeholder_key] = SubstTemplate(placeholder_value,
- lastchange_values)
- return values
- def SubstTemplate(contents, values):
- """
- Returns the template with substituted values from the specified dictionary.
- Keywords to be substituted are surrounded by '@': @KEYWORD@.
- No attempt is made to avoid recursive substitution. The order
- of evaluation is random based on the order of the keywords returned
- by the Python dictionary. So do NOT substitute a value that
- contains any @KEYWORD@ strings expecting them to be recursively
- substituted, okay?
- """
- for key, val in values.items():
- try:
- contents = contents.replace('@' + key + '@', val)
- except TypeError:
- print(repr(key), repr(val))
- return contents
- def SubstFile(file_name, values):
- """
- Returns the contents of the specified file_name with substituted values.
- Substituted values come from the specified dictionary.
- This is like SubstTemplate, except it operates on a file.
- """
- template = open(file_name, 'r').read()
- return SubstTemplate(template, values)
- def WriteIfChanged(file_name, contents):
- """
- Writes the specified contents to the specified file_name.
- Does nothing if the contents aren't different than the current contents.
- """
- try:
- old_contents = open(file_name, 'r').read()
- except EnvironmentError:
- pass
- else:
- if contents == old_contents:
- return
- os.unlink(file_name)
- open(file_name, 'w').write(contents)
- def BuildParser():
- """Build argparse parser, with added arguments."""
- parser = argparse.ArgumentParser()
- parser.add_argument('-f', '--file', action='append', default=[],
- help='Read variables from FILE.')
- parser.add_argument('-i', '--input', default=None,
- help='Read strings to substitute from FILE.')
- parser.add_argument('-o', '--output', default=None,
- help='Write substituted strings to FILE.')
- parser.add_argument('-t', '--template', default=None,
- help='Use TEMPLATE as the strings to substitute.')
- parser.add_argument(
- '-e',
- '--eval',
- action='append',
- default=[],
- help='Evaluate VAL after reading variables. Can be used '
- 'to synthesize variables. e.g. -e \'PATCH_HI=int('
- 'PATCH)//256.')
- parser.add_argument(
- '-a',
- '--arch',
- default=None,
- choices=android_chrome_version.ARCH_CHOICES,
- help='Set which cpu architecture the build is for.')
- parser.add_argument('--os', default=None, help='Set the target os.')
- parser.add_argument('--official', action='store_true',
- help='Whether the current build should be an official '
- 'build, used in addition to the environment '
- 'variable.')
- parser.add_argument(
- '--next',
- action='store_true',
- help='Whether the current build should be a "next" '
- 'build, which targets pre-release versions of '
- 'Android')
- parser.add_argument('args', nargs=argparse.REMAINDER,
- help='For compatibility: INPUT and OUTPUT can be '
- 'passed as positional arguments.')
- return parser
- def BuildEvals(options, parser):
- """Construct a dict of passed '-e' arguments for evaluating."""
- evals = {}
- for expression in options.eval:
- try:
- evals.update(dict([expression.split('=', 1)]))
- except ValueError:
- parser.error('-e requires VAR=VAL')
- return evals
- def ModifyOptionsCompat(options, parser):
- """Support compatibility with old versions.
- Specifically, for old versions that considered the first two
- positional arguments shorthands for --input and --output.
- """
- while len(options.args) and (options.input is None or options.output is None):
- if options.input is None:
- options.input = options.args.pop(0)
- elif options.output is None:
- options.output = options.args.pop(0)
- if options.args:
- parser.error('Unexpected arguments: %r' % options.args)
- def GenerateValues(options, evals):
- """Construct a dict of raw values used to generate output.
- e.g. this could return a dict like
- {
- 'BUILD': 74,
- }
- which would be used to resolve a template like
- 'build = "@BUILD@"' into 'build = "74"'
- """
- values = FetchValues(options.file, options.official)
- for key, val in evals.items():
- values[key] = str(eval(val, globals(), values))
- if options.os == 'android':
- android_chrome_version_codes = android_chrome_version.GenerateVersionCodes(
- values, options.arch, options.next)
- values.update(android_chrome_version_codes)
- return values
- def GenerateOutputContents(options, values):
- """Construct output string (e.g. from template).
- Arguments:
- options -- argparse parsed arguments
- values -- dict with raw values used to resolve the keywords in a template
- string
- """
- if options.template is not None:
- return SubstTemplate(options.template, values)
- elif options.input:
- return SubstFile(options.input, values)
- else:
- # Generate a default set of version information.
- return """MAJOR=%(MAJOR)s
- MINOR=%(MINOR)s
- BUILD=%(BUILD)s
- PATCH=%(PATCH)s
- LASTCHANGE=%(LASTCHANGE)s
- OFFICIAL_BUILD=%(OFFICIAL_BUILD)s
- """ % values
- def BuildOutput(args):
- """Gets all input and output values needed for writing output."""
- # Build argparse parser with arguments
- parser = BuildParser()
- options = parser.parse_args(args)
- # Get dict of passed '-e' arguments for evaluating
- evals = BuildEvals(options, parser)
- # For compatibility with interface that considered first two positional
- # arguments shorthands for --input and --output.
- ModifyOptionsCompat(options, parser)
- # Get the raw values that will be used the generate the output
- values = GenerateValues(options, evals)
- # Get the output string
- contents = GenerateOutputContents(options, values)
- return {'options': options, 'contents': contents}
- def main():
- output = BuildOutput(sys.argv[1:])
- if output['options'].output is not None:
- WriteIfChanged(output['options'].output, output['contents'])
- else:
- print(output['contents'])
- return 0
- if __name__ == '__main__':
- sys.exit(main())
|