-
-
Notifications
You must be signed in to change notification settings - Fork 34
/
dictionary.rs
521 lines (467 loc) · 18.9 KB
/
dictionary.rs
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
/*
* Copyright (c) 2021-2023 Works Applications Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use pyo3::prelude::*;
use pyo3::types::{PySet, PyString, PyTuple};
use std::convert::TryFrom;
use std::fmt::Write;
use std::ops::Deref;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use std::sync::Arc;
use sudachi::analysis::Mode;
use crate::errors::{wrap, wrap_ctx, SudachiError as SudachiErr};
use sudachi::analysis::stateless_tokenizer::DictionaryAccess;
use sudachi::config::{Config, ConfigBuilder, SurfaceProjection};
use sudachi::dic::dictionary::JapaneseDictionary;
use sudachi::dic::grammar::Grammar;
use sudachi::dic::lexicon_set::LexiconSet;
use sudachi::dic::subset::InfoSubset;
use sudachi::plugin::input_text::InputTextPlugin;
use sudachi::plugin::oov::OovProviderPlugin;
use sudachi::plugin::path_rewrite::PathRewritePlugin;
use crate::morpheme::{PyMorphemeListWrapper, PyProjector};
use crate::pos_matcher::PyPosMatcher;
use crate::pretokenizer::PyPretokenizer;
use crate::projection::{morpheme_projection, parse_projection_opt, resolve_projection};
use crate::tokenizer::{PySplitMode, PyTokenizer};
pub(crate) struct PyDicData {
pub(crate) dictionary: JapaneseDictionary,
pub(crate) pos: Vec<Py<PyTuple>>,
/// Compute default string representation for a morpheme using vtable dispatch.
/// None by default (if outputting surface as it is)
/// This is default per-dictionary value, can be overriden when creating tokenizers and pre-tokenizers
pub(crate) projection: PyProjector,
}
impl DictionaryAccess for PyDicData {
fn grammar(&self) -> &Grammar<'_> {
self.dictionary.grammar()
}
fn lexicon(&self) -> &LexiconSet<'_> {
self.dictionary.lexicon()
}
fn input_text_plugins(&self) -> &[Box<dyn InputTextPlugin + Sync + Send>] {
self.dictionary.input_text_plugins()
}
fn oov_provider_plugins(&self) -> &[Box<dyn OovProviderPlugin + Sync + Send>] {
self.dictionary.oov_provider_plugins()
}
fn path_rewrite_plugins(&self) -> &[Box<dyn PathRewritePlugin + Sync + Send>] {
self.dictionary.path_rewrite_plugins()
}
}
impl PyDicData {
pub fn pos_of(&self, pos_id: u16) -> &Py<PyTuple> {
&self.pos[pos_id as usize]
}
}
/// A sudachi dictionary
#[pyclass(module = "sudachipy.dictionary", name = "Dictionary")]
#[derive(Clone)]
pub struct PyDictionary {
pub(super) dictionary: Option<Arc<PyDicData>>,
pub config: Config,
}
#[pymethods]
impl PyDictionary {
/// Creates a sudachi dictionary.
///
/// If both config.systemDict and dict_type are not given, `sudachidict_core` is used.
/// If both config.systemDict and dict_type are given, dict_type is used.
/// If dict is an absolute path to a file, it is used as a dictionary
///
/// :param config_path: path to the configuration JSON file
/// :param resource_dir: path to the resource directory folder
/// :param dict: type of pre-packaged dictionary, referring to sudachidict_<dict_type> packages on PyPI: https://pypi.org/search/?q=sudachidict.
/// Also, can be an _absolute_ path to a compiled dictionary file.
/// :param dict_type: deprecated alias to dict
#[new]
#[pyo3(signature=(config_path = None, resource_dir = None, dict = None, dict_type = None, *, config = None))]
fn new(
py: Python,
config_path: Option<&PyAny>,
resource_dir: Option<PathBuf>,
dict: Option<&str>,
dict_type: Option<&str>,
config: Option<&PyAny>,
) -> PyResult<Self> {
if config.is_some() && config_path.is_some() {
return Err(SudachiErr::new_err("Both config and config_path options were specified at the same time, use one of them"));
}
let default_config = read_default_config(py)?;
let config_builder = match config.or(config_path) {
None => default_config,
Some(v) => read_config(v)?.fallback(&default_config),
};
let resource_dir = match resource_dir {
None => Some(get_default_resource_dir(py)?),
Some(v) => Some(v),
};
let dict_path = match dict.or(dict_type) {
None => None,
Some(dt) => Some(locate_system_dict(py, Path::new(dt))?),
};
if dict_type.is_some() {
let cat = PyModule::import(py, "builtins")?.getattr("DeprecationWarning")?;
PyErr::warn(
py,
cat,
"Parameter dict_type of Dictionary() is deprecated, use dict instead",
1,
)?;
}
let config_builder = match resource_dir {
Some(p) => config_builder.resource_path(p),
None => config_builder,
};
let config_builder = match dict_path {
Some(p) => config_builder.system_dict(p),
None => config_builder,
};
let mut config = config_builder.build();
// Load a dictionary from `sudachidict_core` as the default one.
// For this behavior, the value of `systemDict` key in the default setting file must be
// empty (or no `systemDict` key), different from rust's one.
if config.system_dict.is_none() || config.system_dict.as_ref().unwrap().is_dir() {
let system_dict = find_dict_path(py, "core")?;
assert!(
system_dict.exists(),
"system dictionary {} did not exist",
system_dict.display()
);
config.system_dict = Some(system_dict);
} else {
// resolve system dictionary alias to full path
let system_dict = config.system_dict.as_deref().unwrap();
if let Some(kind @ ("small" | "core" | "full")) = system_dict.to_str() {
let system_dict = find_dict_path(py, kind)?;
assert!(
system_dict.exists(),
"system dictionary {} did not exist",
system_dict.display()
);
config.system_dict = Some(system_dict)
}
}
let jdic = JapaneseDictionary::from_cfg(&config).map_err(|e| {
SudachiErr::new_err(format!(
"Error while constructing dictionary: {}",
e.to_string()
))
})?;
let pos_data = jdic
.grammar()
.pos_list
.iter()
.map(|pos| {
let tuple: Py<PyTuple> = PyTuple::new(py, pos).into_py(py);
tuple
})
.collect();
let projection = if config.projection == SurfaceProjection::Surface {
None
} else {
Some(morpheme_projection(config.projection, &jdic))
};
let dic_data = PyDicData {
dictionary: jdic,
pos: pos_data,
projection,
};
let dictionary = Arc::new(dic_data);
Ok(Self {
config,
dictionary: Some(dictionary),
})
}
/// Creates a sudachi tokenizer.
///
/// :param mode: tokenizer's default split mode (C by default).
/// :param fields: load only a subset of fields.
/// See https://worksapplications.github.io/sudachi.rs/python/topics/subsetting.html
#[pyo3(
text_signature = "($self, mode = 'C') -> sudachipy.Tokenizer",
signature = (mode = None, fields = None, *, projection = None)
)]
fn create<'py>(
&'py self,
py: Python<'py>,
mode: Option<&'py PyAny>,
fields: Option<&'py PySet>,
projection: Option<&'py PyString>,
) -> PyResult<PyTokenizer> {
let mode = match mode {
Some(m) => extract_mode(py, m)?,
None => Mode::C,
};
let fields = parse_field_subset(fields)?;
let mut required_fields = self.config.projection.required_subset();
let dict = self.dictionary.as_ref().unwrap().clone();
let projobj = if let Some(s) = projection {
let proj = wrap(SurfaceProjection::try_from(s.to_str()?))?;
required_fields = proj.required_subset();
Some(morpheme_projection(proj, &dict))
} else {
None
};
let projobj = resolve_projection(projobj, &dict.projection);
let tok = PyTokenizer::new(dict, mode, fields | required_fields, projobj);
Ok(tok)
}
/// Creates a POS matcher object
///
/// If target is a function, then it must return whether a POS should match or not.
/// If target a list, it should contain partially specified POS.
/// By partially specified it means that it is possible to omit POS fields or
/// use None as a sentinel value that matches any POS.
///
/// For example, ('名詞',) will match any noun and
/// (None, None, None, None, None, '終止形‐一般') will match any word in 終止形‐一般 conjugation form.
///
/// :param target: can be either a callable or list of POS partial tuples
#[pyo3(text_signature = "($self, target)")]
fn pos_matcher<'py>(&'py self, py: Python<'py>, target: &PyAny) -> PyResult<PyPosMatcher> {
PyPosMatcher::create(py, self.dictionary.as_ref().unwrap(), target)
}
/// Creates HuggingFace Tokenizers-compatible PreTokenizer.
/// Requires package `tokenizers` to be installed.
///
/// :param mode: Use this split mode (C by default)
/// :param fields: ask Sudachi to load only a subset of fields.
/// See https://worksapplications.github.io/sudachi.rs/python/topics/subsetting.html
/// :param handler: a custom callable to transform MorphemeList into list of tokens.
/// It should be should be a `function(index: int, original: NormalizedString, morphemes: MorphemeList) -> List[NormalizedString]`.
/// See https://github.com/huggingface/tokenizers/blob/master/bindings/python/examples/custom_components.py
/// If nothing was passed, simply use surface as token representations.
/// :param projection: projection mode for a created PreTokenizer.
/// See :class:`sudachipy.config.Config` object documentation for supported projections.
///
/// :type mode: sudachipy.SplitMode
/// :type fields: Set[str]
#[pyo3(
text_signature = "($self, mode, fields, handler) -> tokenizers.PreTokenizer",
signature = (mode = None, fields = None, handler = None, *, projection = None)
)]
fn pre_tokenizer<'p>(
&'p self,
py: Python<'p>,
mode: Option<&PyAny>,
fields: Option<&PySet>,
handler: Option<Py<PyAny>>,
projection: Option<&PyString>,
) -> PyResult<&'p PyAny> {
let mode = match mode {
Some(m) => extract_mode(py, m)?,
None => Mode::C,
};
let subset = parse_field_subset(fields)?;
if let Some(h) = handler.as_ref() {
if !h.as_ref(py).is_callable() {
return Err(SudachiErr::new_err("handler must be callable"));
}
}
let dict = self.dictionary.as_ref().unwrap().clone();
let mut required_fields = if handler.is_none() {
self.config.projection.required_subset()
} else {
self.config.projection.required_subset() | subset
};
let (passed, projection) = parse_projection_opt(projection, dict.deref())?;
required_fields |= projection.required_subset();
let projector = resolve_projection(passed, &dict.projection);
let internal = PyPretokenizer::new(dict, mode, required_fields, handler, projector);
let internal_cell = PyCell::new(py, internal)?;
let module = py.import("tokenizers.pre_tokenizers")?;
module
.getattr("PreTokenizer")?
.getattr("custom")?
.call1(PyTuple::new(py, [internal_cell]))
}
/// Look up morphemes in the binary dictionary without performing the analysis.
///
/// All morphemes from the dictionary with the given surface string are returned,
/// with the last user dictionary searched first and the system dictionary searched last.
/// Inside a dictionary, morphemes are outputted in-binary-dictionary order.
/// Morphemes which are not indexed are not returned.
///
/// :param surface: find all morphemes with the given surface
/// :param out: if passed, reuse the given morpheme list instead of creating a new one.
/// See https://worksapplications.github.io/sudachi.rs/python/topics/out_param.html for details.
/// :type surface: str
/// :type out: sudachipy.MorphemeList
#[pyo3(text_signature = "($self, surface, out = None) -> sudachipy.MorphemeList")]
fn lookup<'p>(
&'p self,
py: Python<'p>,
surface: &'p str,
out: Option<&'p PyCell<PyMorphemeListWrapper>>,
) -> PyResult<&'p PyCell<PyMorphemeListWrapper>> {
let l = match out {
Some(l) => l,
None => PyCell::new(
py,
PyMorphemeListWrapper::new(self.dictionary.clone().unwrap()),
)?,
};
// this needs to be a variable
let mut borrow = l.try_borrow_mut();
let out_list = match borrow {
Err(_) => return Err(SudachiErr::new_err("out was used twice at the same time")),
Ok(ref mut ms) => ms.internal_mut(py),
};
out_list.clear();
wrap_ctx(out_list.lookup(surface, InfoSubset::all()), surface)?;
Ok(l)
}
/// Close this dictionary
#[pyo3(text_signature = "($self)")]
fn close(&mut self) {
self.dictionary = None;
}
/// Get POS Tuple by its id
#[pyo3(text_signature = "($self, pos_id: int)")]
fn pos_of<'p>(&'p self, py: Python<'p>, pos_id: usize) -> Option<&'p PyTuple> {
let dic = self.dictionary.as_ref().unwrap();
dic.pos.get(pos_id).map(|x| x.as_ref(py))
}
fn __repr__(&self) -> PyResult<String> {
wrap(config_repr(&self.config))
}
}
fn config_repr(cfg: &Config) -> Result<String, std::fmt::Error> {
let mut result = String::from("<SudachiDictionary(");
match cfg.resolved_system_dict() {
Ok(path) => write!(result, "system={}", path.display()),
Err(e) => write!(result, "system=<err:{}>", e),
}?;
write!(result, ", user=[")?;
match cfg.resolved_user_dicts() {
Ok(dicts) => {
for (i, dic) in dicts.iter().enumerate() {
write!(result, "{}", dic.display())?;
if i + 1 == dicts.len() {
write!(result, "]")?;
} else {
write!(result, ", ")?;
}
}
}
Err(e) => {
write!(result, "<err:{:?}>", e)?;
}
}
write!(result, ")>")?;
Ok(result)
}
pub(crate) fn extract_mode<'py>(py: Python<'py>, mode: &'py PyAny) -> PyResult<Mode> {
if mode.is_instance_of::<PyString>() {
let mode = mode.str()?.to_str()?;
Mode::from_str(mode).map_err(|e| SudachiErr::new_err(e).into())
} else if mode.is_instance_of::<PySplitMode>() {
let mode = mode.extract::<PySplitMode>()?;
Ok(Mode::from(mode))
} else {
Err(SudachiErr::new_err(("unknown mode", mode.into_py(py))))
}
}
fn read_config_from_fs(path: Option<&Path>) -> PyResult<ConfigBuilder> {
wrap(ConfigBuilder::from_opt_file(path))
}
fn read_config(config_opt: &PyAny) -> PyResult<ConfigBuilder> {
if config_opt.is_instance_of::<PyString>() {
let config_str = config_opt.str()?.to_str()?.trim();
// looks like json
if config_str.starts_with("{") && config_str.ends_with("}") {
let result = ConfigBuilder::from_bytes(config_str.as_bytes());
return wrap(result);
}
let p = Path::new(config_str);
if p.exists() && p.is_file() {
return read_config_from_fs(Some(p));
}
return Err(SudachiErr::new_err(format!(
"config file [{}] do not exist or is not a file",
p.display()
)));
}
let py = config_opt.py();
let cfg_type = py.import("sudachipy.config")?.getattr("Config")?;
if config_opt.is_instance(cfg_type)? {
let cfg_as_str = config_opt.call_method0("as_jsons")?;
return read_config(cfg_as_str);
}
Err(SudachiErr::new_err((
format!("passed config was not a string, json object or sudachipy.config.Config object"),
config_opt.into_py(py),
)))
}
pub(crate) fn read_default_config(py: Python) -> PyResult<ConfigBuilder> {
let path = PyModule::import(py, "sudachipy")?.getattr("_DEFAULT_SETTINGFILE")?;
let path = path.downcast::<PyString>()?.to_str()?;
let path = PathBuf::from(path);
wrap_ctx(ConfigBuilder::from_opt_file(Some(&path)), &path)
}
pub(crate) fn get_default_resource_dir(py: Python) -> PyResult<PathBuf> {
let path = PyModule::import(py, "sudachipy")?.getattr("_DEFAULT_RESOURCEDIR")?;
let path = path.downcast::<PyString>()?.to_str()?;
Ok(PathBuf::from(path))
}
fn find_dict_path(py: Python, dict_type: &str) -> PyResult<PathBuf> {
let pyfunc = PyModule::import(py, "sudachipy")?.getattr("_find_dict_path")?;
let path = pyfunc
.call1((dict_type,))?
.downcast::<PyString>()?
.to_str()?;
Ok(PathBuf::from(path))
}
fn locate_system_dict(py: Python, path: &Path) -> PyResult<PathBuf> {
if path.exists() && path.is_file() {
return Ok(path.to_owned());
}
match path.to_str() {
Some(name @ ("small" | "core" | "full")) => find_dict_path(py, name),
_ => Err(SudachiErr::new_err(format!(
"invalid dictionary path {:?}",
path
))),
}
}
fn parse_field_subset(data: Option<&PySet>) -> PyResult<InfoSubset> {
if data.is_none() {
return Ok(InfoSubset::all());
}
let mut subset = InfoSubset::empty();
for el in data.unwrap().iter() {
let s = el.str()?.to_str()?;
subset |= match s {
"surface" => InfoSubset::SURFACE,
"pos" | "pos_id" => InfoSubset::POS_ID,
"normalized_form" => InfoSubset::NORMALIZED_FORM,
"dictionary_form" => InfoSubset::DIC_FORM_WORD_ID,
"reading_form" => InfoSubset::READING_FORM,
"word_structure" => InfoSubset::WORD_STRUCTURE,
"split_a" => InfoSubset::SPLIT_A,
"split_b" => InfoSubset::SPLIT_B,
"synonym_group_id" => InfoSubset::SYNONYM_GROUP_ID,
x => {
return Err(SudachiErr::new_err(format!(
"Invalid WordInfo field name {}",
x
)))
}
};
}
Ok(subset)
}