Skip to content
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.

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

Fix strptime in python_script #133159

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Fix strptime in python_script #133159

merged 2 commits into from
Dec 17, 2024

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented Dec 13, 2024

Proposed change

In Python 3.13, datetime.datetime.strptime does a local import of _strptime.
This breaks python_script scripts which call datetime.datetime.strptime because we don't allow imports.

As a workaround, we add an allow-list of safe import, _strptime is currently the only allowed import.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

async def test_import_allow_strptime(
hass: HomeAssistant, caplog: pytest.LogCaptureFixture
) -> None:
"""Test that prohibited augmented assignment operations raise an error."""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stale docstring

async def test_no_other_imports_allowed(
hass: HomeAssistant, caplog: pytest.LogCaptureFixture
) -> None:
"""Test that prohibited augmented assignment operations raise an error."""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stale docstring

@emontnemery
Copy link
Contributor

emontnemery commented Dec 17, 2024

~~ @gjohansson-ST Looking at the linked issue, #132469, it seems this is a workaround for some change in Python 3.13. Can you please elaborate what the change in CPython is, and what the workaround does? ~~

Nevermind, I checked the change myself and updated the PR description

tests/components/python_script/test_init.py Outdated Show resolved Hide resolved
tests/components/python_script/test_init.py Outdated Show resolved Hide resolved
homeassistant/components/python_script/__init__.py Outdated Show resolved Hide resolved
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @gjohansson-ST 👍

../Frenck

@frenck frenck merged commit 6376142 into dev Dec 17, 2024
34 checks passed
@frenck frenck deleted the gj-20241213-01 branch December 17, 2024 11:41
frenck pushed a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Erik Montnemery <erik@montnemery.com>
@frenck frenck mentioned this pull request Dec 17, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python Scripts : strptime no longer works
3 participants