Merge pull request #20 from unmade/boards

Rename `entities` -> `boards`

Author: unmade

README.rst

@@ -66,7 +66,7 @@ For example to see all techniques that sudoku has:
 .. code-block:: python
 
     from dokusan import solvers
-    from dokusan.entities import BoxSize, Sudoku
+    from dokusan.boards import BoxSize, Sudoku
 
 
     sudoku = Sudoku.from_list(
@@ -95,7 +95,7 @@ however slightly modified to work fast
 .. code-block:: python
 
     from dokusan import solvers, renderers
-    from dokusan.entities import BoxSize, Sudoku
+    from dokusan.boards import BoxSize, Sudoku
 
 
     sudoku = Sudoku.from_list(

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dokusan"
-version = "0.1.0-alpha.5"
+version = "0.1.0-alpha.6"
 description = "Sudoku generator and solver with a step-by-step guidance"
 keywords = ["sudoku", "sudoku-solver", "sudoku-generator", "solver", "generator"]
 readme = "README.rst"
@@ -29,6 +29,8 @@ pre-commit = "^1.20"
 line_length = 88
 multi_line_output = 3
 include_trailing_comma = true
+known_first_party = ["dokusan"]
+default_section = "THIRDPARTY"
 
 [build-system]
 requires = ["poetry>=0.12"]

src/dokusan/entities.py src/dokusan/boards.py

@@ -2,7 +2,7 @@
 from typing import List
 
 from dokusan import exceptions, solvers, stats
-from dokusan.entities import BoxSize, Cell, Position, Sudoku
+from dokusan.boards import BoxSize, Cell, Position, Sudoku
 
 MAX_ITERATIONS = 300
 
@@ -37,10 +37,10 @@ def _random_initial_cells(box_size: BoxSize) -> List[Cell]:
         for i in range(box_size.width)
     ]
 
-    while True:
+    while True:  # pragma: no branch
         row_values = random.sample(all_values - set(box_values[0]), k=box_size.length)
         used_values = [sorted(box_values[i]) for i in range(1, box_size.width)]
-        if sorted(row_values) not in used_values:  # pragma: no cover
+        if sorted(row_values) not in used_values:
             break
 
     row_values += random.sample(

src/dokusan/generators.py

@@ -1,7 +1,7 @@
 from enum import Enum
 from typing import List, NamedTuple, Protocol
 
-from dokusan.entities import BoxSize, Cell, Sudoku
+from dokusan.boards import BoxSize, Cell, Sudoku
 
 
 class Color(Protocol):

src/dokusan/renderers.py

@@ -2,7 +2,7 @@
 from typing import Iterator
 
 from dokusan import exceptions, techniques
-from dokusan.entities import Cell, Sudoku
+from dokusan.boards import Cell, Sudoku
 from dokusan.techniques import Step
 
 

src/dokusan/solvers.py

@@ -1,7 +1,7 @@
 import operator
 
 from dokusan import exceptions, solvers
-from dokusan.entities import Cell, Sudoku
+from dokusan.boards import Cell, Sudoku
 
 
 def rank(sudoku: Sudoku) -> int:

src/dokusan/stats.py

@@ -6,7 +6,7 @@
 from dataclasses import dataclass
 from typing import Dict, Iterable, Iterator, List, Optional, Set, Tuple
 
-from dokusan.entities import Cell, Sudoku
+from dokusan.boards import Cell, Sudoku
 
 
 class NotFound(Exception):

src/dokusan/techniques.py

@@ -1,7 +1,8 @@
 import operator
 
 import pytest
-from dokusan.entities import BoxSize, Cell, Position, Sudoku
+
+from dokusan.boards import BoxSize, Cell, Position, Sudoku
 
 
 @pytest.fixture

tests/test_entities.py tests/test_boards.py

@@ -1,6 +1,7 @@
 import pytest
+
 from dokusan import generators
-from dokusan.entities import BoxSize, Sudoku
+from dokusan.boards import BoxSize, Sudoku
 
 
 @pytest.mark.slow

tests/test_generators.py

@@ -1,5 +1,5 @@
 from dokusan import renderers, techniques
-from dokusan.entities import BoxSize, Sudoku
+from dokusan.boards import BoxSize, Sudoku
 
 
 def test_plain():

tests/test_renderers.py

@@ -1,6 +1,7 @@
 import pytest
+
 from dokusan import exceptions, solvers
-from dokusan.entities import BoxSize, Sudoku
+from dokusan.boards import BoxSize, Sudoku
 
 
 def test_eliminate():

tests/test_solvers.py

@@ -1,6 +1,7 @@
 import pytest
+
 from dokusan import exceptions, stats
-from dokusan.entities import BoxSize, Sudoku
+from dokusan.boards import BoxSize, Sudoku
 
 
 @pytest.mark.parametrize(

tests/test_stats.py

@@ -2,8 +2,9 @@
 from typing import List
 
 import pytest
+
 from dokusan import techniques
-from dokusan.entities import BoxSize, Cell, Position, Sudoku
+from dokusan.boards import BoxSize, Cell, Position, Sudoku
 
 
 def make_sudoku_with_marks(puzzle: List[List[int]], box_size: BoxSize) -> Sudoku: