collective / icalendar / 33754050143

98%

push

github

Deprecate single_string_parameter as private function for icalendar 8 (#1750)

* Deprecate single_string_parameter as private function for icalendar 8

Author: Morningstar202604 <morningstar202604@users.noreply.github.com>
Date: 2026-09-02 18:45:16

Rename single_string_parameter to _single_string_parameter and add
deprecation wrapper for backwards compatibility.

The function was never part of the public API (not listed in __all__)
and is only used internally as a decorator for Parameters.value and
Parameters.tzid properties.

Changes:
- Renamed single_string_parameter to _single_string_parameter
- Added deprecated wrapper single_string_parameter that issues
  DeprecationWarning when used
- Updated internal usages to use the new private name
- Added changelog entry in news/1011.removal.1

AI disclosure: I used AI (Claude) to assist me with this change.
The AI helped with code analysis, implementation, and testing.

* Future proof news fragment for #1011

Updated the changelog entry to be more specific about the deprecation
and provide clearer guidance for users.

* Use deprecate_for_version_8 for single_string_parameter and future proof news

Per review:
- parser/parameter.py: replace the hand-written DeprecationWarning wrapper
  with the shared icalendar.compatibility.deprecate_for_version_8 utility,
  so all version-8 deprecations use one searchable mechanism
  (parser/string.py already does this). The warning message is unchanged.
- news/1011.removal.1: use the reviewed wording that stays valid after the
  icalendar 8 release.

AI: GLM (via ZCode coding agent) applied both review items and verified
the deprecation warning locally; the author reviewed the change.

---------

Co-authored-by: Morningstar202604 <320475654+Morningstar202604@users.noreply.github.com>

1671 of 1810 branches covered (92.32%)

Branch coverage included in aggregate %.

5 of 5 new or added lines in 1 file covered. (100.0%)

14697 of 14967 relevant lines covered (98.2%)

5.89 hits per line