o iy0 @sUdZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z m Z mZddlmZer9ddlmZeeejZ Gd d d eZd ed efd dZd efddZdaedBed<d efddZ d eeeffddZ!d.ddZ"dej#fdeej$Bdede%d e&efddZ'd/ded e&efddZ( !d0d"ed#ed$ed d%fd&d'Z)d1d"ed$ed edBfd(d)Z*d/ded e&efd*d+Z+d/ded e&efd,d-Z,dS)2aManagement of pydicom's data files. External Data Sources --------------------- *pydicom* can also search third-party data sources for matching data. To do so your project should register its entry points in its `setup.py` file. For example, a project named "mydata" with the interface class ``MyInterface`` should register: .. codeblock: python from setuptools import setup setup( ..., entry_points={ "pydicom.data.external_sources": "mydata = mydata:MyInterface", }, ) The interface class should have, at a minimum, the following two methods: * ``get_path(self, name: str, dtype: int) -> str`` - returns the absolute path to the first file with a filename `name` or raises a ``ValueError`` if no matching file found. * ``get_paths(self, pattern: str, dtype: int) -> List[str]`` - returns a list of absolute paths to filenames matching `pattern`. Where `name` is the name of the filename to search for, `dtype` is an int that indicates the type of data to search for and should be one of the following: * ``0`` - DICOM dataset * ``1`` - Character set file * ``2`` - Palette file * ``3`` - DICOMDIR file * ``4`` - JPEG file And lastly, `pattern` is a str used to filter files against when searching. For a real-life example of an external data source you can look at the `pydicom-data `_ repository. )IntEnumN)Path) TYPE_CHECKING)data_path_with_downloadcalculate_file_hashget_cached_filehash get_url_map get_data_dir) warn_and_log)Datasetc@s$eZdZdZdZdZdZdZdZdS) DataTypeszConstants for data types.rN) __name__ __module__ __qualname____doc__DATASETCHARSETPALETTEDICOMDIRJPEGrrO/mnt/sdb/aimis/docanh/lib/python3.10/site-packages/pydicom/data/data_manager.pyr Gsr fpathreturncCs"t|}t|}t|j}||kS)aReturn ``True`` if the SHA256 checksum of the file at ``fpath`` is OK. Parameters ---------- fpath : str The absolute path to the file to perform the checksum for. Returns ------- bool ``True`` if the checksum matches those in ``hashes.json``, ``False`` otherwise. Raises ------ pydicom.data.download.NoHashFound If the file is missing from ``hashes.json``. )rrrname)rpext_hashref_hashrrr_check_data_hashQs r"cCsFddlm}dd|ddD}i}d|vr|d|d<|||S)zReturn a :class:`dict` of external data source interfaces. Returns ------- dict A dict of ``{'source name': }``. r) entry_pointscSsi|] }|j|qSr)rload).0vvrrr w z(get_external_sources..zpydicom.data.external_sources)group pydicom-data)importlib.metadatar#update)r#sourcesoutrrrget_external_sourcesks   r/_EXTERNAL_DATA_SOURCEScCstdurtatS)z9Return the available external data sources - loaded once.N)r0r/rrrrexternal_data_sourcessr1cs2tt}tjtdfdd|D}|S)zReturn a :class:`dict` of dummy paths to the downloadable test files. Returns ------- dict A dict of dummy paths to the test files available via download. test_filescsi|] }tj||qSr)ospathjoinr%filenametest_files_rootrrr'sz0online_test_file_dummy_paths..)listrkeysr3r4r5 DATA_ROOT) filenamesdummy_path_maprr8ronline_test_file_dummy_pathss  r?c sxtfddttD}g}|D]}zt|jWqty-||jYqw|r:tdd |dS)z/Download missing test files to the local cache.csi|]}||qSrr)r%fnamecacherrr'z$fetch_data_files..z3An error occurred downloading the following files: z, N) r r:rr;rr Exceptionappend RuntimeErrorr5)pathserrorrrrArfetch_data_filess rI**/*basepatterndtypec st|}dd||D}tD]\}}|||}|dkr(dd|D}||qtt t j ||}fdd|D}g} d} |D]} z | t t| WqMtyfd} YqMw|| 7}| rqtd|S) aReturn all matching file paths from the available data sources. First searches the local *pydicom* data store, then any locally available external sources, and finally the files available in the pydicom/pydicom-data repository. .. versionchanged: 2.1 Added the `dtype` keyword parameter, modified to search locally available external data sources and the pydicom/pydicom-data repository Parameters ---------- base : str or os.PathLike Base directory to recursively search. pattern : str, optional The pattern to pass to :meth:`~pathlib.Path.glob`, default (``'**/*'``). dtype : int, optional The type of data to search for when using an external source, one of: * ``0`` - DICOM dataset * ``1`` - Character set file * ``2`` - Palette file * ``3`` - DICOMDIR file * ``4`` - JPEG file Returns ------- list of str A list of absolute paths to matching files. cSsg|]}t|qSrr3fspathr%mrrr rCzget_files..r*cSsg|]}t|r|qSr)r")r%rrrrrRscsg|] }t|qSrrN)r% dummy_pathdummy_online_file_path_maprrrRr(FTzYOne or more download failures occurred, the list of matching file paths may be incomplete)rglobr1items get_pathsextendr?fnmatchfilterr;r3r4r5rErOrrDr ) rKrLrMfileslibsourcefpathsdummy_online_file_path_filtereddownload_namesreal_online_file_pathsdownload_errorr7rrTr get_filess8#    rdcC.ttd}t||tjd}dd|D}|S)aHReturn a list of absolute paths to palettes with filenames matching `pattern`. Parameters ---------- pattern : str, optional The pattern to pass to :meth:`~pathlib.Path.glob`, default (``'**/*'``). Returns ------- list of str A list of absolute paths to matching files. palettesrKrLrMcSg|] }|ds|qSz.pyendswithr6rrrrRz%get_palette_files..)rr<rdr rrL data_pathr\rrrget_palette_files roFTrreaddownloadzstr | Dataset | NonecCsPtj|rtd|dt||d}|r&|dur&ddlm}||ddS|S) aReturn an absolute path to the first matching dataset with filename `name` that is found in a local or external pydicom datastore. First searches the local *pydicom* data store, then any locally available external sources, and finally the files available in the pydicom/pydicom-data repository. .. versionchanged:: 2.1 Modified to search locally available external data sources and the pydicom/pydicom-data repository .. versionchanged:: 2.2 Added the `read` keyword parameter. .. versionchanged:: 2.3 Added the `download` keyword parameter. Parameters ---------- name : str The full file name (without path) read : bool, optional If ``True`` then use :func:`~pydicom.filereader.dcmread` to read the file and return the corresponding :class:`~pydicom.dataset.FileDataset`. Default ``False``. download : bool, optional If ``True`` (default) download the file if missed locally. Returns ------- str, pydicom.dataset.Dataset or None The absolute path of the file if found, the dataset itself if `read` is ``True``, or ``None`` if the file is not found. Raises ______ ValueError If `name` is an absolute path. z'get_testdata_file' does not support absolute paths, as it only works with internal pydicom test data - did you mean 'dcmread("z")'?)rrrNr)dcmreadT)force)r3r4isabs ValueError_get_testdata_filepydicom.filereaderrs)rrqrrr4rsrrrget_testdata_files /    ryc Csttd}dd||D}|rt|dStD]/\}}z |j|tj d}Wn t y7d}Ynw|dkrG|rFt |rF|Sq|rM|Sq|rwt D]!}||kr\qUz tt|WStyvtd|YqUwdS)Nr2cSsg|]}|qSrrrPrrrrR\sz&_get_testdata_file..r)rMr*z9A download failure occurred while attempting to retrieve )rr<rglobr3rOr1rWget_pathr rrvr"rr;rrDr )rrrrnmatchesr]r^rr7rrrrwYs>    rwcCsBtj|r tdttd}t||tjd}dd|D}|S)aReturn a list of absolute paths to datasets with filenames matching `pattern`. Parameters ---------- pattern : str, optional The pattern to pass to :meth:`~pathlib.Path.glob`, default (``'**/*'``). Returns ------- list of str A list of absolute paths to matching files. Raises ______ ValueError If `pattern` matches an absolute path. zg'get_testdata_files' does not support absolute paths, as it only works with internal pydicom test data.r2rgcSrhrirjr6rrrrRrlz&get_testdata_files..) r3r4rurvrr<rdr rrmrrrget_testdata_filess  r}cCre)aKReturn a list of absolute paths to charsets with filenames matching `pattern`. Parameters ---------- pattern : str, optional The pattern to pass to :meth:`~pathlib.Path.glob`, default (``'**/*'``). Returns ---------- list of str A list of absolute paths to matching files. charset_filesrgcSrhrirjr6rrrrRrlz%get_charset_files..)rr<rdr rrmrrrget_charset_filesrpr)rN)rJ)FT)T)-renumrrZr3pathlibrtypingrpydicom.data.downloadrrrrr pydicom.miscr pydicomr rO__file__parentresolver<r strboolr"dictr/r0__annotations__r1r?rIrPathLikeintr:rdroryrwr}rrrrrsX .       P =&!