Skip to content

Commit 06cf170

Browse files
committed
[EN-1570] handle_datetime docstrings added
1 parent 37ff1cc commit 06cf170

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

dxfeed/wrappers/class_utils.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,23 @@ def to_iterable(value: Union[str, Iterable[str]]) -> Iterable[str]:
2626

2727

2828
def handle_datetime(date_time: Union[str, datetime], fmt: str = '%Y-%m-%d %H:%M:%S.%f', exact_format: bool = True):
29+
"""
30+
Function to convert string of date and time to datetime object.
31+
32+
Parameters
33+
----------
34+
date_time: str, datetime.datetime
35+
Datetime to convert
36+
fmt: str
37+
Format of expected datetime
38+
exact_format: bool
39+
If False no warning will be thrown in case of incomplete date_time parameter. Default - True
40+
41+
Returns
42+
-------
43+
date_time: datetime.datetime
44+
date_time argument converted to datetime.datetime object.
45+
"""
2946
if isinstance(date_time, str):
3047
try:
3148
date_time = datetime.strptime(date_time, fmt)

0 commit comments

Comments
 (0)