Project-MONAI / Project-MONAI/monai-deploy-app-sdk

Fine tune the type hint of domain DICOM object's property defaults

Open
#112 0 comments 1 reaction 1 assignee View on GitHub

@MMelQin is already working on this.

Since Sep 22, 2021.

enhancement
Dominant language
Python
Stars
138
Forks
70
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
The type hint of domain DICOM object property value is Any, but the underlying data all have standards defined Value Representations. The type hint can be fine tuned to be more user friendly and semantically correct.

Describe the solution you'd like
Fine tune the type hint of the domain DICOM object type hint, and add type validation to the properties, e.g. property representing DICOM date should be str with format YYYYMMDD.

Describe alternatives you've considered
Currently rely on underlying library to set the value with correct types, and assume client applications do it correctly too.

Additional context
Not expected to be an issue for version 0.1, though this should be addressed in 0.2.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.