ni / ni/nitypes-python

TypeVars in public classes should be public

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

Nobody has claimed this yet.

Dominant language
Python
Stars
6
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Current status:

Example: https://nitypes.readthedocs.io/en/latest/autoapi/nitypes/waveform/AnalogWaveform.html#AnalogWaveform.from_array_1d

classmethod from_array_1d(array: numpy.typing.NDArray[_TOtherRaw], dtype: None = ..., *, copy: bool = ..., start_index: SupportsIndex | None = ..., sample_count: SupportsIndex | None = ..., extended_properties: collections.abc.Mapping[str, nitypes.waveform.ExtendedPropertyValue] | None = ..., timing: nitypes.waveform.Timing[nitypes.waveform._timing._AnyDateTime, nitypes.waveform._timing._AnyTimeDelta, nitypes.waveform._timing._AnyTimeDelta] | None = ..., scale_mode: nitypes.waveform.ScaleMode | None = ...)→ AnalogWaveform[_TOtherRaw]

nitypes.waveform.ExtendedPropertyValue, nitypes.waveform.Timing, and nitypes.waveform.ScaleMode are the public exports.

nitypes.waveform._timing._AnyDateTime and nitypes.waveform._timing._AnyTimeDelta are TypeAliases in a private submodule.

_TOtherRaw is a TypeVar in a private submodule. Sphinx-autoapi is not displaying its submodule name here, but I think there may be some situations where it does.

After discussion with @mshafer-NI, I think it makes sense to do the following:

  • Make TypeAliases (e.g. _AnyTimeDelta) public or replace them with the corresponding unions (e.g. bt.TimeDelta | dt.timedelta | ht.timedelta)
  • Make TypeVars (e.g. _TOtherRaw) public
    • Challenge: some of the waveforms use the same TypeVar name with different bounds. These may need to live in separate submodules or be renamed.

In a few years, Python 3.11 will go EOL. At that point, we can replace the TypeVars with PEP 695 generic syntax. However, we do not necessarily need to break compatibility with code that imports our exported TypeVars. We can keep exporting them as long as we want, and we can also implement a module-level __getattr__ that emits DeprecationWarning if they are imported.

Originally posted by @bkeryan in #16

AB#3209800

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 nitypes.waveform API and the documented AnalogWaveform.from_array_1d example, then inspect the private _timing TypeAliases and _TOtherRaw TypeVar referenced in the issue. Compare the public exports with the generated documentation and determine how differing TypeVar bounds should be handled. Done means public annotations no longer expose unintended private TypeVars or aliases while the proposed compatibility behavior is accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.