/usr/lib/python3/dist-packages/aeidon/patternman.py is in python3-aeidon 0.24.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
# Copyright (C) 2007-2009 Osmo Salomaa
#
# This file is part of Gaupol.
#
# Gaupol 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.
#
# Gaupol 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
# Gaupol. If not, see <http://www.gnu.org/licenses/>.
"""Managing regular expression substitutions for subtitle texts."""
import aeidon
import os
import re
import xml.etree.ElementTree as ET
__all__ = ("PatternManager",)
class PatternManager(object, metaclass=aeidon.Contractual):
"""
Managing regular expression substitutions for subtitle texts.
:ivar _patterns: Dictionary mapping codes to pattern lists
:ivar pattern_type: String to indentify what the pattern matches
:attr:`pattern_type` should be a string with value "line-break",
"common-error", "capitalization" or "hearing-impaired". Codes are of form
``Script[-language-[COUNTRY]]`` using the corresponding ISO codes.
"""
_re_comment = re.compile(r"^\s*#.*$")
def __init___require(self, pattern_type):
assert pattern_type in ("capitalization",
"common-error",
"hearing-impaired",
"line-break")
def __init__(self, pattern_type):
"""Initialize a :class:`PatternManager` object."""
self._patterns = {}
self.pattern_type = pattern_type
self._read_patterns()
def _assert_identifiers(self, script, language, country):
"""Assert that codes are valid and parents are defined."""
if script is not None:
assert aeidon.scripts.is_valid(script)
if language is not None:
assert aeidon.scripts.is_valid(script)
assert aeidon.languages.is_valid(language)
if country is not None:
assert aeidon.languages.is_valid(language)
assert aeidon.countries.is_valid(country)
def _filter_patterns(self, patterns):
"""
Return `patterns` with name-clashes resolved.
Patterns with a more specific code replace those with a less specific
code if they have the same name and the more specific pattern's policy
is explicitly set to ``Replace`` (instead of the implicit ``Append``).
Order is maintained so that all patterns with the same name are always
located in the position of the earliest of such patterns.
"""
filtered_patterns = []
for i, pattern in enumerate(patterns):
name = pattern.get_name(False)
policy = pattern.get_field("Policy")
last_index = len(filtered_patterns) - 1
for j, filtered_pattern in enumerate(filtered_patterns):
if filtered_pattern.get_name() == name:
last_index = j
if policy == "Replace":
filtered_patterns[j] = None
filtered_patterns.insert(last_index + 1, pattern)
while None in filtered_patterns:
filtered_patterns.remove(None)
return filtered_patterns
def _get_codes_require(self, script=None, language=None, country=None):
self._assert_identifiers(script, language, country)
def _get_codes(self, script=None, language=None, country=None):
"""
Return a sequence of all codes to be used by arguments.
``Zyyy``, which is always included, is the first code and the most
specific one last.
"""
codes = ["Zyyy"]
if script is not None:
codes.append(script)
if language is not None:
code = "{}-{}".format(script, language)
codes.append(code)
if country is not None:
code = "{}-{}-{}".format(script, language, country)
codes.append(code)
return tuple(codes)
def _read_config_from_directory_require(self, directory, encoding):
assert aeidon.encodings.is_valid_code(encoding)
def _read_config_from_directory(self, directory, encoding):
"""Read configurations from files in `directory`."""
if not os.path.isdir(directory): return
extension = ".{}.conf".format(self.pattern_type)
files = os.listdir(directory)
for name in (x for x in files if x.endswith(extension)):
path = os.path.join(directory, name)
self._read_config_from_file(path, encoding)
def _read_config_from_file_require(self, path, encoding):
assert aeidon.encodings.is_valid_code(encoding)
def _read_config_from_file(self, path, encoding):
"""Read configurations from file at `path`."""
if not os.path.isfile(path): return
basename = os.path.basename(path)
extension = ".{}.conf".format(self.pattern_type)
code = basename.replace(extension, "")
if not code in self._patterns: return
patterns = self._patterns[code]
for element in ET.parse(path).findall("pattern"):
name = element.get("name")
name = name.replace(""", '"')
name = name.replace("&", "&")
enabled = (element.get("enabled") == "true")
for pattern in patterns:
if pattern.get_name(localize=False) == name:
pattern.enabled = enabled
def _read_patterns(self):
"""Read all patterns of :attr:`pattern_type` from files."""
data_dir = os.path.join(aeidon.DATA_DIR, "patterns")
data_home_dir = os.path.join(aeidon.DATA_HOME_DIR, "patterns")
config_home_dir = os.path.join(aeidon.CONFIG_HOME_DIR, "patterns")
encoding = aeidon.util.get_default_encoding()
self._read_patterns_from_directory(data_dir, "utf_8")
self._read_patterns_from_directory(data_home_dir, encoding)
self._read_config_from_directory(data_dir, "utf_8")
self._read_config_from_directory(config_home_dir, encoding)
def _read_patterns_from_directory_require(self, directory, encoding):
assert aeidon.encodings.is_valid_code(encoding)
def _read_patterns_from_directory(self, directory, encoding):
"""Read all patterns from files in `directory`."""
if not os.path.isdir(directory): return
extension = ".{}".format(self.pattern_type)
extensions = (extension, "{}.in".format(extension))
files = [x for x in os.listdir(directory)
if x.endswith(extensions)]
for name in [x for x in files if x.endswith(".in")]:
# If both untranslated and translated pattern files are found,
# load patterns only from the translated one.
if name[:-3] in files:
files.remove(name)
for name in files:
path = os.path.join(directory, name)
self._read_patterns_from_file(path, encoding)
def _read_patterns_from_file_require(self, directory, encoding):
assert aeidon.encodings.is_valid_code(encoding)
def _read_patterns_from_file(self, path, encoding):
"""Read all patterns from file at `path`."""
if not os.path.isfile(path): return
basename = os.path.basename(path)
extension = ".{}".format(self.pattern_type)
if basename.endswith(".in"):
extension = ".{}.in".format(self.pattern_type)
code = basename.replace(extension, "")
local = path.startswith(aeidon.DATA_HOME_DIR)
patterns = self._patterns.setdefault(code, [])
lines = aeidon.util.readlines(path, encoding)
lines = [self._re_comment.sub("", x) for x in lines]
lines = [x.strip() for x in lines]
for line in (x for x in lines if x):
if line.startswith("["): # [HEADER]
patterns.append(aeidon.Pattern())
patterns[-1].local = local
else: # [_]KEY=VALUE
name, value = line.split("=", 1)
name = (name[1:] if name.startswith("_") else name)
patterns[-1].set_field(name, value)
def _write_config_to_file(self, code, encoding):
"""Write configurations of all patterns to file."""
local_dir = os.path.join(aeidon.CONFIG_HOME_DIR, "patterns")
if not os.path.isdir(local_dir): return
basename = "{}.{}.conf".format(code, self.pattern_type)
path = os.path.join(local_dir, basename)
text = '<?xml version="1.0" encoding="utf-8"?>'
text += '{}<patterns>{}'.format(os.linesep, os.linesep)
written_names = set()
for pattern in self._patterns[code]:
name = pattern.get_name(False)
if name in written_names: continue
written_names.add(name)
name = name.replace("&", "&")
name = name.replace('"', """)
enabled = ("true" if pattern.enabled else "false")
text += ' <pattern name="{}" '.format(name)
text += 'enabled="{}"/>'.format(enabled)
text += os.linesep
text += "</patterns>{}".format(os.linesep)
aeidon.util.write(path, text, encoding)
def get_countries(self, script, language):
"""Return a sequence of countries for which patterns exist."""
codes = list(self._patterns.keys())
start = "{}-{}-".format(script, language)
codes = [x for x in codes if x.startswith(start)]
countries = [x.split("-")[2] for x in codes]
return tuple(aeidon.util.get_unique(countries))
def get_languages(self, script):
"""Return a sequence of languages for which patterns exist."""
codes = list(self._patterns.keys())
start = "{}-".format(script)
codes = [x for x in codes if x.startswith(start)]
languages = [x.split("-")[1] for x in codes]
return tuple(aeidon.util.get_unique(languages))
def get_patterns_require(self, script=None, language=None, country=None):
self._assert_identifiers(script, language, country)
def get_patterns(self, script=None, language=None, country=None):
"""Return patterns for `script`, `language` and `country`."""
patterns = []
for code in self._get_codes(script, language, country):
for pattern in self._patterns.get(code, []):
patterns.append(pattern)
patterns = self._filter_patterns(patterns)
return patterns
def get_scripts(self):
"""Return a sequence of scripts for which patterns exist."""
codes = list(self._patterns.keys())
while "Zyyy" in codes:
codes.remove("Zyyy")
scripts = [x.split("-")[0] for x in codes]
return tuple(aeidon.util.get_unique(scripts))
def save_config_require(self, script=None, language=None, country=None):
self._assert_identifiers(script, language, country)
def save_config(self, script=None, language=None, country=None):
"""Save pattern configurations to files."""
local_dir = os.path.join(aeidon.CONFIG_HOME_DIR, "patterns")
aeidon.deco.silent(OSError)(aeidon.util.makedirs)(local_dir)
codes = self._get_codes(script, language, country)
for code in (x for x in codes if x in self._patterns):
self._write_config_to_file(code, "utf_8")
|