X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.datetimez.rst;h=302efedd8d20b2df7f8ec5ce0045cd29abfc6e8e;hb=993b0992473c12294ed659e52b532e1c8cf9cd1e;hp=fe7cdd18dd6944ec4b3faca97a38ebc2a7f3234e;hpb=b38920f24d1ac948958480c540bc4b8436186765;p=pyutils.git diff --git a/docs/pyutils.datetimez.rst b/docs/pyutils.datetimez.rst index fe7cdd1..302efed 100644 --- a/docs/pyutils.datetimez.rst +++ b/docs/pyutils.datetimez.rst @@ -1,14 +1,14 @@ -yutils.datetimez package +pyutils.datetimez package ========================= +This subpackage contains code for parsing and manipulating dates, times and datetimes. + Submodules ---------- pyutils.datetimez.constants module ---------------------------------- -A set of date and time related constants. - .. automodule:: pyutils.datetimez.constants :members: :undoc-members: @@ -17,20 +17,16 @@ A set of date and time related constants. pyutils.datetimez.dateparse\_utils module ----------------------------------------- -The dateparse\_utils.DateParser class uses an English language grammar -(see dateparse\_utils.g4) to parse free form English text into a Python -datetime. It can handle somewhat complex constructs such as: "20 days -from next Wed at 3pm", "last Christmas", and "The 2nd Sunday in May, -2022". See the dateparse_utils_test.py for more examples. - -This code is used by other code in the pyutils library; for example, -when using argparse_utils.py to pass an argument of type datetime it -allows the user to use free form english expressions. - .. automodule:: pyutils.datetimez.dateparse_utils :members: :undoc-members: - :exclude-members: enterAmpm, + :exclude-members: PARSE_TYPE_BASE_AND_OFFSET_EXPR, + PARSE_TYPE_BASE_AND_OFFSET_TIME_EXPR, + PARSE_TYPE_SINGLE_DATE_EXPR, + PARSE_TYPE_SINGLE_TIME_EXPR, + RaisingErrorListener, + debug_parse, + enterAmpm, enterBaseAndOffsetDateExpr, enterBaseAndOffsetTimeExpr, enterBaseDate, @@ -147,32 +143,9 @@ allows the user to use free form english expressions. visitErrorNode, visitTerminal -pyutils.datetimez.dateparse\_utilsLexer module ----------------------------------------------- - -This code is auto-generated by ANTLR from the dateparse\_utils.g4 -grammar. - -pyutils.datetimez.dateparse\_utilsListener module -------------------------------------------------- - -This code is auto-generated by ANTLR from the dateparse\_utils.g4 -grammar. - -pyutils.datetimez.dateparse\_utilsParser module ------------------------------------------------ - -This code is auto-generated by ANTLR from the dateparse\_utils.g4 -grammar. - pyutils.datetimez.datetime\_utils module ---------------------------------------- -This is a set of utilities for dealing with Python datetimes and -dates. It supports operations such as checking timezones, -manipulating timezones, easy formatting, and using offsets with -datetimes. - .. automodule:: pyutils.datetimez.datetime_utils :members: :undoc-members: @@ -181,8 +154,6 @@ datetimes. Module contents --------------- -This module contains utilities for dealing with Python datetimes. - .. automodule:: pyutils.datetimez :members: :undoc-members: