ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-24 15:16:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

some more docstrings

Browse Source
This commit is contained in:
Jean-Paul Calderone 2021-11-22 08:36:12 -05:00
parent e0c0c32c13
commit b92343c664
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/allmydata/storage/lease_schema.py
View File

@ -28,11 +28,17 @@ from .lease import (
@attr.s(frozen=True)
class CleartextLeaseSerializer(object):
"""
Serialize and unserialize leases with cleartext secrets.
"""
_to_data = attr.ib()
_from_data = attr.ib()
def serialize(self, lease):
# type: (LeaseInfo) -> bytes
"""
Represent the given lease as bytes with cleartext secrets.
"""
if isinstance(lease, LeaseInfo):
return self._to_data(lease)
raise ValueError(
@ -42,6 +48,9 @@ class CleartextLeaseSerializer(object):
)
def unserialize(self, data):
"""
Load a lease with cleartext secrets from the given bytes representation.
"""
# type: (bytes) -> LeaseInfo
# In v1 of the immutable schema lease secrets are stored plaintext.
# So load the data into a plain LeaseInfo which works on plaintext