Fix internal usage of deprecated APIs triggering user warnings by Littie28 · Pull Request #354 · lmfit/uncertainties

Littie28 · 2026-01-22T12:25:04Z

Added _derivatives and _error_components for internal use. Public APIs retain deprecation warnings as intended.

Fixes #352

Closes DEPR: self-triggered deprecation warnings in 3.2.4 #352
Executed pre-commit run --all-files with no errors
The change is fully covered by automated unit tests
Documented in docs/ as appropriate
Added an entry to the CHANGES file

Added _derivatives and _error_components for internal use. Public APIs retain deprecation warnings as intended. Fixes lmfit#352

jagerber48

@Littie28 thank you very much for this contribution!

Please make sure you've changed all internal usages of .derivatives and .error_components() to use the private versions. Our CI won't catch cases that you've missed under it's normal configuration at the moment.

jagerber48 · 2026-01-22T13:31:58Z

+    @property
+    def derivatives(self):
+        """
+        Public wrapper for _derivatives.


Please keep the historic docstring on the public, not private derivatives property.

Moved historic docstring to public api.

jagerber48 · 2026-01-22T13:32:28Z

-        This method assumes that the derivatives contained in the
-        object take scalar values (and are not a tuple, like what
-        math.frexp() returns, for instance).
+        Publich wrapper of _error_compents with FutureWarning.


Please keep the historic docstring on the public, not private, error_components() method.

Moved historic docstring to public api.

Littie28 · 2026-01-22T14:40:48Z

I searched through the codebase for usages of .derivatives and .error_components(). They currently appear only in comments and tests. Should the test suite use the private versions (no FutureWarning) or the public API (with FutureWarning)?

jagerber48 · 2026-01-22T14:44:44Z

I searched through the codebase for usages of .derivatives and .error_components(). They currently appear only in comments and tests. Should the test suite use the private versions (no FutureWarning) or the public API (with FutureWarning)?

Thanks for that! Let’s use the private versions in the tests. I want to change tests to error on warnings but I don’t want error_components usage to cause tests to fail. In the future I’m interested to move away from derivatives and error components in tests. This will be a reminder for that.

jagerber48 · 2026-01-22T15:12:00Z

 from __future__ import division  # Many analytical derivatives depend on this

-from builtins import str, zip, range, object
+import collections


Please don't reorganize imports. You might have some local automation that is doing that but we don't want these kinds of changes to pollute this PR. I don't disagree with doing this sort of thing, but this PR is not the place.

All formatting changes are removed

jagerber48 · 2026-01-22T15:14:23Z

+    @property
+    def _derivatives(self):
+        """
+        Private wrapper for _derivatives without raising a FutureWarning.


""" Private version of `derivatives` for internal use. """

The FutureWarning thing is kind of a temporary fleeting issue. Not worth citing in the docstring. Sorry for being picky about wording.

Updated docstrings

jagerber48 · 2026-01-22T15:14:42Z

+
+    def _error_components(self):
+        """
+        Private wrapper for _error_compents without FutureWarning.


""" Private version of `error_components` for internal use. """

The FutureWarning thing is kind of a temporary fleeting issue. Not worth citing in the docstring. Sorry for being picky about wording.

Updated docstrings

jagerber48 · 2026-01-22T15:15:13Z

            return (value - self._nominal_value) / self.std_dev
        except ZeroDivisionError:
-            raise ValueError("The standard deviation is zero:" " undefined result")
+            raise ValueError("The standard deviation is zero: undefined result")


Again, this change is ok but this is not the right place to address it. It pollutes the PR.

All formatting changes are removed

- updated changelog according to feedback - moved historic docstring to public version of derivatives and error_components

- changed all `derivatives` and `error_components` references to private versions `_derivatives` and `_error_components` - reduces warnings raised during test execution from 809 to 352

Littie28 · 2026-01-22T15:47:44Z

Rebasing to remove the style/formatting changes.

- updated docstrings according to PR discussion

jagerber48 · 2026-01-23T02:12:21Z

Stepping away from uncertainties for a few days. I think it is likely this PR will still be merged into master as the start of the 3.2.5 release which will re-release everything that was in 3.2.4 but resolve the "internal calls to error_components() or derivatives spamming the users with warnings.

Littie28 · 2026-01-23T08:04:35Z

Thanks for the guidance throughout! No rush at all. I'll keep an eye on the PR and address any feedback when you're back. Enjoy the break!

Fix internal usage of deprecated APIs triggering user warnings

e8fc609

Added _derivatives and _error_components for internal use. Public APIs retain deprecation warnings as intended. Fixes lmfit#352

jagerber48 mentioned this pull request Jan 22, 2026

DEPR: self-triggered deprecation warnings in 3.2.4 #352

Open

jagerber48 reviewed Jan 22, 2026

View reviewed changes

Littie28 added 2 commits January 22, 2026 16:42

Addresses feedback

bc6f53a

- updated changelog according to feedback - moved historic docstring to public version of derivatives and error_components

Use private API for test suite

ca8bf35

- changed all `derivatives` and `error_components` references to private versions `_derivatives` and `_error_components` - reduces warnings raised during test execution from 809 to 352

jagerber48 mentioned this pull request Jan 22, 2026

3.2.5a #353

Closed

5 tasks

Littie28 force-pushed the fix-issue-352 branch from f7bdd8a to ca8bf35 Compare January 22, 2026 15:48

Addresses feedback on docstrings

5cfb2cb

- updated docstrings according to PR discussion

Uh oh!

Uh oh!

Conversation

Littie28 commented Jan 22, 2026

Uh oh!

jagerber48 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Littie28 commented Jan 22, 2026

Uh oh!

jagerber48 commented Jan 22, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Littie28 commented Jan 22, 2026

Uh oh!

jagerber48 commented Jan 23, 2026

Uh oh!

Littie28 commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jagerber48 left a comment •

edited

Loading