File: datetime.py

package info (click to toggle)
ansible-core 2.19.0~beta6-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 32,628 kB
  • sloc: python: 180,313; cs: 4,929; sh: 4,601; xml: 34; makefile: 21
file content (50 lines) | stat: -rw-r--r-- 1,444 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Copyright (c) 2023 Ansible
# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)

from __future__ import annotations

import datetime as _datetime
import typing as t

from ansible.module_utils.common.warnings import deprecate


_UTC = _datetime.timezone.utc


def _utcfromtimestamp(timestamp: float) -> _datetime.datetime:
    """Construct an aware UTC datetime from a POSIX timestamp."""
    return _datetime.datetime.fromtimestamp(timestamp, _UTC)


def _utcnow() -> _datetime.datetime:
    """Construct an aware UTC datetime from time.time()."""
    return _datetime.datetime.now(_UTC)


_deprecated_shims_map: dict[str, t.Callable[..., object] | _datetime.timezone] = {
    'UTC': _UTC,
    'utcfromtimestamp': _utcfromtimestamp,
    'utcnow': _utcnow,
}

__all__ = tuple(_deprecated_shims_map)


def __getattr__(importable_name: str) -> t.Callable[..., object] | _datetime.timezone:
    """Inject import-time deprecation warnings.

    Specifically, for ``UTC``, ``utcfromtimestamp()`` and ``utcnow()``.
    """
    try:
        importable = _deprecated_shims_map[importable_name]
    except KeyError as key_err:
        raise AttributeError(f"module {__name__!r} has no attribute {key_err}") from None

    deprecate(
        msg=f'The `ansible.module_utils.compat.datetime.{importable_name}` '
        'function is deprecated.',
        version='2.21',
    )

    return importable