Add updatePristineValues arg to Parameter.setDefault by outofculture · Pull Request #2853 · pyqtgraph/pyqtgraph

outofculture · 2023-10-20T21:47:49Z

When a Parameter has its default changed, the value could change to match unless it has previously been modified by the user. The updatePristineValues argument will turn this behavior on, currently defaulting to False.

This also adds the valueModifiedSinceResetToDefault method, a necessary part of the implementation, but also a nice feature for possible application logic.
This also adds the hasValue method, to be better able to distinguish when a Parameter has an explicit value set.
This starts the deprecation countdown on being able to call without error value() and defaultValue() while they're respectively null.
This completes the deprecation of being able to use 'values' to specify the limits of a ListParameter.
This fixes a bug in PenParameter where the Qt setter methods were not being accessed properly.
This changes the behavior of the reset-to-default gui button: it will now be enabled if the parameter is in a dirty state relative to the default, not just an equal value comparison.
Various small cleanups and improvements of related code are included in this.

Other Tasks

Bump Dependency Versions

Files that need updates

Confirm the following files have been either updated or there has been a determination that no update is needed.

Pre-Release Checklist

Pre Release Checklist

Update version info in __init__.py
Update CHANGELOG primarily using contents from automated changelog generation in GitHub release page
Have git tag in the format of pyqtgraph-

Post-Release Checklist

Steps To Complete

Append .dev0 to __version__ in __init__.py
Announce on mail list
Announce on Twitter

…as been chaged

…havior

tests/parametertree/test_Parameter.py

-import pyqtgraph as pg
 import pytest

+import pyqtgraph as pg


pyqtgraph/parametertree/Parameter.py

- extensive testing - raise appropriate ValueErrors when a parameter lacks a value or default - small cleanups around area of work

tests/parametertree/test_Parameter.py

+    # with pytest.raises(ValueError):
+    #     p.value()
+    # with pytest.raises(ValueError):
+    #     p.defaultValue()
+    # with pytest.raises(ValueError):
+    #     p.setToDefault()


…value changes

pyqtgraph/parametertree/parameterTypes/basetypes.py

-        Parameter.__init__(self, *args, **kargs)
+    @property
+    def itemClass(self):
+        from .bool import BoolParameterItem


pyqtgraph/parametertree/parameterTypes/basetypes.py

+    @property
+    def itemClass(self):
+        from .bool import BoolParameterItem
+        from .numeric import NumericParameterItem


pyqtgraph/parametertree/parameterTypes/basetypes.py

+    def itemClass(self):
+        from .bool import BoolParameterItem
+        from .numeric import NumericParameterItem
+        from .str import StrParameterItem


tests/parametertree/test_Parameter.py

+    # with pytest.raises(ValueError):
+    #     p.setToDefault()


pyqtgraph/parametertree/Parameter.py

j9ac9k · 2024-02-14T11:46:18Z

@ntjess want to look over this one? 😅

pyqtgraph/parametertree/Parameter.py

pyqtgraph/parametertree/parameterTypes/numeric.py

ntjess · 2024-02-14T18:07:56Z

Is there a reason Parameter needs to be abstract? It can be valuable to track a value, state, and changed signals even if there isn't a defined type associated

outofculture · 2024-02-14T19:31:36Z

Is there a reason Parameter needs to be abstract? It can be valuable to track a value, state, and changed signals even if there isn't a defined type associated

Good point. I was working back from the thought that there wasn't a generic widget that would make sense for editing a typeless parameter, but I hadn't considered that Parameters are useful outside of an interactive widget. The WidgetParameterItem.makeWidget method is already abstract, which is the most important part of signaling all this to a user, so yeah, I can skip the part of this PR that's about making Parameter abstract. Thanks for catching this!

pyqtgraph/parametertree/Parameter.py

j9ac9k · 2024-02-15T17:12:11Z

pyqtgraph/Qt/__init__.pyi

        except ImportError:
            try:
-                from PySide6 import QtCore, QtGui, QtWidgets
+                from PySide6 import QtCore, QtGui, QtSvg, QtTest, QtWidgets


Curious what the motivation here is for these extra imports? I'm not seeing them referenced elsewhere in the PR.

I noticed while looking at a test that the pyi file was incomplete; we already import both of these in the actual Qt/__init__.py file. Though, now that I'm looking at it closer, they're both imported in blocks of

try: from PySide6 import QtTest except ImportError as err: QtTest = FailedImport(err)

I don't know why QtTest wouldn't be available for import, but I'm guessing that maybe there are stripped-down distributions that don't include it? I don't know what that should mean for the pyi file, though. Probably any development environment is going to include the full qt library, which is what this file is intended for. However, the type-checking is going to run everywhere, regardless, and might throw an ImportError. Maybe I should just skip this and accept the lack of type hints... Thoughts?

Huh, QtTest is shown as being present in PySide6-essentials https://pypi.org/project/PySide6-Essentials/

That's weird it's not included, would it be under a different module or something?

the import worked fine on my machine just now?

