Merge branch 'main' of https://github.com/HolmPhilip/Qcodes

.github/package.json

@@ -1,5 +1,5 @@
 {
 "devDependencies": {
-	"pyright": "1.1.389"
+	"pyright": "1.1.390"
 }
 }

.github/workflows/codeql-analysis.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
 
@@ -39,12 +39,12 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@ea9e4e37992a54ee68a9622e985e60c8e8f12d9f # v3.27.4
+      uses: github/codeql-action/init@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
       with:
         languages: ${{ matrix.language }}
 
     - name: Autobuild
-      uses: github/codeql-action/autobuild@ea9e4e37992a54ee68a9622e985e60c8e8f12d9f # v3.27.4
+      uses: github/codeql-action/autobuild@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@ea9e4e37992a54ee68a9622e985e60c8e8f12d9f # v3.27.4
+      uses: github/codeql-action/analyze@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9

.github/workflows/dependency-review.yml

@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
         with:
           egress-policy: audit
 
       - name: 'Checkout Repository'
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@4081bf99e2866ebe428fc0477b69eb4fcda7220a # v4.4.0
+        uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0

.github/workflows/docs.yaml

@@ -29,19 +29,21 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
         exclude:
           - os: windows-latest
             python-version: 3.10
           - os: windows-latest
             python-version: 3.11
+          - os: windows-latest
+            python-version: 3.13
     env:
       OS: ${{ matrix.os }}
       SPHINX_WARNINGS_AS_ERROR: true
       SPHINX_OPTS: "-v -j 2"
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -61,7 +63,7 @@ jobs:
         sudo apt install pandoc
       if: runner.os == 'Linux'
     - name: Install pandoc on windows
-      uses: Wandalen/wretry.action@8ceaefd717b7cdae4f2637f9a433242ade421a0a # v3.7.2
+      uses: Wandalen/wretry.action@ffdd254f4eaf1562b8a2c66aeaa37f1ff2231179 # v3.7.3
       with:
         action: crazy-max/[email protected]
         with: |
@@ -111,7 +113,7 @@ jobs:
     steps:
 
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
 
@@ -124,7 +126,7 @@ jobs:
         path: build_docs
 
     - name: Deploy to gh pages
-      uses: JamesIves/github-pages-deploy-action@62fec3add6773ec5dbbf18d2ee4260911aa35cf4 # v4.6.9
+      uses: JamesIves/github-pages-deploy-action@15de0f09300eea763baee31dff6c6184995c5f6a # v4.7.2
       with:
         branch: gh-pages
         folder: ${{ github.workspace }}/build_docs/

.github/workflows/pre-commit.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
 
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
 

.github/workflows/pytest.yaml

@@ -52,7 +52,7 @@ jobs:
     steps:
 
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
 
@@ -108,9 +108,9 @@ jobs:
       run: |
         pytest -m "serial" -n 0 --dist no --cov=qcodes --cov-report xml --cov-append --hypothesis-profile ci $PYTEST_OPT tests
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@968872560f81e7bdde9272853e65f2507c0eca7c # v5.0.0
+      uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5.1.1
       with:
-        file: ./coverage.xml
+        files: ./coverage.xml
         env_vars: OS,PYTHON
         token: ${{ secrets.CODECOV_TOKEN }}
       if: ${{ github.event_name != 'merge_group' }}

.github/workflows/scorecards.yml

@@ -31,7 +31,7 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
         with:
           egress-policy: audit
 
@@ -71,6 +71,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@ea9e4e37992a54ee68a9622e985e60c8e8f12d9f # v3.27.4
+        uses: github/codeql-action/upload-sarif@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
         with:
           sarif_file: results.sarif

.github/workflows/upload_to_pypi.yaml

@@ -17,7 +17,7 @@ jobs:
       id-token: write
     steps:
     - name: Harden Runner
-      uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+      uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2
       with:
         egress-policy: audit
 
