"""
config for datetime formatting
"""

from __future__ import annotations

from pandas._config import config as cf

pc_date_dayfirst_doc = """
: boolean
    When True, parses ambiguous dates with the day first, eg 20/01/2005.
    This affects parsing only, not how dates are displayed, and applies to
    the Period constructor and partial-string indexing on a DatetimeIndex.
    Timestamp, to_datetime and read_csv take their own dayfirst keyword and
    are unaffected.
"""

pc_date_yearfirst_doc = """
: boolean
    When True, parses ambiguous dates with the year first, eg 2005/01/20.
    This affects parsing only, not how dates are displayed, and applies to
    the Period constructor and partial-string indexing on a DatetimeIndex.
    Timestamp, to_datetime and read_csv take their own yearfirst keyword and
    are unaffected.
"""

with cf.config_prefix("display"):
    # Needed upstream of `_libs` because these are used in tslibs.parsing
    cf.register_option(
        "date_dayfirst", False, pc_date_dayfirst_doc, validator=cf.is_bool
    )
    cf.register_option(
        "date_yearfirst", False, pc_date_yearfirst_doc, validator=cf.is_bool
    )