Remove Python 2 datetime compat fallbacks

[webknjaz]

SUMMARY

$sbj.

ISSUE TYPE

• Maintenance Pull Request

ADDITIONAL INFORMATION

N/A

[webknjaz]

The test ansible-test sanity --test no-get-exception [explain] failed with 1 error:

lib/ansible/module_utils/compat/datetime.py:31:10: do not use `get_exception`

@mattclay apparently that no-get-exception test matches get_exception() within docstrings. Is it supposed to do that?

[webknjaz]

So the CI failure is

01:24 _____________________ test_deprecate_without_list[stdin0] ______________________
01:24 [gw0] linux -- Python 3.12.0 /usr/bin/python3.12
01:24 
01:24 am = <ansible.module_utils.basic.AnsibleModule object at 0x7fca11c53530>
01:24 capfd = <_pytest.capture.CaptureFixture object at 0x7fca11c2dfd0>
01:24 
01:24     @pytest.mark.parametrize('stdin', [{}], indirect=['stdin'])
01:24     def test_deprecate_without_list(am, capfd):
01:24         with pytest.raises(SystemExit):
01:24             am.exit_json(deprecations='Simple deprecation warning')
01:24     
01:24         out, err = capfd.readouterr()
01:24         output = json.loads(out)
01:24 E         
01:24 E         ...Full output truncated (21 lines hidden), use '-vv' to show
01:24 
01:24 test/units/module_utils/basic/test_deprecate_warn.py:67: AssertionError

Which is weird because I cannon reproduce it locally with --docker.

[webknjaz]

Aha.. So while :; do if ! bin/ansible-test units --docker --python 3.12 -vvvvvv --debug -- test/units/module_utils/basic/test_deprecate_warn.py; then break; fi; done doesn't reproduce the problem, but running much more tests does, like this:

$ while :; do if ! bin/ansible-test units --docker --python 3.12 -vvvvvv --debug -- test/units/module_utils/; then break; fi; done

[webknjaz]

Reduced the repro to

$ while :; do if ! bin/ansible-test units --docker --python 3.12 -vvvvvv --debug -- test/units/module_utils/basic/test_deprecate_warn.py test/units/module_utils/compat/test_datetime.py; then break; fi; done

[webknjaz]

Apparently, test/units/module_utils/compat/test_datetime.py imports the deprecated objects from the compat module, accessing them at import time, which triggers deprecation warnings that leak into stdout later on.

[webknjaz]

@mattclay should we only deprecate the UTC object in this module?

[mattclay]

It's too early to deprecate this, since collections may need it for compatibility across multiple non-EOL versions of ansible-core. Instead of deprecating it, add a deprecated comment (detected by pylint) so we can defer deprecation until 2.16 (the first version with this module_util) is the oldest non-EOL version.

[webknjaz]

@mattclay so I wasn't sure about deprecating since most of these aren't exact implementations of what's in stdlib.

[webknjaz]

Thanks for the hint to check other modules. Recording the findings for history:

$ rg compat\\.datetime
lib/ansible/modules/wait_for.py
241:from ansible.module_utils.compat.datetime import utcnow

lib/ansible/modules/uri.py
446:from ansible.module_utils.compat.datetime import utcnow, utcfromtimestamp

lib/ansible/modules/get_url.py
379:from ansible.module_utils.compat.datetime import utcnow, utcfromtimestamp

lib/ansible/module_utils/compat/datetime.py
49:        msg=f'The `ansible.module_utils.compat.datetime.{importable_name}` '

[webknjaz]

@mattclay I think I tracked down everything.

addressed

[mattclay]

Include a changelog fragment for the deprecation.

change note added