@@ -34,4 +34,4 @@ jobs:
     - name: Install Twine
       run: pip install twine
     - name: Publish to pypi
-      uses: pypa/gh-action-pypi-publish@15c56dba361d8335944d31a2ecd17d700fc7bcbc # release/v1
+      uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70 # release/v1

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.6.9'
+    rev: 'v0.8.0'
     hooks:
     - id: ruff
       types_or: [python, pyi, jupyter, toml]
@@ -22,7 +22,7 @@ repos:
     - id: mixed-line-ending
       args: ['--fix=no']
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.20.0
+    rev: v8.21.2
     hooks:
     - id: gitleaks
   - repo: https://github.com/jumanjihouse/pre-commit-hooks

docs/changes/0.50.0.rst

@@ -0,0 +1,26 @@
+QCoDeS 0.50.0 (2024-11-22)
+==========================
+
+Breaking Changes:
+-----------------
+
+- QCoDeS no longer attempts to automatically disable Sypders User module reloader (UMR).
+  The code was no longer working correctly with the latest version of Spyder and is not
+  maintainable since Spyder does not have a public api to disable UMR. If you use
+  QCoDeS from an editable install it is strongly recommended to disable UMR for QCoDeS.
+  See :ref:`gettingstarted` for more details. (:pr:`6647`)
+
+
+Improved:
+---------
+
+- Improves the DataSetDefinition class to allow users to specify metadata to be added to the resulting dataset (:pr:`6643`)
+- DelegateParameter now reads delegated properties from source rather than setting them at source change.
+  This resolves an issue when delegating from another delegate parameter may result in incorrect attributes. (:pr:`6648`)
+
+
+New:
+----
+
+- Added a new feature to find links in a parameter chain by parameter type (:pr:`6599`)
+- Added new methods to find instruments in a parameter chain by parameter type (:pr:`6616`)

docs/changes/0.50.1.rst

@@ -0,0 +1,8 @@
+QCoDeS 0.50.1 (2024-11-28)
+==========================
+
+Improved:
+---------
+
+- Fix a regression introduced in 0.50.0 where a DelegateParameter initialized with a None source
+  would not correctly call get/set on the source parameter when this has been set. (:pr:`6671`)

docs/changes/index.rst

@@ -3,6 +3,8 @@ Changelogs
 
 .. toctree::
    Unreleased <unreleased>
+   0.50.1 <0.50.1>
+   0.50.0 <0.50.0>
    0.49.0 <0.49.0>
    0.48.0 <0.48.0>
    0.47.0 <0.47.0>

docs/changes/newsfragments/6665.breaking

@@ -0,0 +1 @@
+The deprecated and non functional function `qcodes.test()` has been removed.

docs/changes/newsfragments/6671.improved

@@ -0,0 +1,2 @@
+Fix a regression introduced in 0.50.0 where a DelegateParameter initialized with a None source
+would not correctly call get/set on the source parameter when this has been set.

docs/examples/DataSet/Accessing-data-in-DataSet.ipynb

@@ -17786,7 +17786,7 @@
     }
    ],
    "source": [
-    "ps = list(interdeps.dependencies.keys())[0]\n",
+    "ps = next(iter(interdeps.dependencies.keys()))\n",
     "print(f\"Parameter {ps.name!r} is in {ps.unit!r}\")"
    ]
   },
@@ -18200,7 +18200,7 @@
     }
    ],
    "source": [
-    "q_param_spec = list(interdeps.standalones)[0]\n",
+    "q_param_spec = next(iter(interdeps.standalones))\n",
     "q_param_spec"
    ]
   },

docs/examples/DataSet/DataSet-class-walkthrough.ipynb

@@ -1087,7 +1087,7 @@
     }
    ],
    "source": [
-    "ps = list(interdeps.dependencies.keys())[0]\n",
+    "ps = next(iter(interdeps.dependencies.keys()))\n",
     "\n",
     "print(f\"Parameter {ps} depends on:\")\n",
     "\n",
@@ -1116,7 +1116,7 @@
     }
    ],
    "source": [
-    "ps = list(interdeps.dependencies.keys())[0]\n",
+    "ps = next(iter(interdeps.dependencies.keys()))\n",
     "print(f\"Parameter {ps.name!r} is in {ps.unit!r}\")"
    ]
   },

docs/start/index.rst

@@ -248,6 +248,17 @@ or jupyter lab:
 
     jupyter lab
 
+.. note::
+
+    Note that Spyder ships with functionality to automatically reload modules that are installed
+    editable. This functionality called
+    `User Module Reloader <https://docs.spyder-ide.org/current/panes/ipythonconsole.html#reload-changed-modules>`__
+    is known to not work well with QCoDeS. If you install QCoDeS editable (with -e flag)
+    we strongly recommend users to exclude QCoDeS from UMR. QCoDeS used to attempt to automatically
+    disable this feature. However, as `Spyder does not provide a public API for doing this <https://github.com/spyder-ide/spyder/issues/2451>`__
+    this relied on a private API in Spyder and broke with the last Spyder release.
+    If at some point this becomes possible to do with a public API QCoDeS may again disable this automatically.
+
 For other options from the terminal you can activate the QCoDeS in that terminal
 then start any other application, such as *IPython* or
 just plain old *Python*.

pyproject.toml

@@ -63,10 +63,10 @@ file = "README.rst"
 content-type = "text/x-rst"
 
 [project.urls]
-Homepage = "https://github.com/QCoDeS/Qcodes"
+Homepage = "https://github.com/microsoft/Qcodes"
 Documentation = "https://microsoft.github.io/Qcodes/"
-Source = "https://github.com/qcodes/qcodes"
-Tracker = "https://github.com/QCoDeS/Qcodes/issues"
+Source = "https://github.com/microsoft/qcodes"
+Tracker = "https://github.com/microsoft/Qcodes/issues"
 Changelog = "https://microsoft.github.io/Qcodes/changes/index.html"
 
 [project.optional-dependencies]
@@ -219,10 +219,7 @@ markers = "serial"
 # and error on all other warnings
 filterwarnings = [
     'error',
-    'ignore:Deprecated call to `pkg_resources\.declare_namespace:DeprecationWarning',  # google, sphinxcontrib
-    'ignore:pkg_resources is deprecated as an API:DeprecationWarning', # pyvisa-sim
     'ignore:open_binary is deprecated:DeprecationWarning', # pyvisa-sim
-    'ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated and scheduled for removal in a future version:DeprecationWarning', # tqdm dateutil
     'ignore:Jupyter is migrating its paths to use standard platformdirs:DeprecationWarning', # jupyter
     'ignore:Parsing dates involving a day of month without a year specified is ambiguious:DeprecationWarning', # ipykernel 3.13+
     'ignore:unclosed database in:ResourceWarning' # internal should be fixed
@@ -244,7 +241,12 @@ extend-exclude = ["typings"]
 # TID253 banned-module-level-imports
 # W pydocstyle
 # PLx pylint
-select = ["E", "F", "PT025", "UP","RUF008", "RUF010", "RUF012", "RUF100", "RUF101", "RUF200", "I", "G", "ISC", "TID253", "NPY", "PLE", "PLR", "PLC", "PLW", "W","D214", "D300", "D402", "D403", "D405", "D410", "D411", "D412", "D413", "D414", "D416", "D417", "D418", "D419", "TCH"]
+select = [
+    "E", "F", "PT025", "UP", "RUF",
+    "I", "G", "ISC", "TID253", "NPY", "PLE",
+    "PLR", "PLC", "PLW", "W",
+    "D214", "D300", "D402", "D403", "D405", "D410", "D411", "D412", "D413", "D414", "D416", "D417", "D418", "D419",
+    "TC"]
 # G004 We have a lot of use of f strings in log messages
 # so disable that lint for now
 # NPY002 We have a lot of use of the legacy