pydicom.charset.encode_string

pydicom.charset.encode_string(value: str, encodings: Sequence[str]) bytes[source]

Encode a unicode string value into bytes using encodings.

New in version 1.2.

Parameters
  • value (str) – The unicode string as presented to the user.

  • encodings (list of str) – The encodings needed to encode the string as a list of Python encodings, converted from the encodings in (0008,0005) Specific Character Set.

Returns

The encoded string. If value could not be encoded with any of the given encodings, and reading_validation_mode is not RAISE, a warning is issued, and value is encoded using the first encoding with replacement characters, resulting in data loss.

Return type

bytes

Raises

UnicodeEncodeError – If writing_validation_mode is set to RAISE and value could not be encoded with the supplied encodings.