src/main/java/com/google/devtools/build/lib/rules/python/PythonVersion.java

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.rules.python;

import static com.google.common.collect.Iterables.transform;

import com.google.common.base.Functions;
import com.google.common.collect.ImmutableList;
import java.util.Arrays;

/**
 * Python version for Python rules.
 */
public enum PythonVersion {
  PY2,
  PY3,
  PY2AND3,
  PY2ONLY,
  PY3ONLY;

  static final PythonVersion[] ALL_VALUES =
      new PythonVersion[] { PY2, PY3, PY2AND3, PY2ONLY, PY3ONLY };

  /**
   * The Python version to use if not overridden by {@link PythonOptions#forcePython} or a rule's
   * {@code default_python_version} or {@code srcs_version} attributes.
   */
  static final PythonVersion DEFAULT = PY2;

  static final PythonVersion[] NON_CONVERSION_VALUES =
      new PythonVersion[] { PY2AND3, PY2ONLY, PY3ONLY };

  static final PythonVersion[] TARGET_PYTHON_VALUES =
      new PythonVersion[] { PY2, PY3 };

  public static PythonVersion defaultSrcsVersion() {
    return PY2AND3;
  }

  public static PythonVersion defaultTargetPythonVersion() {
    return DEFAULT;
  }

  private static Iterable<String> convertToStrings(PythonVersion[] values) {
    return transform(ImmutableList.copyOf(values), Functions.toStringFunction());
  }

  public static PythonVersion[] getAllVersions() {
    return ALL_VALUES;
  }

  public static Iterable<String> getAllValues() {
    return convertToStrings(ALL_VALUES);
  }

  public static Iterable<String> getNonConversionValues() {
    return convertToStrings(NON_CONVERSION_VALUES);
  }

  public static Iterable<String> getTargetPythonValues() {
    return convertToStrings(TARGET_PYTHON_VALUES);
  }

  /**
   * Converts the string to PythonVersion, if it is one of the allowed values.
   * Returns null if the input is not valid.
   */
  public static PythonVersion parse(String str, PythonVersion... allowed) {
    if (str == null) {
      return null;
    }
    try {
      PythonVersion version = PythonVersion.valueOf(str);
      if (Arrays.asList(allowed).contains(version)) {
        return version;
      }
      return null;
    } catch (IllegalArgumentException e) {
      return null;
    }
  }
}