# types-pydicom
Extended type hints for [pydicom's](https://github.com/pydicom/pydicom) [Dataset](https://pydicom.github.io/pydicom/stable/reference/generated/pydicom.dataset.Dataset.html#pydicom.dataset.Dataset) element keywords.
## Installation
```bash
$ pip install types-pydicom
```
## Usage
```python
# test_typing.py
from pydicom import Dataset
ds = Dataset()
ds.SamplesPerPixel = "abc"
reveal_type(ds.PixelData)
```
```bash
$ pip install pydicom types-pydicom mypy
$ mypy test_typing.py
test_typing.py:5: error: Incompatible types in assignment (expression has type "str", variable has type "int") [assignment]
test_typing.py:6: note: Revealed type is "Union[None, builtins.bytes]"
Found 1 errors in 1 file (checked 1 source file)
```
## Development
```bash
git clone https://github.com/pydicom
git clone https://github.com/pydicom/types-pydicom
cd types-pydicom
mkdir env
python3.10 -m venv env/env310
source env/env310/bin/activate
pip install -e .[dev]
```
### Updating
```bash
python scripts/update_package.py
```
Raw data
{
"_id": null,
"home_page": null,
"name": "types-pydicom",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pydicom, typing",
"author": "pydicom contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c1/49/53dfeb7991d218020244ec9876fbd904c43cbd03d4b475dfbf96f55c5aac/types_pydicom-3.0.0.0.tar.gz",
"platform": null,
"description": "# types-pydicom\nExtended type hints for [pydicom's](https://github.com/pydicom/pydicom) [Dataset](https://pydicom.github.io/pydicom/stable/reference/generated/pydicom.dataset.Dataset.html#pydicom.dataset.Dataset) element keywords.\n\n## Installation\n```bash\n$ pip install types-pydicom\n```\n\n## Usage\n```python\n# test_typing.py\n\nfrom pydicom import Dataset\n\nds = Dataset()\nds.SamplesPerPixel = \"abc\"\nreveal_type(ds.PixelData)\n```\n\n```bash\n$ pip install pydicom types-pydicom mypy\n$ mypy test_typing.py\ntest_typing.py:5: error: Incompatible types in assignment (expression has type \"str\", variable has type \"int\") [assignment]\ntest_typing.py:6: note: Revealed type is \"Union[None, builtins.bytes]\"\nFound 1 errors in 1 file (checked 1 source file)\n```\n\n## Development\n```bash\ngit clone https://github.com/pydicom\ngit clone https://github.com/pydicom/types-pydicom\ncd types-pydicom\nmkdir env\npython3.10 -m venv env/env310\nsource env/env310/bin/activate\npip install -e .[dev]\n```\n\n### Updating\n```bash\npython scripts/update_package.py\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extended type hints for pydicom",
"version": "3.0.0.0",
"project_urls": {
"homepage": "https://github.com/pydicom/types-pydicom"
},
"split_keywords": [
"pydicom",
" typing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a254a964eaa9b1308884dd3140b1ea2cda14c5519b89cdc94e39e8f40395bbbc",
"md5": "731375ec1a566ad5b31b0fb7d6ac2230",
"sha256": "03634ecaf30765606ab0abdee9e743076f76bdb69bbca8712626996b4c29c2e8"
},
"downloads": -1,
"filename": "types_pydicom-3.0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "731375ec1a566ad5b31b0fb7d6ac2230",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 78560,
"upload_time": "2024-09-08T23:15:56",
"upload_time_iso_8601": "2024-09-08T23:15:56.564228Z",
"url": "https://files.pythonhosted.org/packages/a2/54/a964eaa9b1308884dd3140b1ea2cda14c5519b89cdc94e39e8f40395bbbc/types_pydicom-3.0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c14953dfeb7991d218020244ec9876fbd904c43cbd03d4b475dfbf96f55c5aac",
"md5": "48374f16d063d382a7f7d8f5c92ebb46",
"sha256": "1e44380c899e22842cb300ba13aa28623bacef5ac078f2d613691885360c6bc0"
},
"downloads": -1,
"filename": "types_pydicom-3.0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "48374f16d063d382a7f7d8f5c92ebb46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 105019,
"upload_time": "2024-09-08T23:15:57",
"upload_time_iso_8601": "2024-09-08T23:15:57.749644Z",
"url": "https://files.pythonhosted.org/packages/c1/49/53dfeb7991d218020244ec9876fbd904c43cbd03d4b475dfbf96f55c5aac/types_pydicom-3.0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-08 23:15:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pydicom",
"github_project": "types-pydicom",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "types-pydicom"
}