docs/pyutils.datetimez.rst

   1 pyutils.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    :show-inheritance:
  34
  35 pyutils.datetimez.dateparse\_utilsLexer module
  36 ----------------------------------------------
  37
  38 This code is auto-generated by ANTLR from the dateparse\_utils.g4
  39 grammar.
  40
  41 .. automodule:: pyutils.datetimez.dateparse_utilsLexer
  42    :members:
  43    :undoc-members:
  44    :show-inheritance:
  45
  46 pyutils.datetimez.dateparse\_utilsListener module
  47 -------------------------------------------------
  48
  49 This code is auto-generated by ANTLR from the dateparse\_utils.g4
  50 grammar.
  51
  52 .. automodule:: pyutils.datetimez.dateparse_utilsListener
  53    :members:
  54    :undoc-members:
  55    :show-inheritance:
  56
  57 pyutils.datetimez.dateparse\_utilsParser module
  58 -----------------------------------------------
  59
  60 This code is auto-generated by ANTLR from the dateparse\_utils.g4
  61 grammar.
  62
  63 .. automodule:: pyutils.datetimez.dateparse_utilsParser
  64    :members:
  65    :undoc-members:
  66    :show-inheritance:
  67
  68 pyutils.datetimez.datetime\_utils module
  69 ----------------------------------------
  70
  71 This is a set of utilities for dealing with Python datetimes and
  72 dates.  It supports operations such as checking timezones,
  73 manipulating timezones, easy formatting, and using offsets with
  74 datetimes.
  75
  76 .. automodule:: pyutils.datetimez.datetime_utils
  77    :members:
  78    :undoc-members:
  79    :show-inheritance:
  80
  81 Module contents
  82 ---------------
  83
  84 This module contains utilities for dealing with Python datetimes.
  85
  86 .. automodule:: pyutils.datetimez
  87    :members:
  88    :undoc-members:
  89    :show-inheritance: