ni / ni/ni-apis-python

Check analyzers action allows warnings from Pyright

Open
#114 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug triage
Dominant language
Python
Stars
7
Forks
2
Avg merge
1d 18h
Merged PRs (30d)
3

Description

Bug Report

The check_analyzers.yml workflow runs Pyright static analysis, and when the tool emits warnings, the checks pass.

Repro or Code Sample

Example

https://github.com/ni/ni-apis-python/actions/runs/17439900411/job/49519891808?pr=100#step:13:27

/home/runner/work/ni-apis-python/ni-apis-python/packages/ni.measurementlink.sessionmanagement.v1.client/src/ni/measurementlink/sessionmanagement/v1/client/_reservation.py:278:43 - warning: TypeVar "TMultiplexerSession" appears only once in generic function signature
Use "object" instead (reportInvalidTypeVarUse)

Expected Behavior

We expect the checks to fail on Pyright warnings.

Current Behavior

Currently the checks pass on Pyright warnings.

Possible Solution

Update the Pyright configuration for each project

  • use strict mode if the new errors are fixable
  • or promote the severity of selected rules from "warning" to "error"

Context

I noticed these Alerts when reviewing PRs

Image

Your Environment

  • ni-apis-python version: main
  • Python version: 3.11

AB#3251205

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the check_analyzers.yml workflow and the Pyright configuration for each project; compare the referenced action run with the current settings. Confirm that the reported Pyright warning causes the checks to fail, using strict mode or promoted rule severity where appropriate, and verify the analyzer workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.