Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hbldh/dlxsudoku
Sudoku Solver written in pure Python with no dependencies
https://github.com/hbldh/dlxsudoku
dancing-links pypi sudoku sudoku-solver
Last synced: 23 days ago
JSON representation
Sudoku Solver written in pure Python with no dependencies
- Host: GitHub
- URL: https://github.com/hbldh/dlxsudoku
- Owner: hbldh
- License: gpl-2.0
- Created: 2015-09-29T21:50:57.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T14:21:39.000Z (about 4 years ago)
- Last Synced: 2024-08-08T16:33:06.359Z (3 months ago)
- Topics: dancing-links, pypi, sudoku, sudoku-solver
- Language: Python
- Homepage:
- Size: 71.3 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DLXSudoku
[](https://pypi.python.org/pypi/dlxsudoku)
[](https://pypi.python.org/pypi/dlxsudoku)
[](https://coveralls.io/github/hbldh/dlxsudoku?branch=master)
Sudoku Solver written in pure Python with no dependencies.
It solves Sudokus of sizes `N x N` by pure induction as
far as is possible, and then uses an optional
[Dancing Links](https://en.wikipedia.org/wiki/Dancing_Links)
brute force solver, when the basic induction is not enough.
## Installation
Install with pip:
pip install dlxsudoku
## Testing
Tests can be run using `pytest`:
pytest tests/
The tests make a HTTP request to a file containing several
Sudokus on [Project Euler](https://projecteuler.net/project/resources/p096_sudoku.txt).
## Usage
A Sudoku stored in a file can be solved as such:
```python
from dlxsudoku import Sudoku
s = Sudoku.load_file('path/to/sudoku.sud')
s.solve(verbose=True, allow_brute_force=True)
```
Alternatively, if your Sudoku is stored in string variable
it can be solved in the following fashion:
```python
from dlxsudoku import Sudoku
sudoku_string_1 = "030467050920010006067300148301006027400850600090200400005624001203000504040030702"
sudoku_string_2 = "# Example Sudoku\n" + \
"*72****6*\n" + \
"***72*9*4\n" + \
"*9*1****2\n" + \
"*******4*\n" + \
"82*4*71**\n" + \
"**9*6*8**\n" + \
"***9**6**\n" + \
"**3*72*9*\n" + \
"*6*843*7*"
s1 = Sudoku(sudoku_string_1)
s1.solve()
print(s1.to_oneliner())
s2 = Sudoku(sudoku_string_2)
s2.solve()
print(s2)
```
**DLXSudoko treats a Sudoku with multiple solutions as a faulty one
and raises a** ``dlxsudoku.exceptions.SudokuHasMultipleSolutionsError``
**exception in such a situation.**
### Use from terminal
DLXSudoku also installs a console entry point. Can solve Sudokus from string or from path:
```shell
solve-sudoku --sudoku 030467050920010006067300148301006027400850600090200400005624001203000504040030702
```
or
```shell
solve-sudoku --path "path/to/sudoku.sud"
```
### Sudoku formatting
A Sudoku file or string should be structured in the following manner:
# Optional comment or metadata
*72****6*
***72*9*4
*9*1****2
*******4*
82*4*71**
**9*6*8**
***9**6**
**3*72*9*
*6*843*7*
or as a one-liner:
030467050920010006067300148301006027400850600090200400005624001203000504040030702
Any character other than `[1-9]` may be used as a placeholder for unknowns.
## References
The Dancing Links code has been adapted from
[Algorithm X in 30 lines!](http://www.cs.mcgill.ca/~aassaf9/python/algorithm_x.html),
only modified slightly to accommodate class structure and Python 2.6.