aeidon/agents/search.py¶
Source code for module aeidon.agents.search from file aeidon/agents/search.py.
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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | # -*- coding: utf-8 -*-
# Copyright (C) 2005 Osmo Salomaa
#
# 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/>.
"""Searching for and replacing text."""
import aeidon
import re
_ = aeidon.i18n._
class SearchAgent(aeidon.Delegate):
"""
Searching for and replacing text.
:ivar _docs: Sequence of :attr:`aeidon.documents` items
:ivar _finder: Instance of :class:`aeidon.Finder` used
:ivar _match_doc: :attr:`aeidon.documents` item of the last match
:ivar _match_passed: ``True`` if the position of last match has been passed
:ivar _match_index: Index of the last match
:ivar _match_span: Start and end positions of the last match
:ivar _indices: Sequence of target indices or ``None`` for all
:ivar _wrap: ``True`` to wrap search, ``False`` to stop at the last index
Searching is done with the help of an instance of :class:`aeidon.Finder`.
This agent provides for looping over the subtitles and their texts, feeding
those texts to the finder and raising :exc:`StopIteration` when no more
matches are found.
"""
def __init__(self, master):
"""Initialize a :class:`SearchAgent` instance."""
aeidon.Delegate.__init__(self, master)
self._docs = None
self._finder = aeidon.Finder()
self._indices = None
self._match_doc = None
self._match_index = None
self._match_passed = None
self._match_span = None
self._wrap = None
# Set targets to defaults.
self.set_search_target()
def _find(self, index, doc, pos, next):
"""
Find pattern starting from given position.
`pos` can be ``None`` for beginning or end.
`next` should be ``True`` to find next, ``False`` for previous.
Raise :exc:`StopIteration` if no match.
Return tuple of index, document, match span.
"""
find = (self._next_in_document if next
else self._previous_in_document)
self._match_index = index
self._match_doc = doc
self._match_passed = False
indices = self._indices or self.get_all_indices()
while True:
with aeidon.util.silent(ValueError):
# Return match in document after location.
return find(index, doc, pos)
# Proceed to the next document or raise StopIteration.
self._match_passed = True
doc = self._get_document(doc, next)
index = (min(indices) if next else max(indices))
pos = None
@aeidon.deco.export
def find_next(self, index=None, doc=None, pos=None):
"""
Find the next match starting from given position.
`index`, `doc` and `pos` can be ``None`` to start from beginning.
Raise :exc:`StopIteration` if no (more) matches exist.
Return tuple of index, document, match span.
"""
index = (0 if index is None else index)
doc = (self._docs[0] if doc is None else doc)
return self._find(index, doc, pos, next=True)
@aeidon.deco.export
def find_previous(self, index=None, doc=None, pos=None):
"""
Find the previous match starting from given position.
`index`, `doc` and `pos` can be ``None`` to start from end.
Raise :exc:`StopIteration` if no (more) matches exist.
Return tuple of index, document, match span.
"""
index = (len(self.subtitles)-1 if index is None else index)
doc = (self._docs[-1] if doc is None else doc)
return self._find(index, doc, pos, next=False)
def _get_document(self, doc, next):
"""
Return the document to proceed to.
`next` should be ``True`` to find next, ``False`` for previous.
Raise :exc:`StopIteration` if nowhere to proceed.
"""
if len(self._docs) == 1:
if self._wrap: return doc
raise StopIteration
if next and doc == aeidon.documents.MAIN:
return aeidon.documents.TRAN
if next and doc == aeidon.documents.TRAN:
if self._wrap:
return aeidon.documents.MAIN
raise StopIteration
if not next and doc == aeidon.documents.MAIN:
if self._wrap:
return aeidon.documents.TRAN
raise StopIteration
if not next and doc == aeidon.documents.TRAN:
return aeidon.documents.MAIN
raise ValueError("Invalid document: {} or invalid next: {}"
.format(repr(doc), repr(next)))
def _next_in_document(self, index, doc, pos=None):
"""
Find the next match in `doc` starting from `pos`.
`pos` can be ``None`` to start from beginning.
Raise :exc:`StopIteration` if no matches at all anywhere.
Raise :exc:`ValueError` if no match in this `doc` after `pos`.
Return tuple of index, document, match span.
"""
indices = self._indices or self.get_all_indices()
for index in range(index, max(indices)+1):
text = self.subtitles[index].get_text(doc)
# Avoid resetting finder's match span.
if text != self._finder.text:
self._finder.set_text(text)
self._finder.pos = 0
if pos is not None:
self._finder.pos = pos
try:
match_span = self._finder.next()
except StopIteration:
# Raise StopIteration if a full loop around all target
# documents and indices has been made with no matches.
if doc == self._match_doc:
if index == self._match_index:
if self._match_passed:
raise StopIteration
pos = None
continue
self._match_index = index
self._match_doc = doc
self._match_span = match_span
self._match_passed = False
return index, doc, match_span
# Raise ValueError if no match found in this document after position.
raise ValueError("No more matches in document")
def _previous_in_document(self, index, doc, pos=None):
"""
Find the previous match in `doc` starting from `pos`.
`pos` can be ``None`` to start from end.
Raise :exc:`StopIteration` if no matches at all anywhere.
Raise :exc:`ValueError` if no match in this `doc` before `pos`.
Return tuple of index, document, match span.
"""
indices = self._indices or self.get_all_indices()
for index in reversed(range(min(indices), index+1)):
text = self.subtitles[index].get_text(doc)
# Avoid resetting finder's match span.
if text != self._finder.text:
self._finder.set_text(text)
self._finder.pos = len(self._finder.text)
if pos is not None:
self._finder.pos = pos
try:
match_span = self._finder.previous()
except StopIteration:
# Raise StopIteration if a full loop around all target
# documents and indices has been made with no matches.
if doc == self._match_doc:
if index == self._match_index:
if self._match_passed:
raise StopIteration
pos = None
continue
self._match_index = index
self._match_doc = doc
self._match_span = match_span
self._match_passed = False
return index, doc, match_span
# Raise ValueError if no match found in this document after position.
raise ValueError("No more matches in document")
@aeidon.deco.export
@aeidon.deco.revertable
def replace(self, register=-1):
"""
Replace the current match of pattern.
Raise :exc:`re.error` if bad replacement.
"""
orig_text = self._finder.text
self._finder.replace()
if self._finder.text == orig_text: return
self.set_text(self._match_index,
self._match_doc,
self._finder.text,
register=register)
self.set_action_description(register, _("Replacing"))
@aeidon.deco.export
@aeidon.deco.revertable
def replace_all(self, register=-1):
"""
Replace all matches of pattern and return amount of replacements made.
Raise :exc:`re.error` if bad replacement.
"""
counts = {}
for doc in self._docs:
counts[doc] = 0
new_indices = []
new_texts = []
for index, subtitle in enumerate(self.subtitles):
text = subtitle.get_text(doc)
self._finder.set_text(text)
sub_count = self._finder.replace_all()
if sub_count > 0:
new_indices.append(index)
new_texts.append(self._finder.text)
counts[doc] += sub_count
if not new_indices: continue
self.replace_texts(new_indices,
doc,
new_texts,
register=register)
self.set_action_description(register, _("Replacing all"))
if (len(list(counts.keys())) == 2) and all(counts.values()):
self.group_actions(register, 2, _("Replacing all"))
return sum(counts.values())
@aeidon.deco.export
def set_search_regex(self, pattern, flags=re.DOTALL|re.MULTILINE):
"""
Set the regular expression pattern to find.
Raise :exc:`re.error` if bad pattern.
"""
# Ignore case only if in flags.
self._finder.ignore_case = False
self._finder.set_regex(pattern, flags)
@aeidon.deco.export
def set_search_replacement(self, replacement):
"""Set the replacement string."""
self._finder.replacement = replacement
@aeidon.deco.export
def set_search_string(self, pattern, ignore_case=False):
"""Set the string pattern to find."""
self._finder.pattern = pattern
self._finder.ignore_case = ignore_case
@aeidon.deco.export
def set_search_target(self, indices=None, docs=None, wrap=True):
"""
Set the targets to search in.
`indices` can be ``None`` to target all subtitles.
`docs` can be ``None`` to target all documents.
"""
self._indices = (tuple(indices) if indices else None)
self._docs = tuple(docs or aeidon.documents)
self._wrap = wrap
|