Date parsing library designed to parse dates from HTML pages
'1 min ago'
, '2 weeks ago'
, '3 months, 1 week and 1 day ago'
, 'in 2 days'
, 'tomorrow'
.'August 14, 2015 EST'
, 'July 4, 2013 PST'
, '21 July 2013 10:15 pm +0500'
.Supported Calendars
_.The most straightforward way is to use the dateparser.parse <#dateparser.parse>
_ function,
that wraps around most of the functionality in the module.
:noindex:
>>> import dateparser
>>> dateparser.parse('12/12/12')
datetime.datetime(2012, 12, 12, 0, 0)
>>> dateparser.parse('Fri, 12 Dec 2014 10:55:50')
datetime.datetime(2014, 12, 12, 10, 55, 50)
>>> dateparser.parse('Martes 21 de Octubre de 2014') # Spanish (Tuesday 21 October 2014)
datetime.datetime(2014, 10, 21, 0, 0)
>>> dateparser.parse('Le 11 Décembre 2014 à 09:00') # French (11 December 2014 at 09:00)
datetime.datetime(2014, 12, 11, 9, 0)
>>> dateparser.parse('13 января 2015 г. в 13:34') # Russian (13 January 2015 at 13:34)
datetime.datetime(2015, 1, 13, 13, 34)
>>> dateparser.parse('1 เดือนตุลาคม 2005, 1:00 AM') # Thai (1 October 2005, 1:00 AM)
datetime.datetime(2005, 10, 1, 1, 0)
This will try to parse a date from the given string, attempting to detect the language each time.
You can specify the language(s), if known, using languages
argument. In this case, given languages are used and language detection is skipped:
>>> dateparser.parse('2015, Ago 15, 1:08 pm', languages=['pt', 'es'])
datetime.datetime(2015, 8, 15, 13, 8)
If you know the possible formats of the dates, you can
use the date_formats
argument:
>>> dateparser.parse('22 Décembre 2010', date_formats=['%d %B %Y'])
datetime.datetime(2010, 12, 22, 0, 0)
>>> parse('1 hour ago')
datetime.datetime(2015, 5, 31, 23, 0)
>>> parse('Il ya 2 heures') # French (2 hours ago)
datetime.datetime(2015, 5, 31, 22, 0)
>>> parse('1 anno 2 mesi') # Italian (1 year 2 months)
datetime.datetime(2014, 4, 1, 0, 0)
>>> parse('yaklaşık 23 saat önce') # Turkish (23 hours ago)
datetime.datetime(2015, 5, 31, 1, 0)
>>> parse('Hace una semana') # Spanish (a week ago)
datetime.datetime(2015, 5, 25, 0, 0)
>>> parse('2小时前') # Chinese (2 hours ago)
datetime.datetime(2015, 5, 31, 22, 0)
.. note:: Testing above code might return different values for you depending on your environment's current date and time.
.. note:: For Finnish
language, please specify settings={'SKIP_TOKENS': []}
to correctly parse relative dates.
parsing ambiguous date
parse('02-03-2016') # assumes english language, uses MDY date order datetime.datetime(2016, 2, 3, 0, 0) parse('le 02-03-2016') # detects french, uses DMY date order datetime.datetime(2016, 3, 2, 0, 0)
.. note:: Ordering is not locale based, that's why do not expect DMY
order for UK/Australia English. You can specify date order in that case as follows using settings
:
>>> parse('18-12-15 06:00', settings={'DATE_ORDER': 'DMY'})
datetime.datetime(2015, 12, 18, 6, 0)
For more on date order, please look at settings
.
By default, dateparser
returns tzaware datetime
if timezone is present in date string. Otherwise, it returns a naive datetime
object.
>>> parse('January 12, 2012 10:00 PM EST')
datetime.datetime(2012, 1, 12, 22, 0, tzinfo=<StaticTzInfo 'EST'>)
>>> parse('January 12, 2012 10:00 PM -0500')
datetime.datetime(2012, 1, 12, 22, 0, tzinfo=<StaticTzInfo 'UTC\-05:00'>)
>>> parse('2 hours ago EST')
datetime.datetime(2017, 3, 10, 15, 55, 39, 579667, tzinfo=<StaticTzInfo 'EST'>)
>>> parse('2 hours ago -0500')
datetime.datetime(2017, 3, 10, 15, 59, 30, 193431, tzinfo=<StaticTzInfo 'UTC\-05:00'>)
If date has no timezone name/abbreviation or offset, you can specify it using TIMEZONE
setting.
>>> parse('January 12, 2012 10:00 PM', settings={'TIMEZONE': 'US/Eastern'})
datetime.datetime(2012, 1, 12, 22, 0)
>>> parse('January 12, 2012 10:00 PM', settings={'TIMEZONE': '+0500'})
datetime.datetime(2012, 1, 12, 22, 0)
TIMEZONE
option may not be useful alone as it only attaches given timezone to
resultant datetime
object. But can be useful in cases where you want conversions from and to different
timezones or when simply want a tzaware date with given timezone info attached.
>>> parse('January 12, 2012 10:00 PM', settings={'TIMEZONE': 'US/Eastern', 'RETURN_AS_TIMEZONE_AWARE': True})
datetime.datetime(2012, 1, 12, 22, 0, tzinfo=<DstTzInfo 'US/Eastern' EST-1 day, 19:00:00 STD>)
>>> parse('10:00 am', settings={'TIMEZONE': 'EST', 'TO_TIMEZONE': 'EDT'})
datetime.datetime(2016, 9, 25, 11, 0)
Some more use cases for conversion of timezones.
>>> parse('10:00 am EST', settings={'TO_TIMEZONE': 'EDT'}) # date string has timezone info
datetime.datetime(2017, 3, 12, 11, 0, tzinfo=<StaticTzInfo 'EDT'>)
>>> parse('now EST', settings={'TO_TIMEZONE': 'UTC'}) # relative dates
datetime.datetime(2017, 3, 10, 23, 24, 47, 371823, tzinfo=<StaticTzInfo 'UTC'>)
In case, no timezone is present in date string or defined in settings
. You can still
return tzaware datetime
. It is especially useful in case of relative dates when uncertain
what timezone is relative base.
>>> parse('2 minutes ago', settings={'RETURN_AS_TIMEZONE_AWARE': True})
datetime.datetime(2017, 3, 11, 4, 25, 24, 152670, tzinfo=<DstTzInfo 'Asia/Karachi' PKT+5:00:00 STD>)
In case, you want to compute relative dates in UTC instead of default system's local timezone, you can use TIMEZONE
setting.
>>> parse('4 minutes ago', settings={'TIMEZONE': 'UTC'})
datetime.datetime(2017, 3, 10, 23, 27, 59, 647248, tzinfo=<StaticTzInfo 'UTC'>)
.. note:: In case, when timezone is present both in string and also specified using settings
, string is parsed into tzaware representation and then converted to timezone specified in settings
.
parse('10:40 pm PKT', settings={'TIMEZONE': 'UTC'}) datetime.datetime(2017, 3, 12, 17, 40, tzinfo=<StaticTzInfo 'UTC'>)
parse('20 mins ago EST', settings={'TIMEZONE': 'UTC'}) datetime.datetime(2017, 3, 12, 21, 16, 0, 885091, tzinfo=<StaticTzInfo 'UTC'>)
For more on timezones, please look at settings
.
>>> from dateparser import parse
>>> parse('December 2015') # default behavior
datetime.datetime(2015, 12, 16, 0, 0)
>>> parse('December 2015', settings={'PREFER_DAY_OF_MONTH': 'last'})
datetime.datetime(2015, 12, 31, 0, 0)
>>> parse('December 2015', settings={'PREFER_DAY_OF_MONTH': 'first'})
datetime.datetime(2015, 12, 1, 0, 0)
>>> parse('March')
datetime.datetime(2015, 3, 16, 0, 0)
>>> parse('March', settings={'PREFER_DATES_FROM': 'future'})
datetime.datetime(2016, 3, 16, 0, 0)
>>> # parsing with preference set for 'past'
>>> parse('August', settings={'PREFER_DATES_FROM': 'past'})
datetime.datetime(2015, 8, 15, 0, 0)
>>> import dateparser
>>> dateparser.parse("2015") # default behavior
datetime.datetime(2015, 3, 27, 0, 0)
>>> dateparser.parse("2015", settings={"PREFER_MONTH_OF_YEAR": "last"})
datetime.datetime(2015, 12, 27, 0, 0)
>>> dateparser.parse("2015", settings={"PREFER_MONTH_OF_YEAR": "first"})
datetime.datetime(2015, 1, 27, 0, 0)
>>> dateparser.parse("2015", settings={"PREFER_MONTH_OF_YEAR": "current"})
datetime.datetime(2015, 3, 27, 0, 0)
You can also ignore parsing incomplete dates altogether by setting STRICT_PARSING
flag as follows:
>>> parse('December 2015', settings={'STRICT_PARSING': True})
None
For more on handling incomplete dates, please look at settings
.
.. warning:: Support for searching dates is really limited and needs a lot of improvement, we look forward to community's contribution to get better on that part. See "contributing
".
You can extract dates from longer strings of text. They are returned as list of tuples with text chunk containing the date and parsed datetime object.
:noindex:
If you need more control over what is being parser check the settings
section as well as the using-datedataparser
section.
dateparser
relies on following libraries in some ways:
relativedelta
for its freshness parser... _dateutil: https://pypi.python.org/pypi/python-dateutil .. _convertdate: https://pypi.python.org/pypi/convertdate .. _hijri-converter: https://pypi.python.org/pypi/hijri-converter .. _tzlocal: https://pypi.python.org/pypi/tzlocal .. _ruamel.yaml: https://pypi.python.org/pypi/ruamel.yaml
You can check the supported locales by visiting the "supported-locales
" section.
Apart from the Georgian calendar, dateparser
supports the Persian Jalali calendar
and the Hijri/Islami calendar
To be able to use them you need to install the calendar
extra by typing:
pip install dateparser[calendars]
Example using the Persian Jalali calendar
. For more information, refer to Persian Jalali Calendar <https://en.wikipedia.org/wiki/Iranian_calendars#Zoroastrian_calendar>
_.
from dateparser.calendars.jalali import JalaliCalendar JalaliCalendar('جمعه سی ام اسفند ۱۳۸۷').get_date() DateData(date_obj=datetime.datetime(2009, 3, 20, 0, 0), period='day', locale=None)
Example using the Hijri/Islamic Calendar
. For more information, refer to Hijri Calendar <https://en.wikipedia.org/wiki/Islamic_calendar>
_.
from dateparser.calendars.hijri import HijriCalendar HijriCalendar('17-01-1437 هـ 08:30 مساءً').get_date() DateData(date_obj=datetime.datetime(2015, 10, 30, 20, 30), period='day', locale=None)
.. note:: HijriCalendar
only works with Python ≥ 3.6.
.. :changelog:
New features:
PREFER_MONTH_OF_YEAR
setting (#1146)Fixes:
Cleanups and internal improvements:
datetime.utcnow
, deprecated on Python 3.12 (#1179)Improvements:
Improvements:
Improvements:
Improvements:
Cleanups:
Improvements:
New features:
Improvements:
Cleanups:
Improvements:
Improvements:
New features:
langdetect
, fastText
, or a
custom implementation (see #932)Improvements:
search_dates
(see #953)RETURN_TIME_AS_PERIOD
for timestamp times (see #922)QA:
Breaking changes:
DateDataParser.get_date_data()
returns a DateData
object instead of a dict
(see #778).settings
are not silenced and raise SettingValidationError
(see #797)dateparser.parse()
is deterministic and doesn't try previous locales. Also, DateDataParser.get_date_data()
doesn't try the previous locales by default (see #781)'base-formats'
parser (see #721)'no-spaces-time'
parser from the 'absolute-time'
parser and make it an optional parser (see #786)numeral_translation_data
(see #782)SKIP_TOKENS_PARSER
and FUZZY
settings (see #728, #794)date_formats
(see #726)ExactLanguageSearch
class has been moved to the private scope and some internal methods have changed (see #778)dateparser.utils
: normalize_unicode()
doesn't accept bytes
as input and convert_to_unicode
has been deprecated (see #749)New features:
Improvements:
PREFER_DATES_FROM
is set (see #738)STRICT_PARSING
setting in no-spaces-time
parser (see #715)RETURN_AS_TIME_PERIOD
setting for relative-time
parser (see #807)Improvements:
scripts
to dateparser_scripts
to avoid name collisions with modules from other packages or projects (see #707)New features:
REQUIRE_PARTS
setting (see #703)Improvements:
yaml
and json
files content (see #663 and #692)OverflowError
errors and explicitly avoid to raise ValueError
when parsing relative dates (see #686)DATE_ORDER
(see #628)'future'
in PREFER_DATES_FROM
(see #629)New features:
PARSERS
setting (see #603)Improvements:
PREFER_DATES_FROM
in relative/freshness parser (see #414)PREFER_DAY_OF_MONTH
in base-formats parser (see #611)Features:
time
to valid periodssearch_dates()
Improvements:
Features/news:
search_dates()
Improvements:
DateTime
objects with timezonesZeroDivisionError
exceptionsFeatures added during Google Summer of Code 2017:
New features:
Improvements:
Planned for next release:
New features:
Improvements:
Packaging:
New features:
Improvements:
New features:
DateDataParser
now also returns detected language in the result dictionary.TIMEZONE
, TO_TIMEZONE
settings.STRICT_PARSING
to ignore incomplete dates.Improvements:
New features:
settings
.RELATIVE_BASE
settings to set date context to any datetime in past or future.dateutil.parser.parse
with dateparser's own parser.Improvements:
ruamel.yaml
which also fixed the issues with installation on windows using python35.date_formats
handling.New features:
Improvements:
Improvements:
New features:
Improvements:
RETURN_AS_TIMEZONE_AWARE
setting to return tz aware date object.New features:
Improvements:
datetime.now
in FreshnessDateDataParser
.New features:
Improvements:
New features:
Improvements:
languages.yaml
data cleaned up to make it human-readable.parse
functiondateutil.parserinfo
was used for language definitions.pytz
timezones.