Skip to content

operations

datetime_as_dt(ts=None, format=TIME_FMT_24H)

Convert a datetime string to a datetime.datetime object.

Parameters:

Name Type Description Default
ts str

A datetime str to convert to a Python datetime.datetime object

 None
format str

The str time string format to use

 TIME_FMT_24H

Returns

(str): A formatted `datetime.datetime` object
Source code in src/red_utils/std/time_utils/operations.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def datetime_as_dt(ts: str = None, format: str = TIME_FMT_24H) -> dt:
    """Convert a datetime string to a `datetime.datetime` object.

    Params:
        ts (str): A datetime str to convert to a Python `datetime.datetime` object
        format (str): The `str` time string format to use

    Returns
    -------
        (str): A formatted `datetime.datetime` object

    """
    _ts: dt = dt.strptime(ts, format)

    return _ts

datetime_as_str(ts=None, format=TIME_FMT_24H)

Convert a datetime.datetime object to a string.

Parameters:

Name Type Description Default
ts datetime

A Python datetime.datetime object to convert to a str

 None
format str

The str time string format to use

 TIME_FMT_24H

Returns

(str): A formatted `datetime.datetime` `str`
Source code in src/red_utils/std/time_utils/operations.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def datetime_as_str(ts: dt = None, format: str = TIME_FMT_24H) -> str:
    """Convert a `datetime.datetime` object to a string.

    Params:
        ts (datetime.datetime): A Python `datetime.datetime` object to convert to a `str`
        format (str): The `str` time string format to use

    Returns
    -------
        (str): A formatted `datetime.datetime` `str`

    """
    _ts: str = ts.strftime(format=format)

    return _ts

get_ts(as_str=False, format=TIME_FMT_24H)

Get a timestamp object.

Parameters:

Name Type Description Default
as_str bool

If True, converts datetime to a str

 False
format str

The str time string format to use

 TIME_FMT_24H

Returns

(datetime.datetime): a Python `datetime.datetime` object.
(str): If `as_str` is `True`, converts datetime to a string & returns.
Source code in src/red_utils/std/time_utils/operations.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_ts(as_str: bool = False, format: str = TIME_FMT_24H) -> Union[dt, str]:
    """Get a timestamp object.

    Params:
        as_str (bool): If `True`, converts `datetime` to a `str`
        format (str): The `str` time string format to use

    Returns
    -------
        (datetime.datetime): a Python `datetime.datetime` object.
        (str): If `as_str` is `True`, converts datetime to a string & returns.

    """
    now: dt = dt.now()

    if as_str:
        now: str = datetime_as_str(ts=now, format=format)

    return now