Skip to content

Fix docstring for converter functions #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2021
Merged

Fix docstring for converter functions #952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions pymysql/converters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,16 @@ def _convert_second_fraction(s):
def convert_datetime(obj):
"""Returns a DATETIME or TIMESTAMP column value as a datetime object:

>>> datetime_or_None('2007-02-25 23:06:20')
>>> convert_datetime('2007-02-25 23:06:20')
datetime.datetime(2007, 2, 25, 23, 6, 20)
>>> datetime_or_None('2007-02-25T23:06:20')
>>> convert_datetime('2007-02-25T23:06:20')
datetime.datetime(2007, 2, 25, 23, 6, 20)

Illegal values are returned as None:

>>> datetime_or_None('2007-02-31T23:06:20') is None
>>> convert_datetime('2007-02-31T23:06:20') is None
True
>>> datetime_or_None('0000-00-00 00:00:00') is None
>>> convert_datetime('0000-00-00 00:00:00') is None
True

"""
Expand All @@ -189,14 +189,14 @@ def convert_datetime(obj):
def convert_timedelta(obj):
"""Returns a TIME column as a timedelta object:

>>> timedelta_or_None('25:06:17')
>>> convert_timedelta('25:06:17')
datetime.timedelta(1, 3977)
>>> timedelta_or_None('-25:06:17')
>>> convert_timedelta('-25:06:17')
datetime.timedelta(-2, 83177)

Illegal values are returned as None:

>>> timedelta_or_None('random crap') is None
>>> convert_timedelta('random crap') is None
True

Note that MySQL always returns TIME columns as (+|-)HH:MM:SS, but
Expand Down Expand Up @@ -236,14 +236,14 @@ def convert_timedelta(obj):
def convert_time(obj):
"""Returns a TIME column as a time object:

>>> time_or_None('15:06:17')
>>> convert_time('15:06:17')
datetime.time(15, 6, 17)

Illegal values are returned as None:

>>> time_or_None('-25:06:17') is None
>>> convert_time('-25:06:17') is None
True
>>> time_or_None('random crap') is None
>>> convert_time('random crap') is None
True

Note that MySQL always returns TIME columns as (+|-)HH:MM:SS, but
Expand Down Expand Up @@ -279,14 +279,14 @@ def convert_time(obj):
def convert_date(obj):
"""Returns a DATE column as a date object:

>>> date_or_None('2007-02-26')
>>> convert_date('2007-02-26')
datetime.date(2007, 2, 26)

Illegal values are returned as None:

>>> date_or_None('2007-02-31') is None
>>> convert_date('2007-02-31') is None
True
>>> date_or_None('0000-00-00') is None
>>> convert_date('0000-00-00') is None
True

"""
Expand Down