Allow cimport for quicktions

.gitignore

@@ -9,8 +9,8 @@ __pycache__
 
 /build
 /dist
-src/*.c
-src/*.html
+src/quicktions/*.c
+src/quicktions/*.html
 MANIFEST
 
 .tox

.travis.yml

@@ -12,10 +12,12 @@ language: python
 install:
   - pip install -r requirements-appveyor.txt tox-travis
   - python setup.py build_ext --inplace --with-cython
-
+  - python setup.py sdist bdist_wheel
+  - make clean
+  # Install quicktions from the wheel built above (into site-packages)
+  - pip install --no-index --find-links=dist/ quicktions
 script:
   - tox
-  - python setup.py sdist bdist_wheel
   # the following is stolen from https://github.com/joerick/pyinstrument_cext/blob/master/.travis.yml
   # uncomment to push wheels automatically to pypi for tagged releases only (requires TWINE_PASSWORD to be set)
   # - |

MANIFEST.in

@@ -1,4 +1,5 @@
 include MANIFEST.in LICENSE *.rst
 include setup.py *.yml tox.ini *.cmd *.txt
+include test_fractions.py
 recursive-include src *.py *.pyx *.pxd *.c *.html
 recursive-include benchmark *.py telco-bench.b

Makefile

@@ -1,5 +1,6 @@
 PYTHON?=python
-VERSION?=$(shell sed -ne "s|^__version__\s*=\s*'\([^']*\)'.*|\1|p" src/quicktions.pyx)
+PKG_ROOT?=src/quicktions
+VERSION?=$(shell sed -ne "s|^__version__\s*=\s*'\([^']*\)'.*|\1|p" $(PKG_ROOT)/quicktions.pyx)
 PACKAGE=quicktions
 WITH_CYTHON := $(shell python -c 'from Cython.Build import cythonize' 2>/dev/null && echo "--with-cython")
 
@@ -19,13 +20,14 @@ dist/$(PACKAGE)-$(VERSION).tar.gz:
 	$(PYTHON) setup.py sdist $(WITH_CYTHON)
 
 test: local
-	PYTHONPATH=src $(PYTHON) src/test_fractions.py
+	PYTHONPATH=$(PKG_ROOT) $(PYTHON) test_fractions.py
 
 clean:
-	rm -fr build src/*.so
+	rm -fr build $(PKG_ROOT)/*.so
+	rm -r src/quicktions.egg-info
 
 realclean: clean
-	rm -fr src/*.c src/*.html
+	rm -fr $(PKG_ROOT)/*.c $(PKG_ROOT)/*.html
 
 wheel_manylinux: wheel_manylinux64 wheel_manylinux32
 

setup.py

@@ -1,4 +1,5 @@
 
+import os
 import sys
 import re
 
@@ -9,10 +10,16 @@
 
 from distutils.core import setup, Extension
 
+try:
+    from Cython.Build import cythonize
+    import Cython.Compiler.Options as cython_options
+    cython_options.annotate = True
+    cython_available = True
+except ImportError:
+    cython_available = False
+    cython = None
 
-ext_modules = [
-    Extension("quicktions", ["src/quicktions.pyx"]),
-]
+PKG_ROOT = os.path.join('src', 'quicktions')
 
 try:
     sys.argv.remove("--with-profile")
@@ -21,29 +28,23 @@
 else:
     enable_profiling = True
 
+ext_modules = None
 try:
     sys.argv.remove("--with-cython")
 except ValueError:
     cythonize = None
 else:
-    try:
-        from Cython.Build import cythonize
-        import Cython.Compiler.Options as cython_options
-        cython_options.annotate = True
-    except ImportError:
-        cythonize = None
-    else:
+    if cython_available:
         compiler_directives = {}
         if enable_profiling:
             compiler_directives['profile'] = True
-        ext_modules = cythonize(ext_modules, compiler_directives=compiler_directives)
-
-if cythonize is None:
-    for ext_module in ext_modules:
-        ext_module.sources[:] = [m.replace('.pyx', '.c') for m in ext_module.sources]
-
+        ext_modules = cythonize(os.path.join(PKG_ROOT, '*.pyx'), compiler_directives=compiler_directives)
+if ext_modules is None:
+    ext_modules = [
+        Extension("quicktions.quicktions", [os.path.join(PKG_ROOT, "quicktions.c")]),
+    ]
 
-with open('src/quicktions.pyx') as f:
+with open(os.path.join(PKG_ROOT, 'quicktions.pyx')) as f:
     version = re.search("__version__\s*=\s*'([^']+)'", f.read(2048)).group(1)
 
 with open('README.rst') as f:
@@ -65,7 +66,10 @@
     #bugtrack_url="https://github.com/scoder/quicktions/issues",
 
     ext_modules=ext_modules,
-    package_dir={'': 'src'},
+    package_dir={'':'src'},
+    packages=['quicktions'],
+    package_data={'quicktions':['*.pxd']},
+    include_package_data=True,
 
     classifiers=[
         "Development Status :: 6 - Mature",

src/quicktions/__init__.pxd

@@ -0,0 +1,2 @@
+from .quicktions import Fraction, _gcd
+from quicktions.quicktions cimport Fraction, _gcd

src/quicktions/__init__.py

@@ -0,0 +1,2 @@
+from .quicktions import Fraction, _gcd
+from .quicktions import __doc__, __version__, __all__

src/quicktions/quicktions.pxd

@@ -0,0 +1,39 @@
+# cython: language_level=3str
+## cython: profile=True
+
+cdef extern from *:
+    """
+    #if PY_VERSION_HEX < 0x030500F0 || !CYTHON_COMPILING_IN_CPYTHON
+        #define _PyLong_GCD(a, b) (NULL)
+    #endif
+    """
+    # CPython 3.5+ has a fast PyLong GCD implementation that we can use.
+    int PY_VERSION_HEX
+    int IS_CPYTHON "CYTHON_COMPILING_IN_CPYTHON"
+    _PyLong_GCD(a, b)
+
+ctypedef unsigned long long ullong
+ctypedef unsigned long ulong
+ctypedef unsigned int uint
+
+ctypedef fused cunumber:
+    ullong
+    ulong
+    uint
+
+cpdef _gcd(a, b)
+cdef ullong _abs(long long x)
+cdef cunumber _igcd(cunumber a, cunumber b)
+cdef cunumber _ibgcd(cunumber a, cunumber b)
+cdef _py_gcd(ullong a, ullong b)
+cdef _gcd_fallback(a, b)
+
+cdef class Fraction:
+    cdef _numerator
+    cdef _denominator
+    cdef Py_hash_t _hash
+
+    cpdef limit_denominator(self, max_denominator=*)
+    cpdef conjugate(self)
+    cdef _eq(a, b)
+    cdef _richcmp(self, other, int op)

src/quicktions.pyx → src/quicktions/quicktions.pyx

@@ -70,16 +70,6 @@ cdef pow10(Py_ssize_t i):
 
 # Half-private GCD implementation.
 
-cdef extern from *:
-    """
-    #if PY_VERSION_HEX < 0x030500F0 || !CYTHON_COMPILING_IN_CPYTHON
-        #define _PyLong_GCD(a, b) (NULL)
-    #endif
-    """
-    # CPython 3.5+ has a fast PyLong GCD implementation that we can use.
-    int PY_VERSION_HEX
-    int IS_CPYTHON "CYTHON_COMPILING_IN_CPYTHON"
-    _PyLong_GCD(a, b)
 
 
 cpdef _gcd(a, b):
@@ -94,14 +84,6 @@ cpdef _gcd(a, b):
     return _PyLong_GCD(a, b)
 
 
-ctypedef unsigned long long ullong
-ctypedef unsigned long ulong
-ctypedef unsigned int uint
-
-ctypedef fused cunumber:
-    ullong
-    ulong
-    uint
 
 
 cdef ullong _abs(long long x):
@@ -244,9 +226,6 @@ cdef class Fraction:
     Fraction(147, 100)
 
     """
-    cdef _numerator
-    cdef _denominator
-    cdef Py_hash_t _hash
 
     def __cinit__(self, numerator=0, denominator=None, *, bint _normalize=True):
         cdef Fraction value
@@ -388,7 +367,7 @@ cdef class Fraction:
         else:
             return cls(digits, pow10(-exp))
 
-    def limit_denominator(self, max_denominator=1000000):
+    cpdef limit_denominator(self, max_denominator=1000000):
         """Closest Fraction to self with denominator at most max_denominator.
 
         >>> Fraction('3.141592653589793').limit_denominator(10)
@@ -607,7 +586,7 @@ cdef class Fraction:
         "Real numbers have no imaginary component."
         return 0
 
-    def conjugate(self):
+    cpdef conjugate(self):
         """Conjugate is a no-op for Reals."""
         return +self
 

src/test_fractions.py → test_fractions.py

@@ -10,6 +10,7 @@
 
 from __future__ import division
 
+import os
 from decimal import Decimal
 import math
 import numbers

test_quicktions.py

@@ -0,0 +1,59 @@
+import os
+import glob
+import unittest
+
+from Cython.Build import Cythonize
+
+import quicktions
+F = quicktions.Fraction
+gcd = quicktions._gcd
+
+class CImportTest(unittest.TestCase):
+
+    def setUp(self):
+        self.module_files = []
+
+    def tearDown(self):
+        for fn in self.module_files:
+            if os.path.exists(fn):
+                os.remove(fn)
+
+    def build_test_module(self):
+        module_code = '\n'.join([
+            '# cython: language_level=3str',
+            'from quicktions cimport Fraction',
+            'def get_fraction():',
+            '    return Fraction(1, 2)',
+        ])
+        base_path = os.path.abspath(os.path.dirname(__file__))
+        module_name = 'quicktions_importtest'
+        module_filename = os.path.join(base_path, '.'.join([module_name, 'pyx']))
+        with open(module_filename, 'w') as f:
+            f.write(module_code)
+
+        Cythonize.main(['-i', module_filename])
+
+        for fn in glob.glob(os.path.join(base_path, '.'.join([module_name, '*']))):
+            self.module_files.append(os.path.abspath(fn))
+
+    def test_cimport(self):
+        self.build_test_module()
+
+        from quicktions_importtest import get_fraction
+
+        self.assertEqual(get_fraction(), F(1,2))
+
+
+def test_main():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(CImportTest))
+    return suite
+
+def main():
+    suite = test_main()
+    runner = unittest.TextTestRunner(sys.stdout, verbosity=2)
+    result = runner.run(suite)
+    sys.exit(not result.wasSuccessful())
+
+if __name__ == '__main__':
+    main()

tox.ini

@@ -7,7 +7,7 @@ platform =
     linux: linux
     darwin: darwin
 passenv = *
-commands = coverage run --parallel-mode -m pytest src/test_fractions.py --capture=no --strict {posargs}
+commands = coverage run --parallel-mode -m pytest --capture=no --strict {posargs}
            coverage combine
-           coverage report -m --include=src/test_fractions.py
+           coverage report -m --include=test_fractions.py
            {windows,linux}: codecov