-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathsecrets.py
More file actions
65 lines (50 loc) · 1.89 KB
/
Copy pathsecrets.py
File metadata and controls
65 lines (50 loc) · 1.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# !/usr/bin/env python
#
# secrets.py
"""
Functions for working with secrets, such as API tokens.
.. versionadded:: 0.4.6
"""
#
# Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# this package
from domdf_python_tools.doctools import prettify_docstrings
__all__ = ["Secret"]
@prettify_docstrings
class Secret(str):
"""
Subclass of :py:class:`str` that guards against accidentally printing a secret to the terminal.
The actual value of the secret is accessed via the ``.value`` attribute.
The protection should be maintained even when the secret is in a list, tuple, set or dict,
but you should still refrain from printing objects containing the secret.
The secret overrides the :meth:`~.__eq__` method of :class:`str`, so:
.. code-block:: python
>>> Secret("Barry as FLUFL") == "Barry as FLUFL"
True
.. versionadded:: 0.4.6
"""
value: str #: The actual value of the secret.
def __new__(cls, value) -> "Secret": # noqa D102
obj: Secret = super().__new__(cls, "<SECRET>") # type: ignore
obj.value = str(value)
return obj
def __eq__(self, other) -> bool:
return self.value == other
def __hash__(self):
return hash(self.value)