Words & Crosses

Word Indexing

Words in blacksquare are addressed using (Direction, number) tuples:

from blacksquare import Crossword, ACROSS, DOWN

xw = Crossword(15)

# Set 1-Across to 'HELLO'
xw[ACROSS, 1] = "HELLO"

# Access the Word object
w = xw[ACROSS, 1]
print(w.value)  # 'HELLO'
print(len(w))  # 5

---

Rebus Words and Automatic Interpretation

When a word contains a Rebus cell: 1. w.value and repr(w) automatically render the rebus in parentheses, e.g. "AB(FOO)CD". 2. Setting a word value via plain strings (e.g. xw[ACROSS, 1] = "ABFOOCD") or parenthesized strings (e.g. xw[ACROSS, 1] = "AB(FOO)CD") automatically matches and interprets rebus cells.

from blacksquare import Crossword, ACROSS, Rebus

xw = Crossword(5)

# Method A: Pre-declaring the Rebus cell
xw[0, 2] = Rebus("FOO")
xw[ACROSS, 1] = "ABFOOCD"
print(xw[ACROSS, 1].value)  # 'AB(FOO)CD'

# Method B: Direct inline parenthesized assignment
xw[ACROSS, 1] = "AB(HEART)CD"
print(xw[0, 2].value)  # Rebus('HEART')

---

Traversing Crosses

Every word slot knows which crossing words intersect each of its letters:

w = xw[ACROSS, 1]
for i, cross in enumerate(w.crosses):
    if cross is not None:
        print(
            f"Letter {i} ('{w.value[i]}') crosses {cross.direction.value} {cross.number}"
        )

---

Assigning Clues

Clues can be attached directly to word objects or viewed as a dictionary:

xw[ACROSS, 1].clue = "Greeting"
print(xw.clues)

---

Iterating Over Words and Cells

# Iterate over all open (unfilled) across words
for word in xw.iterwords(direction=ACROSS, only_open=True):
    print(word.index, word.value)

# Iterate over all cells in row-major order
for cell in xw.itercells():
    if cell.is_black():
        pass