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
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

//! The Python extension module, `esca._esca`.
//!
//! Squares, roles, colours and file sets are text on this surface; every
//! side-paired fact is a pair indexed by `esca.US` and `esca.THEM`.

mod board;
mod convert;
mod encode;
mod explain;
mod facts;
#[cfg(feature = "lichess")]
mod lichess;
#[cfg(feature = "openings")]
mod openings;
#[cfg(feature = "pgn")]
mod pgn;
#[cfg(feature = "polyglot")]
mod polyglot;
#[cfg(feature = "uci")]
mod uci;

use pyo3::prelude::*;

use crate::facts::MoveFacts;
use crate::schema::Schema;
use crate::variant::{chess960, classic};

use board::PyVariant;
use encode::{PyMoveSchema, PySchema};

/// Classic chess, the default wherever a variant is optional.
fn default_variant() -> PyVariant {
    PyVariant::new(classic())
}

/// The v1 schema, the default wherever a schema is optional.
fn default_schema() -> PySchema {
    PySchema::new(Schema::v1())
}

fn default_move_schema() -> PyMoveSchema {
    PyMoveSchema::new(Schema::v1().moves())
}

#[pymodule]
#[pyo3(name = "_esca")]
fn esca_module(module: &Bound<'_, PyModule>) -> PyResult<()> {
    module.add_class::<board::PyVariant>()?;
    module.add_class::<board::PySquareSet>()?;
    module.add_class::<board::PyMove>()?;
    module.add_class::<board::PyPosition>()?;
    module.add_class::<board::PyGame>()?;
    module.add_class::<explain::PyCastling>()?;
    module.add_class::<explain::PyEnPassant>()?;
    module.add_class::<explain::PyEpCapture>()?;
    module.add_class::<explain::PyEpObstacle>()?;
    module.add_class::<explain::PyPin>()?;
    module.add_class::<explain::PySkewer>()?;
    module.add_class::<explain::PyRepetition>()?;
    module.add_class::<explain::PyNearMiss>()?;
    module.add_class::<explain::PyFiftyMove>()?;
    module.add_class::<explain::PyReset>()?;
    module.add_class::<explain::PyDrawStatus>()?;
    module.add_class::<explain::PyAutomaticDraw>()?;
    module.add_class::<explain::PyClaimableDraw>()?;
    module.add_class::<explain::PyStalemateDetail>()?;
    module.add_class::<explain::PyStuck>()?;
    module.add_class::<encode::PySchema>()?;
    module.add_class::<encode::PyMoveSchema>()?;
    module.add_class::<facts::PyFacts>()?;
    module.add_class::<facts::PyPlacementFacts>()?;
    module.add_class::<facts::PyStateFacts>()?;
    module.add_class::<facts::PyHistoryFacts>()?;
    module.add_class::<facts::PyMaterialFacts>()?;
    module.add_class::<facts::PyPawnFacts>()?;
    module.add_class::<facts::PyPieceFacts>()?;
    module.add_class::<facts::PyKingFacts>()?;
    module.add_class::<facts::PyMobilityFacts>()?;
    module.add_class::<facts::PyAttackFacts>()?;
    module.add_class::<facts::PyExchangeFacts>()?;
    module.add_class::<facts::PyThreatFacts>()?;
    module.add_class::<facts::PyTacticsFacts>()?;
    module.add_class::<facts::PyEndgameFacts>()?;
    module.add_class::<facts::PyPlaneFacts>()?;
    module.add_class::<facts::PyMoveFacts>()?;
    module.add_class::<facts::PyAnnotatedMove>()?;

    module.add_function(wrap_pyfunction!(encode::encode, module)?)?;
    module.add_function(wrap_pyfunction!(encode::encode_into, module)?)?;
    module.add_function(wrap_pyfunction!(encode::encode_moves, module)?)?;
    module.add_function(wrap_pyfunction!(encode::features_for, module)?)?;
    module.add_function(wrap_pyfunction!(encode::schema, module)?)?;
    module.add_function(wrap_pyfunction!(facts::facts_group, module)?)?;

    #[cfg(feature = "lichess")]
    {
        module.add_class::<lichess::PyBatch>()?;
        module.add_class::<lichess::PyBatches>()?;
        module.add_function(wrap_pyfunction!(lichess::batches, module)?)?;
    }

    #[cfg(feature = "pgn")]
    {
        module.add_class::<pgn::PyPgnGame>()?;
        module.add_class::<pgn::PyPgnNode>()?;
        module.add_class::<pgn::PyPgnReader>()?;
        module.add_function(wrap_pyfunction!(pgn::pgn_read, module)?)?;
        module.add_function(wrap_pyfunction!(pgn::pgn_read_string, module)?)?;
        module.add_function(wrap_pyfunction!(pgn::pgn_count, module)?)?;
    }

    #[cfg(feature = "polyglot")]
    polyglot::register(module)?;

    #[cfg(feature = "openings")]
    openings::register(module)?;

    #[cfg(feature = "uci")]
    uci::register(module)?;

    module.add("CLASSIC", PyVariant::new(classic()))?;
    module.add("CHESS960", PyVariant::new(chess960()))?;
    module.add("US", 0usize)?;
    module.add("THEM", 1usize)?;
    module.add("KING_TO_ROOK", "king_to_rook")?;
    module.add("KING_TWO_SQUARES", "king_two_squares")?;
    module.add("SCHEMA_V1", default_schema())?;
    module.add("SCHEMA", default_schema())?;
    module.add("SCHEMA_ID", Schema::v1().id().to_string())?;
    module.add("WIDTH", Schema::v1().width())?;
    module.add("MOVE_WIDTH", MoveFacts::WIDTH)?;
    module.add("MOVE_SCHEMA", default_move_schema())?;
    module.add("__version__", env!("CARGO_PKG_VERSION"))?;
    Ok(())
}