__future__.py 4.48 KB
Newer Older
1
"""Record of phased-in incompatible language changes.
2 3 4

Each line is of the form:

5 6
    FeatureName = "_Feature(" OptionalRelease "," MandatoryRelease ","
                              CompilerFlag ")"
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

where, normally, OptionalRelease < MandatoryRelease, and both are 5-tuples
of the same form as sys.version_info:

    (PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int
     PY_MINOR_VERSION, # the 1; an int
     PY_MICRO_VERSION, # the 0; an int
     PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string
     PY_RELEASE_SERIAL # the 3; an int
    )

OptionalRelease records the first release in which

    from __future__ import FeatureName

was accepted.

Tim Peters's avatar
Tim Peters committed
24 25
In the case of MandatoryReleases that have not yet occurred,
MandatoryRelease predicts the release in which the feature will become part
26 27
of the language.

Tim Peters's avatar
Tim Peters committed
28
Else MandatoryRelease records when the feature became part of the language;
29 30 31 32 33 34
in releases at or after that, modules no longer need

    from __future__ import FeatureName

to use the feature in question, but may continue to use such imports.

Tim Peters's avatar
Tim Peters committed
35
MandatoryRelease may also be None, meaning that a planned feature got
36 37
dropped.

38 39 40
Instances of class _Feature have two corresponding methods,
.getOptionalRelease() and .getMandatoryRelease().

41 42 43 44 45 46
CompilerFlag is the (bitfield) flag that should be passed in the fourth
argument to the builtin function compile() to enable the feature in
dynamically compiled code.  This flag is stored in the .compiler_flag
attribute on _Future instances.  These values must match the appropriate
#defines of CO_xxx flags in Include/compile.h.

47
No feature line is ever to be deleted from this file.
48 49
"""

50 51 52 53
all_feature_names = [
    "nested_scopes",
    "generators",
    "division",
54
    "absolute_import",
55
    "with_statement",
56
    "print_function",
57
    "unicode_literals",
58
    "barry_as_FLUFL",
59 60 61 62
]

__all__ = ["all_feature_names"] + all_feature_names

63 64 65 66 67
# The CO_xxx symbols are defined here under the same names used by
# compile.h, so that an editor search will find them here.  However,
# they're not exported in __all__, because they don't really belong to
# this module.
CO_NESTED            = 0x0010   # nested_scopes
68
CO_GENERATOR_ALLOWED = 0        # generators (obsolete, was 0x1000)
69
CO_FUTURE_DIVISION   = 0x2000   # division
70
CO_FUTURE_ABSOLUTE_IMPORT = 0x4000 # perform absolute imports by default
71
CO_FUTURE_WITH_STATEMENT  = 0x8000   # with statement
72
CO_FUTURE_PRINT_FUNCTION  = 0x10000   # print function
73
CO_FUTURE_UNICODE_LITERALS = 0x20000 # unicode string literals
74
CO_FUTURE_BARRY_AS_BDFL = 0x40000
75

76
class _Feature:
77
    def __init__(self, optionalRelease, mandatoryRelease, compiler_flag):
78 79
        self.optional = optionalRelease
        self.mandatory = mandatoryRelease
80
        self.compiler_flag = compiler_flag
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

    def getOptionalRelease(self):
        """Return first release in which this feature was recognized.

        This is a 5-tuple, of the same form as sys.version_info.
        """

        return self.optional

    def getMandatoryRelease(self):
        """Return release in which this feature will become mandatory.

        This is a 5-tuple, of the same form as sys.version_info, or, if
        the feature was dropped, is None.
        """

        return self.mandatory

    def __repr__(self):
100 101 102
        return "_Feature" + repr((self.optional,
                                  self.mandatory,
                                  self.compiler_flag))
103 104 105

nested_scopes = _Feature((2, 1, 0, "beta",  1),
                         (2, 2, 0, "alpha", 0),
106
                         CO_NESTED)
107 108 109

generators = _Feature((2, 2, 0, "alpha", 1),
                      (2, 3, 0, "final", 0),
110
                      CO_GENERATOR_ALLOWED)
111

112 113
division = _Feature((2, 2, 0, "alpha", 2),
                    (3, 0, 0, "alpha", 0),
114
                    CO_FUTURE_DIVISION)
115 116 117

absolute_import = _Feature((2, 5, 0, "alpha", 1),
                           (2, 7, 0, "alpha", 0),
118
                           CO_FUTURE_ABSOLUTE_IMPORT)
119

120
with_statement = _Feature((2, 5, 0, "alpha", 1),
121 122
                          (2, 6, 0, "alpha", 0),
                          CO_FUTURE_WITH_STATEMENT)
123 124 125 126

print_function = _Feature((2, 6, 0, "alpha", 2),
                          (3, 0, 0, "alpha", 0),
                          CO_FUTURE_PRINT_FUNCTION)
127 128 129 130

unicode_literals = _Feature((2, 6, 0, "alpha", 2),
                            (3, 0, 0, "alpha", 0),
                            CO_FUTURE_UNICODE_LITERALS)
131 132 133 134

barry_as_FLUFL = _Feature((3, 1, 0, "alpha", 2),
                         (3, 9, 0, "alpha", 0),
                         CO_FUTURE_BARRY_AS_BDFL)