Merge pull request #45 from InvestmentSystems/44/new-package-structure

Reorganized package structure for pyi, typed inclusion

Author: flexatone

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
           CIBW_BUILD: cp${{ matrix.major }}${{ matrix.minor }}-*
           CIBW_BUILD_VERBOSITY: 1
           CIBW_BEFORE_TEST: pip install -r {project}/requirements-test.txt
-          CIBW_TEST_COMMAND: pytest {project}
+          CIBW_TEST_COMMAND: pytest {project}/test
       - uses: actions/upload-artifact@master
         with:
           name: dist

MANIFEST.in

@@ -1 +1 @@
-include arraykit.pyi py.typed
+include arraykit/__init__.pyi arraykit/py.typed

performance/main.py renamed to performance/__main__.py

@@ -298,4 +298,3 @@ def main():
 
 if __name__ == '__main__':
     main()
-

setup.py

@@ -39,15 +39,16 @@ def get_long_description() -> str:
         'Programming Language :: Python :: 3.8',
     ],
     keywords='numpy array',
-    packages=[''],
-    package_data={'': ['arraykit.pyi', 'py.typed']},
+    packages=['arraykit'],
+    package_dir={'arraykit': 'src'},
+    package_data={'arraykit': ['__init__.pyi', 'py.typed']},
     include_package_data=True,
     ext_modules=[
         Extension(
-            name='arraykit',
-            sources=['arraykit.c'],
+            name='arraykit._arraykit', # build into module
+            sources=['src/_arraykit.c'],
             include_dirs=[np.get_include()],
-            define_macros=[("AK_VERSION", AK_VERSION)],
+            define_macros=[('AK_VERSION', AK_VERSION)],
         ),
     ],
 )

src/__init__.py

@@ -0,0 +1,2 @@
+from ._arraykit import *
+from ._arraykit import __version__

arraykit.pyi renamed to src/__init__.pyi

@@ -4,6 +4,8 @@ import numpy as np  # type: ignore
 
 _T = tp.TypeVar('_T')
 
+__version__: str
+
 class ArrayGO:
 
     values: np.array

arraykit.c renamed to src/_arraykit.c

@@ -630,11 +630,11 @@ static PyMethodDef arraykit_methods[] =  {
 };
 
 static struct PyModuleDef arraykit_module = {
-    PyModuleDef_HEAD_INIT, "arraykit", NULL, -1, arraykit_methods,
+    PyModuleDef_HEAD_INIT, "_arraykit", NULL, -1, arraykit_methods,
 };
 
 PyObject *
-PyInit_arraykit(void)
+PyInit__arraykit(void)
 {
     import_array();
     PyObject *m = PyModule_Create(&arraykit_module);

py.typed renamed to src/py.typed

@@ -1,37 +1,48 @@
 import sys
-import os
-import typing as tp
 
 import invoke
 
+
+ARTIFACTS = (
+    '*.egg-info',
+    '.hypothesis',
+    'build',
+    'dist',
+    'src/*.so'
+)
+
+
 @invoke.task
 def clean(context):
     '''Clean doc and build artifacts
     '''
-    context.run(f"{sys.executable} setup.py develop --uninstall", echo=True)
+    cmd = f'{sys.executable} -m pip uninstall --yes arraykit'
+    context.run(cmd, echo=True, pty=True)
 
-    for artifact in ("*.egg-info", "*.so", "build", "dist", ".hypothesis"):
-        context.run(f"rm -rf {artifact}", echo=True)
+    for artifact in sorted(ARTIFACTS):
+        context.run(f'rm -rf {artifact}', echo=True, pty=True)
 
-    # context.run("black .", echo=True)@task(clean)
 
-@invoke.task
+@invoke.task(clean)
 def build(context):
-    context.run(f"pip install -r requirements.txt", echo=True)
-    context.run(f"{sys.executable} setup.py develop", echo=True)
+    context.run('pip install -r requirements.txt', echo=True, pty=True)
+    context.run(f'{sys.executable} -m pip install .', echo=True, pty=True)
+
 
-@invoke.task(pre=(clean, build))
+@invoke.task(build)
 def test(context):
     cmd = 'pytest -s --color no --disable-pytest-warnings --tb=native'
-    context.run(cmd)
+    context.run(cmd, echo=True, pty=True)
 
-@invoke.task(pre=(clean, build))
+
+@invoke.task(build)
 def performance(context):
-    context.run(f"{sys.executable} performance/main.py", echo=True)
+    context.run(f'{sys.executable} -m performance', echo=True, pty=True)
+
 
-@invoke.task(pre=(clean, build))
+@invoke.task
 def lint(context):
     '''Run pylint static analysis.
     '''
-    context.run('pylint -f colorized test performance')
-
+    cmd = 'pylint -f colorized *.py performance src test'
+    context.run(cmd, echo=True, pty=True)

tasks.py

@@ -45,10 +45,10 @@ def from_module(cls, module):
 
 class TestUnit(unittest.TestCase):
 
-    @unittest.skip('not sure if pyi is in right location')
+    # @unittest.skip('not sure if pyi is in right location')
     def test_interface(self) -> None:
 
-        fp = os.path.join(os.path.dirname(ak.__file__), 'arraykit.pyi')
+        fp = os.path.join(os.path.dirname(ak.__file__), '__init__.pyi')
 
         with open(fp) as f:
             msg = f.read()
@@ -64,7 +64,3 @@ def test_interface(self) -> None:
 
 if __name__ == '__main__':
     unittest.main()
-
-
-
-