python-constraint · fjwillemsen · Aug 30, 2023 · Jun 14, 2023 · Jun 26, 2023 · Jun 27, 2023
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,8 @@
+[run]
+source = constraint
+omit = *tests*, *examples*
+
+[report]
+exclude_lines =
+    if __name__ == .__main__.:
+    pragma: no cover
diff --git a/.github/workflows/build-test-python-package.yml b/.github/workflows/build-test-python-package.yml
@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint for the supported Python versions.
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python.
+
+name: Build & Test
+
+on:
+    push:
+        branches:
+            - main
+            - release/*
+    pull_request:
+        branches:
+            - main
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install .[test]
+            - name: Lint with ruff
+              run: |
+                  # stop the build if there are Python syntax errors or undefined names
+                  ruff --format=github --select=E9,F63,F7,F82 --config=pyproject.toml .
+                  # default set of ruff rules with GitHub Annotations
+                  ruff --format=github --config=pyproject.toml .
+            - name: Test with pytest
+              run: |
+                  pytest
diff --git a/.gitignore b/.gitignore
@@ -58,3 +58,10 @@ target/
 
 # PyCharm / Intellij
 .idea/
+
+### OS Specific ###
+
+# Mac
+.DS_store
+.AppleDouble
+.LSOverride
diff --git a/.travis.yml b/.travis.yml
@@ -1,23 +1,26 @@
 language: python
 python:
-- '2.7'
-- '3.4'
-- '3.5'
-- '3.6'
+    - "3.4"
+    - "3.5"
+    - "3.6"
+    - "3.7"
+    - "3.8"
+    - "3.9"
+    - "3.10"
 install:
-- pip install -qq flake8
-- pip install coveralls --quiet
-- pip install .
+    - pip install -qq flake8
+    - pip install coveralls --quiet
+    - pip install .
 script:
-- nosetests -s -v --with-coverage --cover-package=constraint
-- flake8 --ignore E501,W504 constraint examples tests
+    - nosetests -s -v --with-coverage --cover-package=constraint
+    - flake8 --ignore E501,W504 constraint examples tests
 after_success:
-- coveralls
+    - coveralls
 deploy:
-  provider: pypi
-  user: "scls"
-  password:
-    secure: YP1I8vi04F2mhaexylEK4PoizOMKfPy6ixDGYYLg5WAvgNdHvBN39xFsd9WHavMGg0RcV3xn5jAawQN1dDnXYVNW8LAivwfkUazXjqxAf4IeMp92203kOjQij/D494etHYeIw4SNJgk7J2tDil+goITJ/OhJ4t7fDC0eA0nILn8ifyZZQUgZppW5CoAf1L8cxY1JWICXLKQFQ42zPkFaIA9oBSOgok5wlNoyguScJ70mqUwZewhZHk4L07WSFRbDEOawHe5CAHCPO8rVCkhk2WdLWRoY9uHijDxHn9eCZ3zm4ac/jAwPtFol43q5u9wTCSm8WmeVfU/mJLjgGvmyDhb5Z2fTVbWGsX/N/WHvASr85HfKS0Vq2hAHYozukLbJ8EQZL6ZoOiFhjbL1LJv6Ex3EZ3PTkjKZEGEiLS/aiLZSj95CDMnfKjaNnAN2qFxzR1yi7tFHttS7XiaTCuKoegeN/RNA1iTdFPsXIcmCklhqYr9jCoTaKOXic8W5C1ej3V8oogx1xA79/mf7ZtHxtHWeT9o7cG2EK5gYfvPi6bhKPZDQ2hq49tt8AbcjX4/ycovTmX/cTn0CCoUfLB7Ok9/UvdcdUiflVZEm4cH1WAXAeD3CW+WGTOEHSgNArl9ERxUyomsWhyhutGPmeZIPQ1COeuqFFBTIaHWDG1ytqN4=
-  distributions: sdist bdist_wheel
-  on:
-    tags: true
+    provider: pypi
+    user: "scls"
+    password:
+        secure: YP1I8vi04F2mhaexylEK4PoizOMKfPy6ixDGYYLg5WAvgNdHvBN39xFsd9WHavMGg0RcV3xn5jAawQN1dDnXYVNW8LAivwfkUazXjqxAf4IeMp92203kOjQij/D494etHYeIw4SNJgk7J2tDil+goITJ/OhJ4t7fDC0eA0nILn8ifyZZQUgZppW5CoAf1L8cxY1JWICXLKQFQ42zPkFaIA9oBSOgok5wlNoyguScJ70mqUwZewhZHk4L07WSFRbDEOawHe5CAHCPO8rVCkhk2WdLWRoY9uHijDxHn9eCZ3zm4ac/jAwPtFol43q5u9wTCSm8WmeVfU/mJLjgGvmyDhb5Z2fTVbWGsX/N/WHvASr85HfKS0Vq2hAHYozukLbJ8EQZL6ZoOiFhjbL1LJv6Ex3EZ3PTkjKZEGEiLS/aiLZSj95CDMnfKjaNnAN2qFxzR1yi7tFHttS7XiaTCuKoegeN/RNA1iTdFPsXIcmCklhqYr9jCoTaKOXic8W5C1ej3V8oogx1xA79/mf7ZtHxtHWeT9o7cG2EK5gYfvPi6bhKPZDQ2hq49tt8AbcjX4/ycovTmX/cTn0CCoUfLB7Ok9/UvdcdUiflVZEm4cH1WAXAeD3CW+WGTOEHSgNArl9ERxUyomsWhyhutGPmeZIPQ1COeuqFFBTIaHWDG1ytqN4=
+    distributions: sdist bdist_wheel
+    on:
+        tags: true
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,11 @@
+{
+  "python.formatting.provider": "black",
+  "python.formatting.blackArgs": [
+    "--config=pyproject.toml"
+  ],
+  "ruff.args": [
+    "--config=pyproject.toml"
+  ],
+"autoDocstring.docstringFormat": "google-notypes",
+"esbonio.sphinx.confDir": "",
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,25 @@
 All notable changes to this code base will be documented in this file,
 in every released version.
 
+### Version 2.0.0
+
+- Released: TBD
+- Issues/Enhancements:
+  - Cythonized the package
+  - Added the `OptimizedBacktracking` solver based on [issue #62](https://github.com/python-constraint/python-constraint/issues/62)
+  - Added type-hints to improve Cythonization
+  - Added the MaxProd and MinProd constraints
+  - Improved pre-processing for the MaxSum constraint
+  - Optimized the Function constraint
+  - Added `getSolutionsOrderedList` and `getSolutionsAsListDict` functions for efficient result shaping
+  - Overall optimization of common bottlenecks
+  - Split the codebase into multiple files for convenience
+  - Switched from `setup.py` to `pyproject.toml`
+  - Achieved and requires test coverage of at least 65%
+  - Added `nox` for testing against all supported Python versions 
+  - Added `ruff` for codestyle testing
+  - Dropped Python 3.4, 3.5, 3.6, 3.7 support
+
 ### Version 1.4.0
 
 - Released: 2018-11-05

diff --git a/README.rst b/README.rst
@@ -5,15 +5,16 @@ python-constraint
 
 Introduction
 ------------
-The Python constraint module offers solvers for `Constraint Satisfaction Problems (CSPs) <https://en.wikipedia.org/wiki/Constraint_satisfaction_problem>`_ over finite domains in simple and pure Python. CSP is class of problems which may be represented in terms of variables (a, b, ...), domains (a in [1, 2, 3], ...), and constraints (a < b, ...).
+The Python constraint module offers efficient solvers for `Constraint Satisfaction Problems (CSPs) <https://en.wikipedia.org/wiki/Constraint_satisfaction_problem>`_ over finite domains in an accessible Python package.
+CSP is class of problems which may be represented in terms of variables (a, b, ...), domains (a in [1, 2, 3], ...), and constraints (a < b, ...).
 
 Examples
 --------
 
 Basics
 ~~~~~~
 
-This interactive Python session demonstrates the module basic operation:
+This interactive Python session demonstrates basic operations:
 
 .. code-block:: python
 
@@ -97,10 +98,10 @@ Features
 The following solvers are available:
 
 - Backtracking solver
+- Optimized backtracking solver
 - Recursive backtracking solver
 - Minimum conflicts solver
 
-
 .. role:: python(code)
    :language: python
 
@@ -109,17 +110,20 @@ Predefined constraint types currently available:
 - :python:`FunctionConstraint`
 - :python:`AllDifferentConstraint`
 - :python:`AllEqualConstraint`
-- :python:`ExactSumConstraint`
 - :python:`MaxSumConstraint`
+- :python:`ExactSumConstraint`
 - :python:`MinSumConstraint`
+- :python:`MaxProdConstraint`
+- :python:`MinProdConstraint`
 - :python:`InSetConstraint`
 - :python:`NotInSetConstraint`
 - :python:`SomeInSetConstraint`
 - :python:`SomeNotInSetConstraint`
 
 API documentation
 -----------------
-Documentation for the module is available at: http://labix.org/doc/constraint/
+Documentation for the module is available at: http://labix.org/doc/constraint/.
+It can be built locally by running `make clean html` from the `documentation` folder.
 
 Download and install
 --------------------
@@ -128,6 +132,11 @@ Download and install
 
     $ pip install python-constraint
 
+Testing
+-------
+
+Run `pytest` (for local Python) or `nox` (for all supported Python versions).
+
 Roadmap
 -------
 
@@ -146,6 +155,7 @@ Contact
 -------
 - `Gustavo Niemeyer <https://github.com/niemeyer/>`_ <[email protected]>
 - `Sébastien Celles <https://github.com/scls19fr/>`_ <[email protected]>
+- `Floris-Jan Willemsen <https://github.com/fjwillemsen>`
 
 But it's probably better to `open an issue <https://github.com/python-constraint/python-constraint/issues>`_.