From c428112d291a74ee309ccb7adfc2c83c05e6529c Mon Sep 17 00:00:00 2001 From: Jeremy Hylton Date: Wed, 28 May 2003 11:57:52 +0000 Subject: Rename lib__future__.tex to libfuture.tex and add link in lib.tex. --- Doc/lib/lib.tex | 1 + Doc/lib/lib__future__.tex | 69 ----------------------------------------------- Doc/lib/libfuture.tex | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 69 deletions(-) delete mode 100644 Doc/lib/lib__future__.tex create mode 100644 Doc/lib/libfuture.tex diff --git a/Doc/lib/lib.tex b/Doc/lib/lib.tex index 928371c..ba3442a 100644 --- a/Doc/lib/lib.tex +++ b/Doc/lib/lib.tex @@ -101,6 +101,7 @@ and how to embed it in other applications. \input{libuser} \input{libbltin} % really __builtin__ \input{libmain} % really __main__ +\input{libfuture} % really __future__ \input{libstrings} % String Services \input{libstring} diff --git a/Doc/lib/lib__future__.tex b/Doc/lib/lib__future__.tex deleted file mode 100644 index bd66368..0000000 --- a/Doc/lib/lib__future__.tex +++ /dev/null @@ -1,69 +0,0 @@ -\section{\module{__future__} --- - Future statement definitions} - -\declaremodule[future]{standard}{__future__} -\modulesynopsis{Future statement definitions} - -\module{__future__} is a real module, and serves three purposes: - -\begin{itemize} - -\item To avoid confusing existing tools that analyze import statements - and expect to find the modules they're importing. - -\item To ensure that future_statements run under releases prior to 2.1 - at least yield runtime exceptions (the import of - \module{__future__} will fail, because there was no module of - that name prior to 2.1). - -\item To document when incompatible changes were introduced, and when they - will be --- or were --- made mandatory. This is a form of executable - documentation, and can be inspected programatically via importing - \module{__future__} and examining its contents. - -\end{itemize} - -Each statment in \file{__future__.py} is of the form: - -\begin{verbatim} -FeatureName = "_Feature(" OptionalRelease "," MandatoryRelease "," - CompilerFlag ")" -\end{verbatim} - -where, normally, OptionalRelease is less then MandatoryRelease, and -both are 5-tuples of the same form as \code{sys.version_info}: - -\begin{verbatim} - (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 - ) -\end{verbatim} - -OptionalRelease records the first release in which the feature was -accepted. - -In the case of MandatoryReleases that have not yet occurred, -MandatoryRelease predicts the release in which the feature will become -part of the language. - -Else MandatoryRelease records when the feature became part of the -language; in releases at or after that, modules no longer need a -future statement to use the feature in question, but may continue to -use such imports. - -MandatoryRelease may also be \code{None}, meaning that a planned -feature got dropped. - -Instances of class \class{_Feature} have two corresponding methods, -\method{getOptionalRelease()} and \method{getMandatoryRelease()}. - -CompilerFlag is the (bitfield) flag that should be passed in the -fourth argument to the builtin function \function{compile()} to enable -the feature in dynamically compiled code. This flag is stored in the -\member{compiler_flag} attribute on \class{_Future} instances. - -No feature description will ever be deleted from \module{__future__}. - diff --git a/Doc/lib/libfuture.tex b/Doc/lib/libfuture.tex new file mode 100644 index 0000000..bd66368 --- /dev/null +++ b/Doc/lib/libfuture.tex @@ -0,0 +1,69 @@ +\section{\module{__future__} --- + Future statement definitions} + +\declaremodule[future]{standard}{__future__} +\modulesynopsis{Future statement definitions} + +\module{__future__} is a real module, and serves three purposes: + +\begin{itemize} + +\item To avoid confusing existing tools that analyze import statements + and expect to find the modules they're importing. + +\item To ensure that future_statements run under releases prior to 2.1 + at least yield runtime exceptions (the import of + \module{__future__} will fail, because there was no module of + that name prior to 2.1). + +\item To document when incompatible changes were introduced, and when they + will be --- or were --- made mandatory. This is a form of executable + documentation, and can be inspected programatically via importing + \module{__future__} and examining its contents. + +\end{itemize} + +Each statment in \file{__future__.py} is of the form: + +\begin{verbatim} +FeatureName = "_Feature(" OptionalRelease "," MandatoryRelease "," + CompilerFlag ")" +\end{verbatim} + +where, normally, OptionalRelease is less then MandatoryRelease, and +both are 5-tuples of the same form as \code{sys.version_info}: + +\begin{verbatim} + (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 + ) +\end{verbatim} + +OptionalRelease records the first release in which the feature was +accepted. + +In the case of MandatoryReleases that have not yet occurred, +MandatoryRelease predicts the release in which the feature will become +part of the language. + +Else MandatoryRelease records when the feature became part of the +language; in releases at or after that, modules no longer need a +future statement to use the feature in question, but may continue to +use such imports. + +MandatoryRelease may also be \code{None}, meaning that a planned +feature got dropped. + +Instances of class \class{_Feature} have two corresponding methods, +\method{getOptionalRelease()} and \method{getMandatoryRelease()}. + +CompilerFlag is the (bitfield) flag that should be passed in the +fourth argument to the builtin function \function{compile()} to enable +the feature in dynamically compiled code. This flag is stored in the +\member{compiler_flag} attribute on \class{_Future} instances. + +No feature description will ever be deleted from \module{__future__}. + -- cgit v0.12