bpo-33400: Clarified documentation to indicate no strict adherence to… · python/cpython@eb5abdc

@@ -473,7 +473,8 @@ def __init__(self, fmt=None, datefmt=None, style='%'):

473473474474

Initialize the formatter either with the specified format string, or a

475475

default as described above. Allow for specialized date formatting with

476-

the optional datefmt argument (if omitted, you get the ISO8601 format).

476+

the optional datefmt argument. If datefmt is omitted, you get an

477+

ISO8601-like (or RFC 3339-like) format.

477478478479

Use a style parameter of '%', '{' or '$' to specify that you want to

479480

use one of %-formatting, :meth:`str.format` (``{}``) formatting or

@@ -501,13 +502,13 @@ def formatTime(self, record, datefmt=None):

501502

in formatters to provide for any specific requirement, but the

502503

basic behaviour is as follows: if datefmt (a string) is specified,

503504

it is used with time.strftime() to format the creation time of the

504-

record. Otherwise, the ISO8601 format is used. The resulting

505-

string is returned. This function uses a user-configurable function

506-

to convert the creation time to a tuple. By default, time.localtime()

507-

is used; to change this for a particular formatter instance, set the

508-

'converter' attribute to a function with the same signature as

509-

time.localtime() or time.gmtime(). To change it for all formatters,

510-

for example if you want all logging times to be shown in GMT,

505+

record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used.

506+

The resulting string is returned. This function uses a user-configurable

507+

function to convert the creation time to a tuple. By default,

508+

time.localtime() is used; to change this for a particular formatter

509+

instance, set the 'converter' attribute to a function with the same

510+

signature as time.localtime() or time.gmtime(). To change it for all

511+

formatters, for example if you want all logging times to be shown in GMT,

511512

set the 'converter' attribute in the Formatter class.

512513

"""

513514

ct = self.converter(record.created)