docs/pyutils.datetimez.rst

   1 yutils.datetimez package
   2 =========================
   3
   4 Submodules
   5 ----------
   6
   7 pyutils.datetimez.constants module
   8 ----------------------------------
   9
  10 A set of date and time related constants.
  11
  12 .. automodule:: pyutils.datetimez.constants
  13    :members:
  14    :undoc-members:
  15    :show-inheritance:
  16
  17 pyutils.datetimez.dateparse\_utils module
  18 -----------------------------------------
  19
  20 The dateparse\_utils.DateParser class uses an English language grammar
  21 (see dateparse\_utils.g4) to parse free form English text into a Python
  22 datetime.  It can handle somewhat complex constructs such as: "20 days
  23 from next Wed at 3pm", "last Christmas", and "The 2nd Sunday in May,
  24 2022".  See the dateparse_utils_test.py for more examples.
  25
  26 This code is used by other code in the pyutils library; for example,
  27 when using argparse_utils.py to pass an argument of type datetime it
  28 allows the user to use free form english expressions.
  29
  30 .. automodule:: pyutils.datetimez.dateparse_utils
  31    :members:
  32    :undoc-members:
  33    :exclude-members: enterAmpm,
  34                      enterBaseAndOffsetDateExpr,
  35                      enterBaseAndOffsetTimeExpr,
  36                      enterBaseDate,
  37                      enterBaseTime,
  38                      enterCountUnitsBeforeAfterTimeExpr,
  39                      enterDateExpr,
  40                      enterDayMonthMaybeYearExpr,
  41                      enterDayName,
  42                      enterDayOfMonth,
  43                      enterDdiv,
  44                      enterDeltaBeforeAfter,
  45                      enterDeltaDateExprRelativeToTodayImplied,
  46                      enterDeltaNextLast,enterDeltaPlusMinusExpr,
  47                      enterDeltaPlusMinusTimeExpr,
  48                      enterDeltaRelativeToTodayExpr,
  49                      enterDeltaTimeBeforeAfter,
  50                      enterDeltaTimeFraction,
  51                      enterDeltaTimeUnit,
  52                      enterDeltaUnit,
  53                      enterDtdiv,
  54                      enterFirstLastWeekdayInMonthMaybeYearExpr,
  55                      enterFirstOrLast,
  56                      enterFractionBeforeAfterTimeExpr,
  57                      enterHour,
  58                      enterLtz,
  59                      enterMicros,
  60                      enterMinute,
  61                      enterMonthDayMaybeYearExpr,
  62                      enterMonthExpr,
  63                      enterMonthName,
  64                      enterMonthNumber,
  65                      enterNFoosFromTodayAgoExpr,
  66                      enterNth,
  67                      enterNthWeekdayInMonthMaybeYearExpr,
  68                      enterNtz,
  69                      enterParse,
  70                      enterSecond,
  71                      enterSingleDateExpr,
  72                      enterSingleTimeExpr,
  73                      enterSpecialDate,
  74                      enterSpecialDateMaybeYearExpr,
  75                      enterSpecialTime,
  76                      enterSpecialTimeExpr,
  77                      enterTddiv,
  78                      enterTdiv,
  79                      enterThisNextLast,
  80                      enterTimeExpr,
  81                      enterTwelveHourTimeExpr,
  82                      enterTwentyFourHourTimeExpr,
  83                      enterTzExpr,
  84                      enterUnsignedInt,
  85                      enterYear,
  86                      enterYearMonthDayExpr,
  87                      exitAmpm,
  88                      exitBaseAndOffsetDateExpr,
  89                      exitBaseAndOffsetTimeExpr,
  90                      exitBaseDate,
  91                      exitBaseTime,
  92                      exitCountUnitsBeforeAfterTimeExpr,
  93                      exitDateExpr,
  94                      exitDayMonthMaybeYearExpr,
  95                      exitDayName,
  96                      exitDayOfMonth,
  97                      exitDdiv,
  98                      exitDeltaBeforeAfter,
  99                      exitDeltaDateExprRelativeToTodayImplied,
 100                      exitDeltaNextLast,
 101                      exitDeltaPlusMinusExpr,
 102                      exitDeltaPlusMinusTimeExpr,
 103                      exitDeltaRelativeToTodayExpr,
 104                      exitDeltaTimeBeforeAfter,
 105                      exitDeltaTimeFraction,
 106                      exitDeltaTimeUnit,
 107                      exitDeltaUnit,
 108                      exitDtdiv,
 109                      exitFirstLastWeekdayInMonthMaybeYearExpr,
 110                      exitFirstOrLast,
 111                      exitFractionBeforeAfterTimeExpr,
 112                      exitHour,
 113                      exitLtz,
 114                      exitMicros,
 115                      exitMinute,
 116                      exitMonthDayMaybeYearExpr,
 117                      exitMonthExpr,
 118                      exitMonthName
 119                      exitMonthName,
 120                      exitMonthName,
 121                      exitMonthNumber,
 122                      exitMonthNumber,
 123                      exitNFoosFromTodayAgoExpr,
 124                      exitNextLastUnit,
 125                      exitNth,
 126                      exitNthWeekdayInMonthMaybeYearExpr,
 127                      exitNtz,
 128                      exitParse,
 129                      exitSecond,
 130                      exitSingleDateExpr,
 131                      exitSingleTimeExpr,
 132                      exitSpecialDate,
 133                      exitSpecialDateMaybeYearExpr,
 134                      exitSpecialTime,
 135                      exitSpecialTimeExpr,
 136                      exitTddiv,
 137                      exitTdiv,
 138                      exitThisNextLast,
 139                      exitTimeExpr,
 140                      exitTwelveHourTimeExpr,
 141                      exitTwentyFourHourTimeExpr,
 142                      exitTzExpr,
 143                      exitUnsignedInt,
 144                      exitYear,
 145                      exitYearMonthDayExpr,
 146                      main,
 147                      visitErrorNode,
 148                      visitTerminal
 149
 150 pyutils.datetimez.dateparse\_utilsLexer module
 151 ----------------------------------------------
 152
 153 This code is auto-generated by ANTLR from the dateparse\_utils.g4
 154 grammar.
 155
 156 pyutils.datetimez.dateparse\_utilsListener module
 157 -------------------------------------------------
 158
 159 This code is auto-generated by ANTLR from the dateparse\_utils.g4
 160 grammar.
 161
 162 pyutils.datetimez.dateparse\_utilsParser module
 163 -----------------------------------------------
 164
 165 This code is auto-generated by ANTLR from the dateparse\_utils.g4
 166 grammar.
 167
 168 pyutils.datetimez.datetime\_utils module
 169 ----------------------------------------
 170
 171 This is a set of utilities for dealing with Python datetimes and
 172 dates.  It supports operations such as checking timezones,
 173 manipulating timezones, easy formatting, and using offsets with
 174 datetimes.
 175
 176 .. automodule:: pyutils.datetimez.datetime_utils
 177    :members:
 178    :undoc-members:
 179    :show-inheritance:
 180
 181 Module contents
 182 ---------------
 183
 184 This module contains utilities for dealing with Python datetimes.
 185
 186 .. automodule:: pyutils.datetimez
 187    :members:
 188    :undoc-members:
 189    :show-inheritance: