Future-proof your code, and help ensure valid DICOM
There are some features of pydicom that allow you to help check your code for more strict DICOM practices, and to future-proof against major pydicom version changes.
It is recommended that you turn on two features if you can: enforcement of valid DICOM, and a flag to enable “future” pydicom changes.
Enforcing Valid DICOM¶
pydicom has a configuration option to help enforce valid DICOM:
If set to True, some non-standard DICOM will result in pydicom raising an error rather than assuming a default behavior or issuing a warning.
This flag does not guarantee strict DICOM results, but is a help for some specific situations that have been added to pydicom over time.
In some cases, especially if you are dealing with files that do not strictly adhere to the DICOM Standard, you may need to disable this flag.
To turn on the flag in your code:
from pydicom import config config.enforce_valid_values = True
Note that you must not use
from pydicom.config import enforce_valid_values.
That makes the enforce_valid_values variable local only to that module,
so pydicom would not see your change to its value.
Future-proofing your code¶
pydicom, like all software, must balance its evolution with not breaking existing code using the library. Sometimes, major changes are necessary to make significant improvements to the library.
To help you protect your code against future changes, pydicom allows you to flag that it should behave as it will for any known upcoming major changes.
Running your code with this turned on will help identify any parts of your code that are not compatible with the known changes in the next major version of pydicom.
The simplest way to set this behavior is to set an environment variable
PYDICOM_FUTURE to “True”. For example to temporarily turn it on in the
current terminal session:
SET PYDICOM_FUTURE=True (Windows) export PYDICOM_FUTURE=True (many linux environments)
If you wish to turn off the behavior, you can either remove the environment variable, or set it to “False”. See your operating system documentation for more details on setting or removing environment variables.
The other way to enable the future behavior is to turn it on at run-time
from pydicom import config config.future_behavior()
If you needed to turn the future behavior off again at run-time, call
future_behavior() with False:
Limiting the pydicom major version in your package¶
Another way to avoid breaking changes in future pydicom versions is to limit the version of pydicom that your code uses.
If you follow standard Python packaging recommendations, you can add a line to your requirements.txt file to limit the pydicom version to the current major version. E.g. a line like:
in the requirements.txt file will ensure that those installing your package will get the same major version (in the example, version 2) of pydicom that you have developed the code for. This works best if your package is installed in a virtual environment.