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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# -*- coding: utf-8 -*-
# document.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
A Soledad Document is an u1db.Document with lasers.
"""
from u1db import Document
#
# SoledadDocument
#
class SoledadDocument(Document):
"""
Encryptable and syncable document.
LEAP Documents can be flagged as syncable or not, so the replicas
might not sync every document.
"""
def __init__(self, doc_id=None, rev=None, json='{}', has_conflicts=False,
syncable=True):
"""
Container for handling an encryptable document.
@param doc_id: The unique document identifier.
@type doc_id: str
@param rev: The revision identifier of the document.
@type rev: str
@param json: The JSON string for this document.
@type json: str
@param has_conflicts: Boolean indicating if this document has conflicts
@type has_conflicts: bool
@param syncable: Should this document be synced with remote replicas?
@type syncable: bool
"""
Document.__init__(self, doc_id, rev, json, has_conflicts)
self._syncable = syncable
def _get_syncable(self):
"""
Return whether this document is syncable.
@return: Is this document syncable?
@rtype: bool
"""
return self._syncable
def _set_syncable(self, syncable=True):
"""
Determine if this document should be synced with remote replicas.
@param syncable: Should this document be synced with remote replicas?
@type syncable: bool
"""
self._syncable = syncable
syncable = property(
_get_syncable,
_set_syncable,
doc="Determine if document should be synced with server."
)
def _get_rev(self):
"""
Get the document revision.
Returning the revision as string solves the following exception in
Twisted web:
exceptions.TypeError: Can only pass-through bytes on Python 2
@return: The document revision.
@rtype: str
"""
if self._rev is None:
return None
return str(self._rev)
def _set_rev(self, rev):
"""
Set document revision.
@param rev: The new document revision.
@type rev: bytes
"""
self._rev = rev
rev = property(
_get_rev,
_set_rev,
doc="Wrapper to ensure `doc.rev` is always returned as bytes.")
|
