[FEATURE] Introduce SecretStr class for enhanced secret handling #164
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces an extended
SecretStr
class to allow concatenation and use in f-strings.Description
This pull request introduces the
SecretStr
class, which extends Pydantic'sSecretStr
to provide additional functionality.The enhancements include:
SecretStr
instances.The
SecretStr
class continues to ensure that the secret value is masked in string representations and provides methods to safely handle secret values.Related Issue
Closes #165
Motivation and Context
The change is required to provide a more secure and flexible way to handle secret strings while allowing them to be combined with other strings and f-string. By extending Pydantic's
SecretStr
, we can ensure that secret values are properly masked and only revealed in secure contexts, such as within anotherSecretStr
instance. This helps prevent accidental exposure of sensitive information.How Has This Been Tested?
The changes have been tested by adding unit tests to verify the following:
str
andrepr
methods inSecretStr
.SecretStr
with various types, including strings, integers, floats, booleans, and more.Screenshots (if appropriate):
N/A
Types of changes
Checklist: