<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Martel.Time</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Martel-module.html">Package Martel</a> ::
Module Time
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Martel.Time-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module Time</h1><p class="nomargin-top"><span class="codelink"><a href="Martel.Time-pysrc.html">source code</a></span></p>
<pre class="literalblock">
Parse a time or date string.
Converts a strftime/strptime-like format string into a Martel regular
expression (either as a string or an Expression).
Example use:
>>> from Martel import Time
>>> from xml.sax import saxutils
>>> format = Time.make_expression("%(Jan)-%(day)-%(YYYY)
")
>>> parser = format.make_parser()
>>> parser.setContentHandler(saxutils.XMLGenerator())
>>> parser.parseString("OCT-31-2021\n")
<?xml version="1.0" encoding="iso-8859-1"?>
<month type="short">OCT</month>-<day type="numeric">31</day>-<year type="long">2021</year>
>>>
Times and dates come up often in parsing. It's usually pretty easily
to write a syntax for them on the fly. For example, suppose you want
to parse a date in the format
YYYY-MM-DD
as in "1985-03-26". One pattern for that is
"\d{4}-\d{2}-\d{2}"
To get the individual fields in Martel requires group names.
"(?P<year>\d{4})-(?P<month>\d{2})-(?P<day>\d{2})"
If you want some minimal verification (eg, to help make sure you
haven't accidentally swapped the day and month fields) you need to
tighten down on what values are allowed, as in
"(?P<year>\d{4})-(?P<month>0[1-9]|1[012])-(?P<day>0[1-9]|[12][0-9]|3[01])"
The more you write, the more the likelihood of making a mistake, the
more the chance different format definitions use different patterns,
the harder it is to understand what's going on.
This module helps by providing a set of standard definitions for the
different terms needed in parsing dates, and a way to generate those
definitions from a relatively easy to understand format string.
The syntax of the format string is based on that used by the standard
unix strftime/strptime functions, with terms taken from the POSIX and
GNU documentation plus some experimentation. These terms are in the
form "%c" where "c" is a single character. It's hard to remember
everything through a not always mnemonic single character code, so
Martel.Time adds a new syntax of the form "%(word)" where word can be
one of the single characters, or a multicharacter word. For example,
"%(Mon)" is identical to "%a" but easier to understand.
The complete list of definitions is given below.
The lowest-level terms (like "year", but excluding terms like "%D"
which expand to other terms) are inside of named groups, which
generate the element tag and attributes when used for Martel.
For example, "%m" generates the pattern used for a month, from "01" to
"12". The name of the group is "month" and it has a single attribute
named "type" with value "numeric". (All "numeric" types can be parsed
with Python's 'int' function.) The default pattern made from "%m" is
(?P<month?type=numeric>(0[1-9]|1[012]))
and when parsed against a month value, like "05", produces
<month type="numeric">05</month>
The "type" attribute is used because values which mean the same thing
can be represented in different formats. The month "January" can be
represented with the word "January" (type = "long"), "Jan" (type =
"short"), "01" (type = "numeric"), "1" (type = "numeric"), or " 1"
(type = "numeric"). [Note: It is possible that subtypes may be added
in the future to distinguish between these different numeric cases.]
FUNCTIONS:
There are two public functions -- "make_pattern" and
"make_expression". Both take the same parameters and return a regular
expression.
make_pattern(format, tag_format = "%s") -- returns the expression
as a pattern string
make_expression(format, tag_format = "%s") -- returns the expression
as a Martel.Expression data structure (which can be used to
make a parser)
The first parameter, "format", is the time format string already
discussed. Some examples are:
>>> from Martel import Time
>>> Time.make_pattern("%y")
'(?P<year?type=short>\\d{2})'
>>> Time.make_pattern("%H:%M")
'(?P<hour?type=24-hour>([01][0-9]|2[0-3]))\\:(?P<minute?type=numeric>[0-5][0-9])'
>>>
The second parameter is used if you want to change the tag name. For
example, instead of "year" you may want "year-modified" or
"start-year" -- or you may not want a tag at all.
For each term, the tag name ("year", "month", etc.) is %'ed with the
tag_format string. The default string is "%s" which effectively says
to keep the name unchanged. Here are a couple examples which use a
different string.
>>> from Martel import Time
>>> Time.make_pattern("%(year)", "%s-modified")
'(?P<year-modified?type=any>([0-9]{2}([0-9]{2})?))'
>>> Time.make_pattern("%(year)", "start-%s")
'(?P<start-year?type=any>([0-9]{2}([0-9]{2})?))'
>>> Time.make_pattern("%(year)", None)
'([0-9]{2}([0-9]{2})?)'
>>>
The tag_format is used for every tag name, which lets you modify
several values at once. You can even pass in an object which
implements the __mod__ method to make more drastic changes to the
name.
>>> Time.make_pattern("%H:%M", "%s-created")
'(?P<hour-created?type=24-hour>([01][0-9]|2[0-3]))\\:(?P<minute-created?type=numeric>[0-5][0-9])'
>>> class Upcase:
... def __mod__(self, name):
... return name.upper()
...
>>> Time.make_pattern("%H:%M", Upcase())
'(?P<HOUR?type=24-hour>([01][0-9]|2[0-3]))\:(?P<MINUTE?type=numeric>[0-5][0-9])'
>>>
BUGS:
Only the "C" locale (essentialy, US/English) is supported. Field
widths (as in "%-5d") are not supported.
There is no way to change the element attributes. I'm not sure this
is a bug.
==== Table of Date/Time Specifiers ====
%a is replaced by the pattern for the abbreviated weekday name.
Pattern: (Mon|Tue|Wed|Thu|Fri|Sat|Sun)
(the real pattern is case insensitive)
Example: "Wed" "FRI"
Element name: "weekday"
Element attributes: "type" = "short"
Note: %(Mon) is the same as %a
%A is replaced by the pattern for the full weekday name.
Pattern: (Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday)
(the real pattern is case insensitive)
Example: "Thursday" "SUNDAY"
Element name: "weekday"
Element attributes: "type" = "long"
Note: %(Monday) is the same as %a
%b is replaced by the the pattern for the abbreviated month name.
Pattern: (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)
(the real pattern is case insensitive)
Example: "Oct" "AUG"
Element name: "month"
Element attributes: "type" = "short"
Note: %(Jan) is the same as %b
%B is replaced by the pattern for the full month name.
Pattern: (January|February|March|April|May|June|July|August|
September|October|November|December)
(the real pattern is case insensitive)
Example: "August", "MAY"
Element name: "month"
Element attributes: "type" = "long"
Note: %(January) is the same as %B
%c is replaced by the pattern for the US 24-hour date and time
representation.
Pattern: same as "%a %b %e %T %Y"
Example: "Wed Dec 12 19:57:22 2001"
Element: only uses names and attributes of the individual terms
%C is replaced by the pattern for the century number (the year divided
by 100 and truncated to an integer) as a decimal number [00-99].
Pattern: "[0-9][0-9]"
Example: "19" for the years 1900 to 1999
Element name: "century"
Element attributes: "type" = "numeric"
%d is replaced by the pattern for a day of the month as a decimal
number [01,31].
Pattern: (0[1-9]|[12][0-9]|3[01])
Example: "01", "12"
Element name: "day"
Element attributes: "type": "numeric"
Note: "%d" does not include " 1" or "1". If you also want to allow
those then use "%(day)"
%D same as the pattern for "%m/%d/%y".
Pattern: see "%m/%d/%y".
Example: "12/13/01"
Element: only uses names and attributes of the individual terms
%e is replaced by the pattern for a day of the month as a decimal
number [1,31]; a single digit is preceded by a space.
Pattern: "( [1-9]|[12][0-9]|3[01])"
Example: " 1", "31"
Element name: "day"
Element attributes: "type" = "numeric"
Note: "%e" does not include "01" or "1". If you also want to allow
those then use "%(day)"
%F same as the pattern for "%Y-%m-%d".
Pattern: see "%Y-%m-%d".
Example: "2001-12-21"
Element: only uses names and attributes of the individual terms
%g ISO 8601 2-digit (like %G but without the century) (00-99)
Pattern: [0-9][0-9]
Example: "00"
Element name: "century"
Element attributes: "type" = "ISO8601"
%G Pattern for the ISO 8601 year with century as a decimal number.
The 4-digit year corresponding to the ISO week number (see %V).
This has the same format and value as %y, except that if the ISO
week number belongs to the previous or next year, that year is
used instead. (TZ)
Pattern: [0-9][0-9][0-9][0-9]
Example: "1954" "2001"
Element name: "year"
Element attributes: "type" = "ISO8601"
%h (DEPRECATED) same as %b.
Pattern: (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)
Example: "Feb"
Element name: "month"
Element attributes: "type" = "short"
Note: %(Jan) is the same as %b is the same as %h
%H is replaced by the pattern for the hour on a 24-hour clock, as
a decimal number [00,23].
Pattern: ([01][0-9]|2[0-3])
Example: "00", "01", "23"
Element name: "hour"
Element attributes: "type" = "24-hour"
Note: This does not allow single digit hours like "1". If you also
want to include those, use %(24-hour)
%I is replaced by the pattern for the hour on a 12-hour clock, as
a decimal number [01,12].
Pattern: (0[0-9]|1[012])
Example: "01", "12"
Element name: "hour"
Element attributes: "type" = "12-hour"
Note: This does not allow single digit hours like "1". If you also
want to include those, use %(12-hour)
%j is replaced by the pattern for day of the year as a decimal
number. First day is numbered "001" [001,366].
Pattern: "([12][0-9][0-9]|3([012345][0-9]|6[0-6])|0(0[1-9]|[1-9][0-9]))"
Example: "001", "092", "362"
Element name: "year_day"
Element attributes: "type": "1"
%k is replaced by the pattern for the hour on a 24-hour clock, as a
decimal number (range 0 to 23); single digits are preceded by a
blank.
Pattern: "( [0-9]|1[0-9]|2[0123])"
Example: " 1", "10", "23"
Element name: "hour"
Element attributes: "type" = "24-hour"
Note: This does not allow single digit hours like "1" or hours which
start with an "0" like "03". If you also want to include those,
use %(24-hour). See also %H.
%l is replaced by the pattern for the hour on a 12-hour clock, as a
decimal number (range 1 to 12); single digits are preceded by a
blank.
Pattern: "( [0-9]|1[012])"
Example: " 1", "10", "12"
Element name: "hour"
Element attributes: "type" = "12-hour"
Note: This does not allow single digit hours like "1" or hours which
start with an "0" like "03". If you also want to include those,
use %(12-hour). See also %I.
%m is replaced by the pattern for the month as a decimal number [01,12].
Pattern: "(0[1-9]|1[012])"
Example: "01", "09", "12"
Element name: "month"
Element attributes: "type" = "numeric"
Note: This does not allow single digit months like "1" or months which
start with an space like " 3". If you also want to include those,
use %(month). See also %(DD), which is an alias for %m.
%M is replaced by the pattern for the minute as a decimal number [00,59].
Pattern: "[0-5][0-9]"
Example: "00", "38"
Element name: "minute"
Element attributes: "type" = "numeric"
Note: this is the same as %(minute)
%n is replaced by the pattern for the newline character.
Pattern: "\n"
Note: you shouldn't need to use this
%p is replaced by the case insensitive pattern for "AM" or "PM"
Pattern: "([AaPp][Mm])"
Example: "AM", "pm"
Element name: "ampm"
Element attributes: no attributes
Note: this doesn't allow "a.m." or "P.M."
%P is identical to "%p" (they have slightly different meanings for output)
Pattern: "([AaPp][Mm])"
Example: "am", "PM"
Element name: "ampm"
Element attributes: no attributes
Note: this doesn't allow "a.m." or "P.M."
%r is equivalent to "%I:%M:%S %p".
Pattern: see the patterns for the individual terms
Example: "07:57:22 PM"
Element: only uses names and attributes of the individual terms
%R is the pattern for the 24 hour notation "%H:%M".
Pattern: see the patterns for the individual terms
Example: "19:57"
Element: only uses names and attributes of the individual terms
%s is pattern for a decimal number of seconds (Unix timestamp)
Pattern: "[0-9]+"
Example: "1008205042"
Element name: "timestamp"
Element attributes: no attributes
%S is replaced by the pattern for the second as a decimal number
Can take values from "00" to "61" (includes double leap seconds).
Pattern: "([0-5][0-9]|6[01])"
Example: "03", "25"
Element name: "second"
Element attributes: "type" = "numeric"
Note: This is the same as %(second)
%t is replaced by a tab character. (plat-spec)
Pattern: "\t"
Note: You shouldn't need to use this.
%T is identical to the 24-hour time format "%H:%M:%S".
Pattern: see the patterns for the individual terms
Example: "19:57:22"
Element: only uses names and attributes of the individual terms
%u is replaced by the pattern for the weekday as a decimal number
[1,7], with "1" representing Monday.
Pattern: "[1-7]"
Example: "4" (which is Thursday)
Element name: "weekday"
Element attributes: "type" = "Monday1"
Note: See also %w, which has a type of "Sunday0"
%U is replaced by the pattern for the week number of the year (Sunday
as the first day of the week) as a decimal number [00,53]. In
other words, this is the number of Sundays seen so far in the year.
Pattern: "([0-4][0-9]|5[0-3])"
Example: "04", "26"
Element name: "week_number"
Element attributes: "type" = "Sunday_count"
Note: See also %V and %W
%V is replaced by the pattern for the week number of the year (Monday
as the first day of the week) as a decimal number [01,53]. This is
used for week numbers where if the week containing 1 January has four
or more days in the new year, then it is considered week 1. (Otherwise,
it is the last week of the previous year, and the next week is week 1.)
Pattern: "(0[1-9]|[1-4][0-9]|5[0-3])"
Example: "04", "33"
Element name: "week_number"
Element attributes: "type" = "type_V" (Got a better short name?)
Note: See also %U and %W. I don't know when to use this.
%w is replaced by pattern for the the weekday as a decimal number [0,6],
with 0 representing Sunday.
Pattern: "[0-6]"
Example: "6"
Element name: "weekday"
Element attributes: "type" = "Sunday0"
Note: See also %u, which has a type of "Monday1"
%W is replaced by the pattern for the week number of the year (Monday
as the first day of the week) as a decimal number [00,53]. All days
in a new year preceding the first Monday are considered to be in
week 0. In other words, this is the number of Mondays seen so far
in the year.
Pattern: "([0-4][0-9]|5[0-3])"
Example: "00", "49"
Element name: "week_number"
Element attributes: "type" = "Monday_count"
Note: See also %U and %V.
%x is the same as "%D", which is "%m/%d/%y".
Pattern: see the patterns for the individual terms
Example: "12/13/99"
Element: only uses names and attributes of the individual terms
%X is the same as "%T", which is "%H:%M:%S".
Pattern: see the patterns for the individual terms
Example: "19:57:22"
Element: only uses names and attributes of the individual terms
%y is replaced by the pattern for the year without century, as a
decimal number [00,99].
Pattern: "[0-9][0-9]"
Example: "89", "01"
Element name: "year"
Element attributes: "type" = "short"
Note: This is the same as %(YY).
%Y is replaced by the pattern for the year, including the century, as a
decimal number.
Pattern: "[0-9][0-9][0-9][0-9]"
Example: "1610", "2002"
Element name: "year"
Element attributes: "type" = "long"
Note: This is the same as %(YYYY).
%z is replaced by the pattern for the time-zone as hour offset from GMT.
(This is used when parsing RFC822-conformant dates, as in
"%a, %d %b %Y %H:%M:%S %z", except that %z does not include the
pattern for a missing timezone -- should I fix that?).
Pattern: "[-+][0-9][0-9][0-9][0-9]"
Example: "-0500" (for EST), "+0100" (for CET), "+0530" (somewhere in India)
Element name: "timezone"
Element attributes: "type" = "RFC822"
%Z is replaced by a pattern for a timezone name or abbreviation. (It does
not allow missing timezone field.)
Pattern: "(GMT([+-][0-9][0-9][0-9][0-9])?|[A-Z][a-zA-Z]*( [A-Z][a-zA-Z]*)*)"
(is there anything better?)
Example: "MST", "GMT", "Pacific Standard Time", "GRNLNDST", "MET DST",
"New Zealand Standard Time", "NZST", "SAST", "GMT+0200", "IDT"
Element name: "timezone"
Element attributes: "type" = "name"
%% is replaced by the pattern for "%" (which happens to be "%")
Pattern: "%"
Example: "%"
Element: none
=== Martel specific extensions ===
%(Mon) is the same as "%a".
Pattern: See the definition for "%a"
Example: "Wed" "FRI"
Element name: "weekday"
Element attributes: "type" = "short"
%(Monday) is the same as "%A".
Pattern: See the definition for "%A"
Example: "Thursday" "SUNDAY"
Element name: "weekday"
Element attributes: "type" = "long"
%(Jan) is the same as "%b".
Pattern: See the definition for "%b"
Example: "Feb"
Element name: "month"
Element attributes: "type" = "short"
%(January) is the same as "%B".
Pattern: See the definition for "%B"
Example: "August", "MAY"
Element name: "month"
Element attributes: "type" = "long"
%(second) is the same as "%S".
Pattern: See the definition for "%S".
Example: "03", "25"
Element name: "second"
Element attributes: "type" = "numeric"
%(minute) is the same as "%M".
Pattern: See the definition for "%M"
Example: "00", "38"
Element name: "minute"
Element attributes: "type" = "numeric"
%(12-hour) is replaced by the pattern for a 12 hour clock in any of
the common formats. (Numeric values from 1 to 12.)
Pattern: "(0[1-9]|1[012]?|[2-9]| [1-9])"
Example: "2", "02", " 2", "10"
Element name: "hour"
Element attributes: "type" = "12-hour"
%(24-hour) is replaced by the pattern for a 24 hour clock in any
of the common formats. (Numeric values from 0 to 23.)
Pattern: "([01][0-9]?|2[0123]?|[3-9]| [1-9])"
Example: "9", "09", " 9", "00", "0", " 0", "23"
Element name: "hour"
Element attributes: "type" = "24-hour"
%(hour) is replaced by the pattern for any hour in either a
12-hour or 24-hour clock.
Pattern: "([01][0-9]?|2[0123]?|[3-9]| [1-9])"
(this happens to be the same as %(24-hour)
Example: "9", "09", " 9", "00", "0", " 0", "23"
Element name: "hour"
Element attributes: "type" = "any"
%(day) is replaced by the pattern for the day of the month as a decimal
in any of the common day format
Pattern: "(0[1-9]|[12][0-9]?|3[01]?|[4-9]| [1-9])"
Example: "9", "09", " 9", and "31"
Element name: "day"
Element attributes: "type" = "numeric"
%(DD) is the same as "%d", which is the pattern for a day of the month
as a decimal number [01,31].
Pattern: See the definition for "%d"
Example: "09", "31"
Element name: "day"
Element attributes: "type" = "numeric"
%(month) is replaced by the pattern for the month as a decimal in any
of the common month formats.
Pattern: "(0[1-9]|1[012]?|[2-9]| [1-9])"
Example: "5", "05", " 5", and "12".
Element name: "month"
Element attributes: "type" = "numeric"
Note: See also "%m" and %(MM).
%(MM) is the same as "%m", which is a two-digit month number [01,12]
Pattern: See the definition for "%m"
Example: "05", "01", and "12".
Element name: "month"
Element attributes: "type" = "numeric"
Note: See also %(month).
%(YY)
Pattern: "[0-9][0-9]"
Example: "10"
Element name: "year"
Element attributes: "type" = "short"
%(YYYY)
Pattern: "[0-9][0-9][0-9][0-9]"
Example: "1970"
Element name: "year"
Element attributes: "type" = "long"
%(year) is replaced by the pattern accepting 2 digit and 4 digit year formats.
Pattern: "([0-9]{2}([0-9]{2})?)"
Example: "2008", "97"
Element name: "year"
Element attributes: "type" = "any"
Note: Need to change this before the year 10,000
</pre>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_any_case"></a><span class="summary-sig-name">_any_case</span>(<span class="summary-sig-arg">s</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Time-pysrc.html#_any_case">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Martel.Time-module.html#make_pattern" class="summary-sig-name">make_pattern</a>(<span class="summary-sig-arg">format</span>,
<span class="summary-sig-arg">tag_format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">%s</code><code class="variable-quote">'</code></span>)</span><br />
format, tag_format = "%s" -> regular expression pattern
string</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Time-pysrc.html#make_pattern">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Martel.Time-module.html#make_expression" class="summary-sig-name">make_expression</a>(<span class="summary-sig-arg">format</span>,
<span class="summary-sig-arg">tag_format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">%s</code><code class="variable-quote">'</code></span>)</span><br />
format, tag_format = "%s" -> Martel Expresion</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Time-pysrc.html#make_expression">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_use_tag_format"></a><span class="summary-sig-name">_use_tag_format</span>(<span class="summary-sig-arg">tag_format</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Time-pysrc.html#_use_tag_format">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_parse_time"></a><span class="summary-sig-name">_parse_time</span>(<span class="summary-sig-arg">s</span>,
<span class="summary-sig-arg">tag_format</span>,
<span class="summary-sig-arg">text_to_result</span>,
<span class="summary-sig-arg">group_to_result</span>,
<span class="summary-sig-arg">re_to_result</span>,
<span class="summary-sig-arg">t</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Time-pysrc.html#_parse_time">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Time-module.html#_time_fields" class="summary-name" onclick="show_private();">_time_fields</a> = <code title="(('a',
'([Mm][Oo][Nn]|[Tt][Uu][Ee]|[Ww][Ee][Dd]|[Tt][Hh][Uu]|[Ff][Rr][Ii]|[\
Ss][Aa][Tt]|[Ss][Uu][Nn])',
'weekday',
{'type': 'short'}),
('A',
'([Mm][Oo][Nn][Dd][Aa][Yy]|[Tt][Uu][Ee][Ss][Dd][Aa][Yy]|[Ww][Ee][Dd]\
[Nn][Ee][Ss][Dd][Aa][Yy]|[Tt][Hh][Uu][Rr][Ss][Dd][Aa][Yy]|[Ff][Rr][Ii]\
..."><code class="variable-group">(</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">a</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">([Mm][Oo][Nn]|[Tt][Uu][Ee]|[Ww][Ee][Dd]</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Time-module.html#_time_table" class="summary-name" onclick="show_private();">_time_table</a> = <code title="{'%': ('%', None, None),
'12-hour': ('(0[1-9]|1[012]?|[2-9]| [1-9])',
'hour',
{'type': '12-hour'}),
'24-hour': ('([01][0-9]?|2[0123]?|[3-9]| [0-9])',
'hour',
{'type': '24-hour'}),
'A': ('([Mm][Oo][Nn][Dd][Aa][Yy]|[Tt][Uu][Ee][Ss][Dd][Aa][Yy]|[Ww][Ee\
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">%</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">%</code><code class="variable-quote">'</code><code class="variable-op">, </code>None<code class="variable-op">, </code>None<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">12-hour</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">(0[1-9]|1[</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="attrs"></a><span class="summary-name">attrs</span> = <code title="{'type': 'any'}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">type</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">any</code><code class="variable-quote">'</code><code class="variable-group">}</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="pat"></a><span class="summary-name">pat</span> = <code title="'([0-9]{2}([0-9]{2})?)'"><code class="variable-quote">'</code><code class="variable-string">([0-9]{2}([0-9]{2})?)</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="spec"></a><span class="summary-name">spec</span> = <code title="'year'"><code class="variable-quote">'</code><code class="variable-string">year</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="tag"></a><span class="summary-name">tag</span> = <code title="'year'"><code class="variable-quote">'</code><code class="variable-string">year</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="v"></a><span class="summary-name">v</span> = <code title="'[-+]\\d{4}'"><code class="variable-quote">'</code><code class="variable-string">[-+]\\d{4}</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="make_pattern"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">make_pattern</span>(<span class="sig-arg">format</span>,
<span class="sig-arg">tag_format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">%s</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Time-pysrc.html#make_pattern">source code</a></span>
</td>
</tr></table>
<p>format, tag_format = "%s" -> regular expression pattern
string</p>
<p>Turn the given time format string into the corresponding regular
expression string. A format term may contain a Group name and attribute
information. If present, the group name is %'ed with the tag_format to
produce the tag name to use. Use None to specify that named groups
should not be used.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> Martel <span class="py-keyword">import</span> Time
<span class="py-prompt">>>> </span><span class="py-keyword">print</span> Time.make_pattern(<span class="py-string">"%m-%Y)"</span>, <span class="py-string">"created-%s"</span>)
<span class="py-output">(?P<created-month?type=numeric>(0[1-9]|1[012]))\-(?P<created-year?type=long>\d{4})\)</span>
<span class="py-output"></span><span class="py-prompt">>>></span></pre>
<p>See the Time module docstring for more information.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="make_expression"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">make_expression</span>(<span class="sig-arg">format</span>,
<span class="sig-arg">tag_format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">%s</code><code class="variable-quote">'</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Time-pysrc.html#make_expression">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
format, tag_format = "%s" -> Martel Expresion
Turn the given time format string into the corresponding Martel
Expression. A format term may contain a Group name and attribute
information. If present, the group name is %'ed with the
tag_format to produce the tag name to use. Use None to specify
that named groups should not be used.
>>> from Martel import Time
>>> from xml.sax import saxutils
>>> exp = Time.make_expression("%m-%Y\n", "created-%s")
>>> parser = exp.make_parser()
>>> parser.setContentHandler(saxutils.XMLGenerator())
>>> parser.parseString("05-1921
")
<?xml version="1.0" encoding="iso-8859-1"?>
<created-month type="numeric">05</created-month>-<created-year type="long">1921</created-year>
>>>
See the Time module docstring for more information.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_time_fields"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_time_fields</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">(</code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">a</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">([Mm][Oo][Nn]|[Tt][Uu][Ee]|[Ww][Ee][Dd]|[Tt][Hh][Uu]|[Ff][Rr][Ii]|[</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">Ss][Aa][Tt]|[Ss][Uu][Nn])</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">weekday</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">type</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">short</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">A</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">([Mm][Oo][Nn][Dd][Aa][Yy]|[Tt][Uu][Ee][Ss][Dd][Aa][Yy]|[Ww][Ee][Dd]</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">[Nn][Ee][Ss][Dd][Aa][Yy]|[Tt][Hh][Uu][Rr][Ss][Dd][Aa][Yy]|[Ff][Rr][Ii]</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_time_table"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_time_table</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">%</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">%</code><code class="variable-quote">'</code><code class="variable-op">, </code>None<code class="variable-op">, </code>None<code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">12-hour</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">(0[1-9]|1[012]?|[2-9]| [1-9])</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">hour</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">type</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">12-hour</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">24-hour</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">([01][0-9]?|2[0123]?|[3-9]| [0-9])</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">hour</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">type</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">24-hour</code><code class="variable-quote">'</code><code class="variable-group">}</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">A</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">([Mm][Oo][Nn][Dd][Aa][Yy]|[Tt][Uu][Ee][Ss][Dd][Aa][Yy]|[Ww][Ee</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:29 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
