Implement relative imports, clean up Manifest.in. (#75)

* Fix template lookup logic. This corrects bugs where Mako namespaces would fail to be found.

* Implement relative imports, clean up Manifest.in.

* Modify actions workflow to run only once per push to an open PR. Rename main branch to main. Skip pypa test publish.

Author: tbenthompson

.github/workflows/test.yml

@@ -1,7 +1,13 @@
 name: Test
 
-on: [push, pull_request]
-
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  push:
+    branches:
+      - main 
 jobs:
   test:
     strategy:
@@ -69,13 +75,6 @@ jobs:
     - name: Build sdist
       run: >- 
         python setup.py sdist
-    - name: Publish distribution 📦 to Test PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-        repository_url: https://test.pypi.org/legacy/
-        verbose: true
-        skip_existing: true
     - name: Publish distribution 📦 to PyPI
       if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@master

MANIFEST.in

@@ -1,3 +1,6 @@
 include README.md
 include VERSION
-recursive-include tests *
+recursive-include tests *.py
+recursive-include tests *.h
+recursive-include tests *.cpp
+recursive-include tests *.c

README.md

@@ -6,7 +6,7 @@
     <a target="_blank" href="https://pypi.org/project/cppimport/" title="PyPI"><img src="https://img.shields.io/pypi/dm/cppimport"></a>
     <a target="_blank" href="LICENSE" title="License: MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
     <a target="_blank" href="https://github.com/tbenthompson/cppimport/actions" title="Test Status"><img src="https://github.com/tbenthompson/cppimport/actions/workflows/test.yml/badge.svg"></a>
-    <a target="_blank" href="https://codecov.io/gh/tbenthompson/cppimport" title="Code coverage"><img src="https://codecov.io/gh/tbenthompson/cppimport/branch/stable/graph/badge.svg?token=GWpX62xMt5"/></a>
+    <a target="_blank" href="https://codecov.io/gh/tbenthompson/cppimport" title="Code coverage"><img src="https://codecov.io/gh/tbenthompson/cppimport/branch/main/graph/badge.svg?token=GWpX62xMt5"/></a>
 </a>
 
 </p>

cppimport/find.py

@@ -1,9 +1,12 @@
+import logging
 import os
 import sys
 
 import cppimport
 from cppimport.filepaths import make_absolute
 
+logger = logging.getLogger(__name__)
+
 
 def find_module_cpppath(modulename, opt_in=False):
     filepath = _find_module_cpppath(modulename, opt_in)
@@ -67,6 +70,10 @@ def _find_file_in_folders(filename, paths, opt_in):
                 continue
             filepath = os.path.join(d, f)
             if opt_in and not _check_first_line_contains_cppimport(filepath):
+                logger.debug(
+                    "Found file but the first line doesn't "
+                    "contain cppimport so it will be skipped: " + filepath
+                )
                 continue
             return filepath
     return None

cppimport/import_hook.py

@@ -11,7 +11,8 @@ class Hook(object):
     def __init__(self):
         self._running = False
 
-    def find_module(self, fullname, path=None):
+    def find_spec(self, fullname, path, target=None):
+        print("find_spec", fullname, path, target)
         # Prevent re-entry by the underlying importer
         if self._running:
             return

cppimport/templating.py

@@ -26,10 +26,14 @@ def run_templating(module_data):
     ctx = mako.runtime.Context(buf, **module_data)
 
     filepath = module_data["filepath"]
-    lookup = mako.lookup.TemplateLookup(directories=[os.path.dirname(filepath)])
-    tmpl = mako.template.Template(filename=filepath, lookup=lookup)
-
-    tmpl.render_context(ctx)
+    try:
+        template_dirs = [os.path.dirname(filepath)]
+        lookup = mako.lookup.TemplateLookup(directories=template_dirs)
+        tmpl = lookup.get_template(module_data["filebasename"])
+        tmpl.render_context(ctx)
+    except:  # noqa: E722
+        logger.exception(mako.exceptions.text_error_template().render())
+        raise
 
     rendered_src_filepath = get_rendered_source_filepath(filepath)
 

environment.yml

@@ -5,6 +5,7 @@ dependencies:
   - pybind11
   - mako
   - black
+  - regex>=2021
   - flake8
   - isort
   - pytest

release

@@ -1,7 +1,7 @@
 GIT:
 git commit -m "yy.mm.dd" 
 git tag yy.mm.dd
-git push --atomic origin stable yy.mm.dd
+git push --atomic origin main yy.mm.dd
 wait for github action to complete
 create release on github
 

tests/apackage/mymodule.cpp

@@ -1,4 +1,4 @@
-/*
+/* cppimport
 <%
 import pybind11
 cfg['compiler_args'] = ['-std=c++11']

tests/apackage/rel_import_tester.py

@@ -0,0 +1,5 @@
+from . import mymodule
+
+
+def f():
+    return mymodule.add(1, 2)