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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
"""Models module."""
import re
import typing
from .errors import MalformedCaptionError
class Timestamp:
"""Representation of a timestamp."""
PATTERN = re.compile(r'(?:(\d{1,2}):)?(\d{1,2}):(\d{1,2})\.(\d{3})')
def __init__(
self,
hours: int = 0,
minutes: int = 0,
seconds: int = 0,
milliseconds: int = 0
):
"""Initialize."""
self.hours = hours
self.minutes = minutes
self.seconds = seconds
self.milliseconds = milliseconds
def __str__(self):
"""Return the string representation of the timestamp."""
return (
f'{self.hours:02d}:{self.minutes:02d}:{self.seconds:02d}'
f'.{self.milliseconds:03d}'
)
def to_tuple(self) -> typing.Tuple[int, int, int, int]:
"""Return the timestamp in tuple form."""
return self.hours, self.minutes, self.seconds, self.milliseconds
def __repr__(self):
"""Return the string representation of the caption."""
return (f'<{self.__class__.__name__} '
f'hours={self.hours} '
f'minutes={self.minutes} '
f'seconds={self.seconds} '
f'milliseconds={self.milliseconds}>'
)
def __eq__(self, other):
"""Compare equality with other object."""
return self.to_tuple() == other.to_tuple()
def __ne__(self, other):
"""Compare a not equality with other object."""
return self.to_tuple() != other.to_tuple()
def __gt__(self, other):
"""Compare greater than with other object."""
return self.to_tuple() > other.to_tuple()
def __lt__(self, other):
"""Compare less than with other object."""
return self.to_tuple() < other.to_tuple()
def __ge__(self, other):
"""Compare greater or equal with other object."""
return self.to_tuple() >= other.to_tuple()
def __le__(self, other):
"""Compare less or equal with other object."""
return self.to_tuple() <= other.to_tuple()
@classmethod
def from_string(cls, value: str) -> 'Timestamp':
"""Return a `Timestamp` instance from a string value."""
if type(value) is not str:
raise MalformedCaptionError(f'Invalid timestamp {value!r}')
match = re.match(cls.PATTERN, value)
if not match:
raise MalformedCaptionError(f'Invalid timestamp {value!r}')
hours = int(match.group(1) or 0)
minutes = int(match.group(2))
seconds = int(match.group(3))
milliseconds = int(match.group(4))
if minutes > 59 or seconds > 59:
raise MalformedCaptionError(f'Invalid timestamp {value!r}')
return cls(hours, minutes, seconds, milliseconds)
def in_seconds(self) -> int:
"""Return the timestamp in seconds."""
return (self.hours * 3600 +
self.minutes * 60 +
self.seconds
)
class Caption:
"""Representation of a caption."""
CUE_TEXT_TAGS = re.compile('<.*?>')
VOICE_SPAN_PATTERN = re.compile(r'<v(?:\.\w+)*\s+([^>]+)>')
def __init__(self,
start: typing.Optional[str] = None,
end: typing.Optional[str] = None,
text: typing.Optional[typing.Union[str,
typing.Sequence[str]
]] = None,
identifier: typing.Optional[str] = None
):
"""
Initialize.
:param start: start time of the caption
:param end: end time of the caption
:param text: the text of the caption
:param identifier: optional identifier
"""
text = text or []
self.start = start or '00:00:00.000'
self.end = end or '00:00:00.000'
self.identifier = identifier
self.lines = (text.splitlines()
if isinstance(text, str)
else
list(text)
)
self.comments: typing.List[str] = []
def __repr__(self):
"""Return the string representation of the caption."""
cleaned_text = self.text.replace('\n', '\\n')
return (f'<{self.__class__.__name__} '
f'start={self.start!r} '
f'end={self.end!r} '
f'text={cleaned_text!r} '
f'identifier={self.identifier!r}>'
)
def __str__(self):
"""Return a readable representation of the caption."""
cleaned_text = self.text.replace('\n', '\\n')
return f'{self.start} {self.end} {cleaned_text}'
def __eq__(self, other):
"""Compare equality with another object."""
if not isinstance(other, type(self)):
return False
return (self.start == other.start and
self.end == other.end and
self.raw_text == other.raw_text and
self.identifier == other.identifier
)
@property
def start(self):
"""Return the start time of the caption."""
return str(self.start_time)
@start.setter
def start(self, value: str):
"""Set the start time of the caption."""
self.start_time = Timestamp.from_string(value)
@property
def end(self):
"""Return the end time of the caption."""
return str(self.end_time)
@end.setter
def end(self, value: str):
"""Set the end time of the caption."""
self.end_time = Timestamp.from_string(value)
@property
def start_in_seconds(self) -> int:
"""Return the start time of the caption in seconds."""
return self.start_time.in_seconds()
@property
def end_in_seconds(self):
"""Return the end time of the caption in seconds."""
return self.end_time.in_seconds()
@property
def raw_text(self) -> str:
"""Return the text of the caption (including cue tags)."""
return '\n'.join(self.lines)
@property
def text(self) -> str:
"""Return the text of the caption (without cue tags)."""
return re.sub(self.CUE_TEXT_TAGS, '', self.raw_text)
@text.setter
def text(self, value: str):
"""Set the text of the captions."""
if not isinstance(value, str):
raise AttributeError(
f'String value expected but received {value}.'
)
self.lines = value.splitlines()
@property
def voice(self) -> typing.Optional[str]:
"""Return the voice span if present."""
if self.lines and self.lines[0].startswith('<v'):
match = re.match(self.VOICE_SPAN_PATTERN, self.lines[0])
if match:
return match.group(1)
return None
class Style:
"""Representation of a style."""
def __init__(self, text: typing.Union[str, typing.List[str]]):
"""Initialize.
:param: text: the style text
"""
self.lines = text.splitlines() if isinstance(text, str) else text
self.comments: typing.List[str] = []
@property
def text(self):
"""Return the text of the style."""
return '\n'.join(self.lines)
|