In [1]: from PySide6 import QtTest In [2]: import PySide6 In [3]: PySide6.__version__ Out[3]: '6.6.2' In [4]:

okay then, I say we tentatively go forward with importing like this in the pyi and expecting that nothing will blow up. I'll put in an issue to clean up Qt.py to keep it isolated.

outofculture added 4 commits October 12, 2023 10:06

Parameter.valueTouchedSinceResetToDefault needed to know if a param h…

84eac11

…as been chaged

track if the value has been modified. start laying in pinToDefault be…

5d8851f

…havior

test and implement pinning the value

67849f5

make sure signals are properly emitted

b61434d

github-advanced-security bot found potential problems Oct 20, 2023

View reviewed changes

tests/parametertree/test_Parameter.py

import pyqtgraph as pg

import pytest

import pyqtgraph as pg

Check notice

Code scanning / CodeQL

Module is imported with 'import' and 'import from'

Module 'pyqtgraph' is imported with both 'import' and 'import from'.

outofculture added 2 commits November 24, 2023 10:21

Merge branch 'master' into param-touch

d9559db

Merge branch 'master' into param-touch

46ccc65

campagnola reviewed Jan 17, 2024

View reviewed changes

pyqtgraph/parametertree/Parameter.py Outdated Show resolved Hide resolved

outofculture added 6 commits January 17, 2024 16:58

offer an option for users to override initial modified state

6884d1f

prevent TypeError when handling color Parameter with None

a6f22cf

instead of pinToDefault, setDefault now takes an arg

262e04c

- extensive testing - raise appropriate ValueErrors when a parameter lacks a value or default - small cleanups around area of work

stop using value in places where it might not be set

099cd1c

turn no-default-set behavior into deprecation warning

1da5bdc

and don't raise an error!

8dbaf43

github-advanced-security bot found potential problems Jan 19, 2024

View reviewed changes

outofculture changed the title ~~Add pinToDefault option to Parameter~~ Add updatePristineValues arg to Parameter.setDefault Jan 19, 2024

deprecate Parameter(); whitespace; fixing bugs introduced by default/…

6b2af43

…value changes

github-advanced-security bot found potential problems Jan 22, 2024

View reviewed changes

outofculture added 10 commits January 21, 2024 22:30

Parameter should not be instatiated itself

d63a6e2

fix bug in converting param names to qt setters

3896c3a

ugly shim to keep old default/value behavior for pen parameter

485a67b

give HDF5 exporter a default columnMode

07f2294

we import these, also, so may as well type hint for them

c812413

give CSV exporter a default columnMode

6ba2a3b

just grab a value from the limits for now

2bcc94a

we should not guess the initial value of a list

a48b6e4

comprehensions are nice this time of year

49aff4b

no NotImplementedError until after the deprecation cycle

2e4bd22

pijyoi mentioned this pull request Jan 27, 2024

pen parameter type broken by df3e213 #2920

Closed

j9ac9k reviewed Feb 14, 2024

View reviewed changes

pyqtgraph/parametertree/Parameter.py Outdated Show resolved Hide resolved

j9ac9k reviewed Feb 14, 2024

View reviewed changes

pyqtgraph/parametertree/Parameter.py Outdated Show resolved Hide resolved

move specific error

014ef23

j9ac9k reviewed Feb 14, 2024

View reviewed changes

pyqtgraph/parametertree/parameterTypes/numeric.py Show resolved Hide resolved

test of limits=None for numeric params

35ebcbd

typeless Parameters are valuable, even apart from an interactive widget

ec2cedd

github-advanced-security bot found potential problems Feb 14, 2024

View reviewed changes

pyqtgraph/parametertree/Parameter.py Fixed Show fixed Hide fixed

j9ac9k reviewed Feb 15, 2024

View reviewed changes

cleaning; specifying

f2c8c9b

outofculture merged commit 2131138 into pyqtgraph:master Mar 7, 2024

Antyos mentioned this pull request Sep 2, 2024

ParameterTree Example Generated Deprecation Warning #2994

Closed

This was referenced Dec 18, 2025

Pyqtgraph default value PyMoDAQ/PyMoDAQ#797

Closed

Bugfix/pyqtgraph issues PyMoDAQ/PyMoDAQ#798

Merged

Recent Parameter changes broke getValues for nested Groups #3378

Open

pyqtgraph default value PyMoDAQ/PyMoDAQ#834

Open

Uh oh!

Conversation

outofculture commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other Tasks

Files that need updates

Pre Release Checklist

Steps To Complete

Uh oh!

Check notice

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Uh oh!

j9ac9k commented Feb 14, 2024

Uh oh!

Uh oh!

Uh oh!

ntjess commented Feb 14, 2024

Uh oh!

outofculture commented Feb 14, 2024

Uh oh!

Uh oh!

j9ac9k Feb 15, 2024

Choose a reason for hiding this comment

Uh oh!

outofculture Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

j9ac9k Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

j9ac9k Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

outofculture Mar 7, 2024 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

outofculture commented Oct 20, 2023 •

edited

Loading

outofculture Mar 7, 2024 •

edited

Loading