esca 0.3.0

A chess model that answers what is true about a position: variants, positions, games, and move text.
Documentation 
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

//! The bundled ECO catalogue.

use pyo3::prelude::*;

use crate::openings::{self, Opening};

use super::board::PyPosition;

/// An ECO code and the name that goes with it.
#[pyclass(
    frozen,
    eq,
    hash,
    from_py_object,
    module = "esca.openings",
    name = "Opening"
)]
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub struct PyOpening {
    inner: Opening,
}

impl PyOpening {
    pub(crate) fn new(inner: Opening) -> PyOpening {
        PyOpening { inner }
    }
}

#[pymethods]
impl PyOpening {
    /// The ECO classification: a volume letter A to E and two digits.
    #[getter]
    fn eco(&self) -> &'static str {
        self.inner.eco
    }

    /// The name, in English.
    #[getter]
    fn name(&self) -> &'static str {
        self.inner.name
    }

    fn __str__(&self) -> String {
        self.inner.to_string()
    }

    fn __repr__(&self) -> String {
        format!("<Opening {}>", self.inner)
    }
}

/// The opening `position` is named after, if it has a name.
#[pyfunction]
pub(crate) fn openings_lookup(position: &PyPosition) -> Option<PyOpening> {
    openings::lookup(&position.inner).map(PyOpening::new)
}

/// How many named positions the catalogue holds.
#[pyfunction]
pub(crate) fn openings_count() -> usize {
    openings::count()
}

pub(crate) fn register(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add_class::<PyOpening>()?;
    module.add_function(wrap_pyfunction!(openings_lookup, module)?)?;
    module.add_function(wrap_pyfunction!(openings_count, module)?)?;
    Ok(())
}