Merge pull request #131 from nucleic/install

Install kiwi in a proper package to include the type hints

Author: MatthieuDartiailh

.github/workflows/ci.yml

@@ -51,8 +51,11 @@ jobs:
           flake8 py
       - name: Run Mypy
         if: always()
+        # We test twice to ensure the type annotations are properly installed
         run: |
           mypy py
+          cd py/tests
+          mypy .
   benchmark:
     name: C++ Benchmark
     runs-on: ${{ matrix.os }}
@@ -101,7 +104,7 @@ jobs:
       - name: Test with pytest
         run: |
           pip install pytest
-          python -X dev -m pytest py/tests
+          python -X dev -m pytest py
       - name: Generate C++ coverage reports
         if: (github.event_name != 'schedule' && matrix.os != 'windows-latest')
         run: |

MANIFEST.in

@@ -4,7 +4,7 @@ include README.rst
 include releasenotes.rst
 recursive-include kiwi *.h
 recursive-include py *.cpp *.h *.py *.pyi
-include py/py.typed
+include py/kiwisolver/py.typed
 recursive-include docs/source *.rst
 recursive-include docs/source *.png
 recursive-include docs/source *.py

lint_requirements.txt

@@ -1,4 +1,6 @@
 black
 flake8
 isort
-mypy
+mypy
+# Allow to lint tests using mypy
+pytest

py/kiwisolver/__init__.py

@@ -0,0 +1,40 @@
+# --------------------------------------------------------------------------------------
+# Copyright (c) 2013-2022, Nucleic Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file LICENSE, distributed with this software.
+# --------------------------------------------------------------------------------------
+from ._cext import (
+    BadRequiredStrength,
+    Constraint,
+    DuplicateConstraint,
+    DuplicateEditVariable,
+    Expression,
+    Solver,
+    Term,
+    UnknownConstraint,
+    UnknownEditVariable,
+    UnsatisfiableConstraint,
+    Variable,
+    __kiwi_version__,
+    __version__,
+    strength,
+)
+
+__all__ = [
+    "BadRequiredStrength",
+    "DuplicateConstraint",
+    "DuplicateEditVariable",
+    "UnknownConstraint",
+    "UnknownEditVariable",
+    "UnsatisfiableConstraint",
+    "strength",
+    "Variable",
+    "Term",
+    "Expression",
+    "Constraint",
+    "Solver",
+    "__version__",
+    "__kiwi_version__",
+]

py/kiwisolver.pyi renamed to py/kiwisolver/_cext.pyi

@@ -13,6 +13,9 @@ try:
 except ImportError:
     from typing_extensions import Literal  # type: ignore
 
+__version__: str
+__kiwi_version__: str
+
 # --- Exceptions
 
 class BadRequiredStrength(Exception): ...

py/py.typed renamed to py/kiwisolver/py.typed

@@ -134,7 +134,7 @@ bool add_objects( PyObject* mod )
 
 
 int
-catom_modexec( PyObject *mod )
+kiwi_modexec( PyObject *mod )
 {
     if( !ready_types() )
     {
@@ -161,14 +161,14 @@ kiwisolver_methods[] = {
 
 
 PyModuleDef_Slot kiwisolver_slots[] = {
-    {Py_mod_exec, reinterpret_cast<void*>( catom_modexec ) },
+    {Py_mod_exec, reinterpret_cast<void*>( kiwi_modexec ) },
     {0, NULL}
 };
 
 
 struct PyModuleDef moduledef = {
         PyModuleDef_HEAD_INIT,
-        "kiwisolver",
+        "_cext",
         "kiwisolver extension module",
         0,
         kiwisolver_methods,
@@ -181,7 +181,7 @@ struct PyModuleDef moduledef = {
 }  // namespace
 
 
-PyMODINIT_FUNC PyInit_kiwisolver( void )
+PyMODINIT_FUNC PyInit__cext( void )
 {
     return PyModuleDef_Init( &moduledef );
 }

py/constraint.cpp renamed to py/src/constraint.cpp

@@ -43,7 +43,7 @@ requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4.3", "cppy>=1.2
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "py/version.h"
+write_to = "py/src/version.h"
 write_to_template = """
 /* ----------------------------------------------------------------------------
 | Copyright (c) 2013-2021, Nucleic Development Team.
@@ -70,10 +70,6 @@ minversion = "6.0"
 follow_imports = "normal"
 strict_optional = true
 
-[[tool.mypy.overrides]]
-module="pytest.*"
-ignore_missing_imports = true
-
 [tool.isort]
 multi_line_output = 3
 include_trailing_comma = true

py/expression.cpp renamed to py/src/expression.cpp

@@ -4,6 +4,7 @@ Kiwi Release Notes
 Wrappers 1.4.1 | Solver 1.4.1 | unreleased
 ------------------------------------------
 - add missing include PR #129
+- re-organize the Python binding sources to properly ship type hints PR #131
 
 Wrappers 1.4.0 | Solver 1.4.0 | 14/03/2021
 ------------------------------------------

py/kiwisolver.cpp renamed to py/src/kiwisolver.cpp

@@ -27,15 +27,15 @@
 
 ext_modules = [
     Extension(
-        "kiwisolver",
+        "kiwisolver._cext",
         [
-            "py/kiwisolver.cpp",
-            "py/constraint.cpp",
-            "py/expression.cpp",
-            "py/solver.cpp",
-            "py/strength.cpp",
-            "py/term.cpp",
-            "py/variable.cpp",
+            "py/src/kiwisolver.cpp",
+            "py/src/constraint.cpp",
+            "py/src/expression.cpp",
+            "py/src/solver.cpp",
+            "py/src/strength.cpp",
+            "py/src/term.cpp",
+            "py/src/variable.cpp",
         ],
         include_dirs=["."],
         language="c++",
@@ -72,8 +72,11 @@
         "setuptools_scm[toml]>=3.4.3",
         "cppy>=1.2.0",
     ],
+    package_dir={"": "py"},
+    packages=["kiwisolver"],
     install_requires=["typing_extensions;python_version<'3.8'"],
     ext_modules=ext_modules,
     cmdclass={"build_ext": CppyBuildExt},
-    package_data={"py": ["py.typed", "*.pyi"]},
+    include_package_data=False,
+    package_data={"kiwisolver": ["py.typed", "*.pyi"]},
 )