traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Logical markup. 

Convert one bulleted list to a {tableii} environment; the other should
probably be converted, but I haven't decided to what.
This commit is contained in:
Fred Drake 1998-03-10 04:23:12 +00:00
parent 2cb1074937
commit 193338afeb
2 changed files with 158 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
Doc/lib/liblocale.tex
View File

@ -9,27 +9,26 @@ to integrate certain cultural aspects into an applications, without
requiring the programmer to know all the specifics of each country requiring the programmer to know all the specifics of each country
where the software is executed. where the software is executed.
The \code{locale} module is implemented on top of the \code{_locale} The \module{locale} module is implemented on top of the
module, which in turn uses an ANSI \C{} locale implementation if \module{_locale}\refbimodindex{_locale} module, which in turn uses an
available. ANSI \C{} locale implementation if available.
\refbimodindex{_locale}
The \code{locale} module defines the following functions: The \module{locale} module defines the following exception and
functions:
\setindexsubitem{(in module locale)}
\begin{funcdesc}{setlocale}{category\optional{\, value}} \begin{funcdesc}{setlocale}{category\optional{, value}}
If \var{value} is specified, modifies the locale setting for the If \var{value} is specified, modifies the locale setting for the
\var{category}. The available categories are listed in the data \var{category}. The available categories are listed in the data
description below. The value is the name of a locale. An empty string description below. The value is the name of a locale. An empty string
specifies the user's default settings. If the modification of the specifies the user's default settings. If the modification of the
locale fails, the exception \code{locale.Error} is locale fails, the exception \exception{Error} is
raised. If successful, the new locale setting is returned. raised. If successful, the new locale setting is returned.
If no \var{value} is specified, the current setting for the If no \var{value} is specified, the current setting for the
\var{category} is returned. \var{category} is returned.
\code{setlocale()} is not thread safe on most systems. Applications \function{setlocale()} is not thread safe on most systems. Applications
typically start with a call of typically start with a call of
\begin{verbatim} \begin{verbatim}
import locale import locale
@ -41,6 +40,10 @@ locale is not changed thereafter, using multithreading should not
cause problems. cause problems.
\end{funcdesc} \end{funcdesc}
\begin{excdesc}{Error}
Exception raised when \function{setlocale()} fails.
\end{excdesc}
\begin{funcdesc}{localeconv}{} \begin{funcdesc}{localeconv}{}
Returns the database of of the local conventions as a dictionary. This Returns the database of of the local conventions as a dictionary. This
dictionary has the following strings as keys: dictionary has the following strings as keys:
@ -77,20 +80,22 @@ the currency symbol.
\item \code{p_sign_posn} and \code{n_sign_posn} indicate how the \item \code{p_sign_posn} and \code{n_sign_posn} indicate how the
sign should be placed for positive and negative monetary values. sign should be placed for positive and negative monetary values.
\end{itemize} \end{itemize}
The possible values for \code{p_sign_posn} and \code{n_sign_posn} The possible values for \code{p_sign_posn} and \code{n_sign_posn}
are given below. are given below.
\begin{itemize}
\item 0 - Currency and value are surrounded by parentheses. \begin{tableii}{|c|l|}{code}{Value}{Explanation}
\item 1 - The sign should precede the value and currency symbol. \lineii{0}{Currency and value are surrounded by parentheses.}
\item 2 - The sign should follow the value and currency symbol. \lineii{1}{The sign should precede the value and currency symbol.}
\item 3 - The sign should immediately precede the value. \lineii{2}{The sign should follow the value and currency symbol.}
\item 4 - The sign should immediately follow the value. \lineii{3}{The sign should immediately precede the value.}
\item LC_MAX - nothing is specified in this locale. \lineii{4}{The sign should immediately follow the value.}
\end{itemize} \lineii{LC_MAX}{Nothing is specified in this locale.}
\end{tableii}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strcoll}{string1,string2} \begin{funcdesc}{strcoll}{string1,string2}
Compares two strings according to the current \code{LC_COLLATE} Compares two strings according to the current \constant{LC_COLLATE}
setting. As any other compare function, returns a negative, or a setting. As any other compare function, returns a negative, or a
positive value, or \code{0}, depending on whether \var{string1} positive value, or \code{0}, depending on whether \var{string1}
collates before or after \var{string2} or is equal to it. collates before or after \var{string2} or is equal to it.
@ -98,17 +103,17 @@ collates before or after \var{string2} or is equal to it.
\begin{funcdesc}{strxfrm}{string} \begin{funcdesc}{strxfrm}{string}
Transforms a string to one that can be used for the builtin function Transforms a string to one that can be used for the builtin function
\code{cmp()}, and still returns locale-aware results. This function can be \function{cmp()}\bifuncindex{cmp}, and still returns locale-aware
used when the same string is compared repeatedly, e.g. when collating results. This function can be used when the same string is compared
a sequence of strings. repeatedly, e.g. when collating a sequence of strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{format}{format,val\optional{grouping=0}} \begin{funcdesc}{format}{format, val, \optional{grouping\code{ = 0}}}
Formats a number \var{val} according to the current \code{LC_NUMERIC} Formats a number \var{val} according to the current
setting. The format follows the conventions of the \code{\%} operator. For \constant{LC_NUMERIC} setting. The format follows the conventions of
floating point values, the decimal point is modified if the \code{\%} operator. For floating point values, the decimal point
appropriate. If \var{grouping} is true, also takes the grouping into is modified if appropriate. If \var{grouping} is true, also takes the
account. grouping into account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{str}{float} \begin{funcdesc}{str}{float}
@ -118,48 +123,50 @@ account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atof}{string} \begin{funcdesc}{atof}{string}
Converts a string to a floating point number, following the \code{LC_NUMERIC} Converts a string to a floating point number, following the
settings. \constant{LC_NUMERIC} settings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{string} \begin{funcdesc}{atoi}{string}
Converts a string to an integer, following the \code{LC_NUMERIC} conventions. Converts a string to an integer, following the \constant{LC_NUMERIC}
conventions.
\end{funcdesc} \end{funcdesc}
\begin{datadesc}{LC_CTYPE} \begin{datadesc}{LC_CTYPE}
\refstmodindex{string} \refstmodindex{string}
Locale category for the character type functions. Depending on the Locale category for the character type functions. Depending on the
settings of this category, the functions of module \code{string} settings of this category, the functions of module \module{string}
dealing with case change their behaviour. dealing with case change their behaviour.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_COLLATE} \begin{datadesc}{LC_COLLATE}
Locale category for sorting strings. The functions \code{strcoll()} and Locale category for sorting strings. The functions
\code{strxfrm()} of the \code{locale} module are affected. \function{strcoll()} and \function{strxfrm()} of the \module{locale}
module are affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_TIME} \begin{datadesc}{LC_TIME}
Locale category for the formatting of time. The function Locale category for the formatting of time. The function
\code{time.strftime()} follows these conventions. \function{time.strftime()} follows these conventions.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MONETARY} \begin{datadesc}{LC_MONETARY}
Locale category for formatting of monetary values. The available Locale category for formatting of monetary values. The available
options are available from the \code{localeconv()} function. options are available from the \function{localeconv()} function.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MESSAGES} \begin{datadesc}{LC_MESSAGES}
Locale category for message display. Python currently does not support Locale category for message display. Python currently does not support
application specific locale-aware messages. Messages displayed by the application specific locale-aware messages. Messages displayed by the
operating system, like those returned by \code{posix.strerror()} might operating system, like those returned by \function{os.strerror()}
be affected by this category. might be affected by this category.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_NUMERIC} \begin{datadesc}{LC_NUMERIC}
Locale category for formatting numbers. The functions Locale category for formatting numbers. The functions
\code{format()}, \code{atoi()}, \code{atof()} and \code{str()} of the \function{format()}, \function{atoi()}, \function{atof()} and
\code{locale} module are affected by that category. All other numeric \function{str()} of the \module{locale} module are affected by that
formatting operations are not affected. category. All other numeric formatting operations are not affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_ALL} \begin{datadesc}{LC_ALL}
@ -173,13 +180,9 @@ used to restore the settings.
\begin{datadesc}{CHAR_MAX} \begin{datadesc}{CHAR_MAX}
This is a symbolic constant used for different values returned by This is a symbolic constant used for different values returned by
\code{localeconv()}. \function{localeconv()}.
\end{datadesc} \end{datadesc}
\begin{excdesc}{Error}
Exception raised when \code{setlocale()} fails.
\end{excdesc}
Example: Example:
\begin{verbatim} \begin{verbatim}
@ -205,50 +208,54 @@ matter what the user's preferred locale is. The program must
explicitly say that it wants the user's preferred locale settings by explicitly say that it wants the user's preferred locale settings by
calling \code{setlocale(LC_ALL, "")}. calling \code{setlocale(LC_ALL, "")}.
It is generally a bad idea to call \code{setlocale()} in some library It is generally a bad idea to call \function{setlocale()} in some library
routine, since as a side effect it affects the entire program. Saving routine, since as a side effect it affects the entire program. Saving
and restoring it is almost as bad: it is expensive and affects other and restoring it is almost as bad: it is expensive and affects other
threads that happen to run before the settings have been restored. threads that happen to run before the settings have been restored.
If, when coding a module for general use, you need a locale If, when coding a module for general use, you need a locale
independent version of an operation that is affected by the locale independent version of an operation that is affected by the locale
(e.g. \code{string.lower()}, or certain formats used with (e.g. \function{string.lower()}, or certain formats used with
\code{time.strftime()})), you will have to find a way to do it without \function{time.strftime()})), you will have to find a way to do it
using the standard library routine. Even better is convincing without using the standard library routine. Even better is convincing
yourself that using locale settings is okay. Only as a last should yourself that using locale settings is okay. Only as a last resort
you document that your module is not compatible with non-C locale should you document that your module is not compatible with non-C
settings. locale settings.
The case conversion functions in the \code{string} and \code{strop} The case conversion functions in the
modules are affected by the locale settings. When a call to the \module{string}\refstmodindex{string} and
\code{setlocale()} function changes the \code{LC_CTYPE} settings, the \module{strop}\refbimodindex{strop} modules are affected by the locale
variables \code{string.lowercase}, \code{string.uppercase} and settings. When a call to the \function{setlocale()} function changes
\code{string.letters} (and their counterparts in \code{strop}) are the \constant{LC_CTYPE} settings, the variables
\code{string.lowercase}, \code{string.uppercase} and
\code{string.letters} (and their counterparts in \module{strop}) are
recalculated. Note that this code that uses these variable through recalculated. Note that this code that uses these variable through
\code{from ... import ...}, e.g. \code{from string import letters}, is `\keyword{from} ... \keyword{import} ...', e.g. \code{from string
not affected by subsequent \code{setlocale()} calls. import letters}, is not affected by subsequent \function{setlocale()}
calls.
The only way to perform numeric operations according to the locale The only way to perform numeric operations according to the locale
is to use the special functions defined by this module: is to use the special functions defined by this module:
\code{atof()}, \code{atoi()}, \code{format()}, \code{str()}. \function{atof()}, \function{atoi()}, \function{format()},
\function{str()}.
\code{For extension writers and programs that embed Python} \subsection{For extension writers and programs that embed Python}
Extension modules should never call \code{setlocale()}, except to find Extension modules should never call \function{setlocale()}, except to
out what the current locale is. But since the return value can only find out what the current locale is. But since the return value can
be used portably to restore it, that is not very useful (except only be used portably to restore it, that is not very useful (except
perhaps to find out whether or not the locale is ``C''). perhaps to find out whether or not the locale is ``C'').
When Python is embedded in an application, if the application sets the When Python is embedded in an application, if the application sets the
locale to something specific before initializing Python, that is locale to something specific before initializing Python, that is
generally okay, and Python will use whatever locale is set, generally okay, and Python will use whatever locale is set,
\strong{except} that the \code{LC_NUMERIC} locale should always be \strong{except} that the \constant{LC_NUMERIC} locale should always be
``C''. ``C''.
The \code{setlocale()} function in the \code{locale} module contains The \function{setlocale()} function in the \module{locale} module contains
gives the Python progammer the impression that you can manipulate the gives the Python progammer the impression that you can manipulate the
\code{LC_NUMERIC} locale setting, but this not the case at the C \constant{LC_NUMERIC} locale setting, but this not the case at the C
level: C code will always find that the \code{LC_NUMERIC} locale level: C code will always find that the \constant{LC_NUMERIC} locale
setting is ``C''. This is because too much would break when the setting is ``C''. This is because too much would break when the
decimal point character is set to something else than a period decimal point character is set to something else than a period
(e.g. the Python parser would break). Caveat: threads that run (e.g. the Python parser would break). Caveat: threads that run
@ -258,9 +265,9 @@ portable way to implement this feature is to set the numeric locale
settings to what the user requests, extract the relevant settings to what the user requests, extract the relevant
characteristics, and then restore the ``C'' numeric locale. characteristics, and then restore the ``C'' numeric locale.
When Python code uses the \code{locale} module to change the locale, When Python code uses the \module{locale} module to change the locale,
this also affect the embedding application. If the embedding this also affect the embedding application. If the embedding
application doesn't want this to happen, it should remove the application doesn't want this to happen, it should remove the
\code{_locale} extension module (which does all the work) from the \module{_locale} extension module (which does all the work) from the
table of built-in modules in the \code{config.c} file, and make sure table of built-in modules in the \file{config.c} file, and make sure
that the \code{_locale} module is not accessible as a shared library. that the \module{_locale} module is not accessible as a shared library.

151
Doc/liblocale.tex
View File

@ -9,27 +9,26 @@ to integrate certain cultural aspects into an applications, without
requiring the programmer to know all the specifics of each country requiring the programmer to know all the specifics of each country
where the software is executed. where the software is executed.
The \code{locale} module is implemented on top of the \code{_locale} The \module{locale} module is implemented on top of the
module, which in turn uses an ANSI \C{} locale implementation if \module{_locale}\refbimodindex{_locale} module, which in turn uses an
available. ANSI \C{} locale implementation if available.
\refbimodindex{_locale}
The \code{locale} module defines the following functions: The \module{locale} module defines the following exception and
functions:
\setindexsubitem{(in module locale)}
\begin{funcdesc}{setlocale}{category\optional{\, value}} \begin{funcdesc}{setlocale}{category\optional{, value}}
If \var{value} is specified, modifies the locale setting for the If \var{value} is specified, modifies the locale setting for the
\var{category}. The available categories are listed in the data \var{category}. The available categories are listed in the data
description below. The value is the name of a locale. An empty string description below. The value is the name of a locale. An empty string
specifies the user's default settings. If the modification of the specifies the user's default settings. If the modification of the
locale fails, the exception \code{locale.Error} is locale fails, the exception \exception{Error} is
raised. If successful, the new locale setting is returned. raised. If successful, the new locale setting is returned.
If no \var{value} is specified, the current setting for the If no \var{value} is specified, the current setting for the
\var{category} is returned. \var{category} is returned.
\code{setlocale()} is not thread safe on most systems. Applications \function{setlocale()} is not thread safe on most systems. Applications
typically start with a call of typically start with a call of
\begin{verbatim} \begin{verbatim}
import locale import locale
@ -41,6 +40,10 @@ locale is not changed thereafter, using multithreading should not
cause problems. cause problems.
\end{funcdesc} \end{funcdesc}
\begin{excdesc}{Error}
Exception raised when \function{setlocale()} fails.
\end{excdesc}
\begin{funcdesc}{localeconv}{} \begin{funcdesc}{localeconv}{}
Returns the database of of the local conventions as a dictionary. This Returns the database of of the local conventions as a dictionary. This
dictionary has the following strings as keys: dictionary has the following strings as keys:
@ -77,20 +80,22 @@ the currency symbol.
\item \code{p_sign_posn} and \code{n_sign_posn} indicate how the \item \code{p_sign_posn} and \code{n_sign_posn} indicate how the
sign should be placed for positive and negative monetary values. sign should be placed for positive and negative monetary values.
\end{itemize} \end{itemize}
The possible values for \code{p_sign_posn} and \code{n_sign_posn} The possible values for \code{p_sign_posn} and \code{n_sign_posn}
are given below. are given below.
\begin{itemize}
\item 0 - Currency and value are surrounded by parentheses. \begin{tableii}{|c|l|}{code}{Value}{Explanation}
\item 1 - The sign should precede the value and currency symbol. \lineii{0}{Currency and value are surrounded by parentheses.}
\item 2 - The sign should follow the value and currency symbol. \lineii{1}{The sign should precede the value and currency symbol.}
\item 3 - The sign should immediately precede the value. \lineii{2}{The sign should follow the value and currency symbol.}
\item 4 - The sign should immediately follow the value. \lineii{3}{The sign should immediately precede the value.}
\item LC_MAX - nothing is specified in this locale. \lineii{4}{The sign should immediately follow the value.}
\end{itemize} \lineii{LC_MAX}{Nothing is specified in this locale.}
\end{tableii}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{strcoll}{string1,string2} \begin{funcdesc}{strcoll}{string1,string2}
Compares two strings according to the current \code{LC_COLLATE} Compares two strings according to the current \constant{LC_COLLATE}
setting. As any other compare function, returns a negative, or a setting. As any other compare function, returns a negative, or a
positive value, or \code{0}, depending on whether \var{string1} positive value, or \code{0}, depending on whether \var{string1}
collates before or after \var{string2} or is equal to it. collates before or after \var{string2} or is equal to it.
@ -98,17 +103,17 @@ collates before or after \var{string2} or is equal to it.
\begin{funcdesc}{strxfrm}{string} \begin{funcdesc}{strxfrm}{string}
Transforms a string to one that can be used for the builtin function Transforms a string to one that can be used for the builtin function
\code{cmp()}, and still returns locale-aware results. This function can be \function{cmp()}\bifuncindex{cmp}, and still returns locale-aware
used when the same string is compared repeatedly, e.g. when collating results. This function can be used when the same string is compared
a sequence of strings. repeatedly, e.g. when collating a sequence of strings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{format}{format,val\optional{grouping=0}} \begin{funcdesc}{format}{format, val, \optional{grouping\code{ = 0}}}
Formats a number \var{val} according to the current \code{LC_NUMERIC} Formats a number \var{val} according to the current
setting. The format follows the conventions of the \code{\%} operator. For \constant{LC_NUMERIC} setting. The format follows the conventions of
floating point values, the decimal point is modified if the \code{\%} operator. For floating point values, the decimal point
appropriate. If \var{grouping} is true, also takes the grouping into is modified if appropriate. If \var{grouping} is true, also takes the
account. grouping into account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{str}{float} \begin{funcdesc}{str}{float}
@ -118,48 +123,50 @@ account.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atof}{string} \begin{funcdesc}{atof}{string}
Converts a string to a floating point number, following the \code{LC_NUMERIC} Converts a string to a floating point number, following the
settings. \constant{LC_NUMERIC} settings.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{atoi}{string} \begin{funcdesc}{atoi}{string}
Converts a string to an integer, following the \code{LC_NUMERIC} conventions. Converts a string to an integer, following the \constant{LC_NUMERIC}
conventions.
\end{funcdesc} \end{funcdesc}
\begin{datadesc}{LC_CTYPE} \begin{datadesc}{LC_CTYPE}
\refstmodindex{string} \refstmodindex{string}
Locale category for the character type functions. Depending on the Locale category for the character type functions. Depending on the
settings of this category, the functions of module \code{string} settings of this category, the functions of module \module{string}
dealing with case change their behaviour. dealing with case change their behaviour.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_COLLATE} \begin{datadesc}{LC_COLLATE}
Locale category for sorting strings. The functions \code{strcoll()} and Locale category for sorting strings. The functions
\code{strxfrm()} of the \code{locale} module are affected. \function{strcoll()} and \function{strxfrm()} of the \module{locale}
module are affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_TIME} \begin{datadesc}{LC_TIME}
Locale category for the formatting of time. The function Locale category for the formatting of time. The function
\code{time.strftime()} follows these conventions. \function{time.strftime()} follows these conventions.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MONETARY} \begin{datadesc}{LC_MONETARY}
Locale category for formatting of monetary values. The available Locale category for formatting of monetary values. The available
options are available from the \code{localeconv()} function. options are available from the \function{localeconv()} function.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_MESSAGES} \begin{datadesc}{LC_MESSAGES}
Locale category for message display. Python currently does not support Locale category for message display. Python currently does not support
application specific locale-aware messages. Messages displayed by the application specific locale-aware messages. Messages displayed by the
operating system, like those returned by \code{posix.strerror()} might operating system, like those returned by \function{os.strerror()}
be affected by this category. might be affected by this category.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_NUMERIC} \begin{datadesc}{LC_NUMERIC}
Locale category for formatting numbers. The functions Locale category for formatting numbers. The functions
\code{format()}, \code{atoi()}, \code{atof()} and \code{str()} of the \function{format()}, \function{atoi()}, \function{atof()} and
\code{locale} module are affected by that category. All other numeric \function{str()} of the \module{locale} module are affected by that
formatting operations are not affected. category. All other numeric formatting operations are not affected.
\end{datadesc} \end{datadesc}
\begin{datadesc}{LC_ALL} \begin{datadesc}{LC_ALL}
@ -173,13 +180,9 @@ used to restore the settings.
\begin{datadesc}{CHAR_MAX} \begin{datadesc}{CHAR_MAX}
This is a symbolic constant used for different values returned by This is a symbolic constant used for different values returned by
\code{localeconv()}. \function{localeconv()}.
\end{datadesc} \end{datadesc}
\begin{excdesc}{Error}
Exception raised when \code{setlocale()} fails.
\end{excdesc}
Example: Example:
\begin{verbatim} \begin{verbatim}
@ -205,50 +208,54 @@ matter what the user's preferred locale is. The program must
explicitly say that it wants the user's preferred locale settings by explicitly say that it wants the user's preferred locale settings by
calling \code{setlocale(LC_ALL, "")}. calling \code{setlocale(LC_ALL, "")}.
It is generally a bad idea to call \code{setlocale()} in some library It is generally a bad idea to call \function{setlocale()} in some library
routine, since as a side effect it affects the entire program. Saving routine, since as a side effect it affects the entire program. Saving
and restoring it is almost as bad: it is expensive and affects other and restoring it is almost as bad: it is expensive and affects other
threads that happen to run before the settings have been restored. threads that happen to run before the settings have been restored.
If, when coding a module for general use, you need a locale If, when coding a module for general use, you need a locale
independent version of an operation that is affected by the locale independent version of an operation that is affected by the locale
(e.g. \code{string.lower()}, or certain formats used with (e.g. \function{string.lower()}, or certain formats used with
\code{time.strftime()})), you will have to find a way to do it without \function{time.strftime()})), you will have to find a way to do it
using the standard library routine. Even better is convincing without using the standard library routine. Even better is convincing
yourself that using locale settings is okay. Only as a last should yourself that using locale settings is okay. Only as a last resort
you document that your module is not compatible with non-C locale should you document that your module is not compatible with non-C
settings. locale settings.
The case conversion functions in the \code{string} and \code{strop} The case conversion functions in the
modules are affected by the locale settings. When a call to the \module{string}\refstmodindex{string} and
\code{setlocale()} function changes the \code{LC_CTYPE} settings, the \module{strop}\refbimodindex{strop} modules are affected by the locale
variables \code{string.lowercase}, \code{string.uppercase} and settings. When a call to the \function{setlocale()} function changes
\code{string.letters} (and their counterparts in \code{strop}) are the \constant{LC_CTYPE} settings, the variables
\code{string.lowercase}, \code{string.uppercase} and
\code{string.letters} (and their counterparts in \module{strop}) are
recalculated. Note that this code that uses these variable through recalculated. Note that this code that uses these variable through
\code{from ... import ...}, e.g. \code{from string import letters}, is `\keyword{from} ... \keyword{import} ...', e.g. \code{from string
not affected by subsequent \code{setlocale()} calls. import letters}, is not affected by subsequent \function{setlocale()}
calls.
The only way to perform numeric operations according to the locale The only way to perform numeric operations according to the locale
is to use the special functions defined by this module: is to use the special functions defined by this module:
\code{atof()}, \code{atoi()}, \code{format()}, \code{str()}. \function{atof()}, \function{atoi()}, \function{format()},
\function{str()}.
\code{For extension writers and programs that embed Python} \subsection{For extension writers and programs that embed Python}
Extension modules should never call \code{setlocale()}, except to find Extension modules should never call \function{setlocale()}, except to
out what the current locale is. But since the return value can only find out what the current locale is. But since the return value can
be used portably to restore it, that is not very useful (except only be used portably to restore it, that is not very useful (except
perhaps to find out whether or not the locale is ``C''). perhaps to find out whether or not the locale is ``C'').
When Python is embedded in an application, if the application sets the When Python is embedded in an application, if the application sets the
locale to something specific before initializing Python, that is locale to something specific before initializing Python, that is
generally okay, and Python will use whatever locale is set, generally okay, and Python will use whatever locale is set,
\strong{except} that the \code{LC_NUMERIC} locale should always be \strong{except} that the \constant{LC_NUMERIC} locale should always be
``C''. ``C''.
The \code{setlocale()} function in the \code{locale} module contains The \function{setlocale()} function in the \module{locale} module contains
gives the Python progammer the impression that you can manipulate the gives the Python progammer the impression that you can manipulate the
\code{LC_NUMERIC} locale setting, but this not the case at the C \constant{LC_NUMERIC} locale setting, but this not the case at the C
level: C code will always find that the \code{LC_NUMERIC} locale level: C code will always find that the \constant{LC_NUMERIC} locale
setting is ``C''. This is because too much would break when the setting is ``C''. This is because too much would break when the
decimal point character is set to something else than a period decimal point character is set to something else than a period
(e.g. the Python parser would break). Caveat: threads that run (e.g. the Python parser would break). Caveat: threads that run
@ -258,9 +265,9 @@ portable way to implement this feature is to set the numeric locale
settings to what the user requests, extract the relevant settings to what the user requests, extract the relevant
characteristics, and then restore the ``C'' numeric locale. characteristics, and then restore the ``C'' numeric locale.
When Python code uses the \code{locale} module to change the locale, When Python code uses the \module{locale} module to change the locale,
this also affect the embedding application. If the embedding this also affect the embedding application. If the embedding
application doesn't want this to happen, it should remove the application doesn't want this to happen, it should remove the
\code{_locale} extension module (which does all the work) from the \module{_locale} extension module (which does all the work) from the
table of built-in modules in the \code{config.c} file, and make sure table of built-in modules in the \file{config.c} file, and make sure
that the \code{_locale} module is not accessible as a shared library. that the \module{_locale} module is not accessible as a shared library.