Merge pull request #95 from open-atmos/slayoo-patch-3

enable Python 3.9 builds on Windows

Author: slayoo

.github/workflows/pdoc.yml

@@ -26,8 +26,6 @@ jobs:
           pip install -e .
           # TODO: add -We
           python -m pdoc --html PyPartMC
-          mkdir html/PyPartMC
-          mv html/PyPartMC.html html/PyPartMC/index.html
       - name: Deploy
         if: ${{ github.ref == 'refs/heads/main' && matrix.platform == 'ubuntu-latest' }}
         uses: JamesIves/[email protected]

.github/workflows/tests+artifacts+pypi.yml

@@ -20,13 +20,6 @@ jobs:
       matrix:
         platform: [ubuntu-latest, macos-11, macOS-12, windows-latest]
         python-version: ["3.7", "3.8", "3.9", "3.10"]
-        exclude:
-          - platform: windows-latest
-            python-version: "3.8"
-          - platform: windows-latest
-            python-version: "3.9"
-          - platform: windows-latest
-            python-version: "3.10"
     runs-on: ${{ matrix.platform }}
     steps:
       - if: startsWith(matrix.platform, 'macos-')

CMakeLists.txt

@@ -5,7 +5,7 @@
 ####################################################################################################
 
 cmake_minimum_required(VERSION 3.4...3.18)
-project(PyPartMC LANGUAGES C CXX Fortran)
+project(_PyPartMC LANGUAGES C CXX Fortran)
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
@@ -124,23 +124,23 @@ target_link_libraries(partmclib PRIVATE ${SUNDIALS_items})
 ### PYBIND11 & PyPartMC ############################################################################
 
 add_subdirectory(gitmodules/pybind11)
-pybind11_add_module(PyPartMC ${PyPartMC_sources})
-add_dependencies(PyPartMC partmclib)
-target_include_directories(PyPartMC PRIVATE 
+pybind11_add_module(_PyPartMC ${PyPartMC_sources})
+add_dependencies(_PyPartMC partmclib)
+target_include_directories(_PyPartMC PRIVATE 
   ${CMAKE_SOURCE_DIR}/gitmodules/json/include 
   ${CMAKE_SOURCE_DIR}/gitmodules/pybind11_json/include
   ${CMAKE_SOURCE_DIR}/gitmodules/span/include
   ${CMAKE_SOURCE_DIR}/gitmodules/string_view-standalone/include
 )
-target_compile_definitions(PyPartMC PRIVATE VERSION_INFO=${VERSION_INFO})
-target_link_libraries(PyPartMC PRIVATE partmclib)
+target_compile_definitions(_PyPartMC PRIVATE VERSION_INFO=${VERSION_INFO})
+target_link_libraries(_PyPartMC PRIVATE partmclib)
 if (APPLE)
-  target_link_options(PyPartMC PRIVATE -Wl,-no_compact_unwind -Wl,-keep_dwarf_unwind)
+  target_link_options(_PyPartMC PRIVATE -Wl,-no_compact_unwind -Wl,-keep_dwarf_unwind)
 endif()
 
 ### pedantics ######################################################################################
 
-foreach(target PyPartMC)  # TODO: the same for partmclib
+foreach(target _PyPartMC)  # TODO: the same for partmclib
   target_compile_options(${target} PRIVATE
     $<$<CXX_COMPILER_ID:MSVC>:/W4 /WX>
     $<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wall -Wextra -Wpedantic -Werror>

PyPartMC/__init__.py

@@ -0,0 +1,43 @@
+# pylint: disable=invalid-name,wrong-import-position
+import os
+from contextlib import contextmanager
+from pathlib import Path
+from collections import namedtuple
+
+# https://github.com/diegoferigo/cmake-build-extension/blob/master/src/cmake_build_extension/__init__.py
+@contextmanager
+def __build_extension_env():
+    cookies = []
+    # https://docs.python.org/3/whatsnew/3.8.html#bpo-36085-whatsnew
+    if hasattr(os, "add_dll_directory"):
+        for path in os.environ.get("PATH", "").split(os.pathsep):
+            if path and Path(path).is_absolute() and Path(path).is_dir():
+                cookies.append(os.add_dll_directory(path))
+    try:
+        yield
+    finally:
+        for cookie in cookies:
+            cookie.close()
+
+# TODO: 2 x loop over prefixes and units
+si = namedtuple("SI", (
+    "m", "cm", "um",
+    "kg", "g",
+    "s",
+    "K",
+    "Pa", "hPa",
+    "mol"
+))(
+    m=1., cm=.01, um=1e-6,
+    kg=1., g=1e-3,
+    s=1.,
+    K=1.,
+    Pa=1., hPa=100.,
+    mol=1.
+)
+""" TODO """
+
+with __build_extension_env():
+    from _PyPartMC import *
+    from _PyPartMC import __all__
+    import _PyPartMC

setup.py

@@ -9,7 +9,7 @@
 import subprocess
 import sys
 from pathlib import Path
-from setuptools import Extension, setup
+from setuptools import Extension, setup, find_packages
 from setuptools.command.build_ext import build_ext
 
 # Convert distutils Windows platform specifiers to CMake -A arguments
@@ -134,11 +134,17 @@ def build_extension(self, ext):  # pylint: disable=too-many-branches
     description="Python interface to PartMC",
     long_description=(Path(__file__).parent / "README.md").read_text(),
     long_description_content_type="text/markdown",
-    ext_modules=[CMakeExtension("PyPartMC")],
+    packages=find_packages(include=["PyPartMC", "PyPartMC.*"]),
+    ext_modules=[CMakeExtension("_PyPartMC")],
     cmdclass={"build_ext": CMakeBuild},
     zip_safe=False,
     python_requires=">=3.7",
     setup_requires=["setuptools_scm"],
     install_requires=['numpy'],
     license="GPL-3.0",
+    project_urls={
+        "Tracker": "https://github.com/open-atmos/PyPartMC/issues",
+        "Documentation": "https://open-atmos.github.io/PyPartMC",
+        "Source": "https://github.com/open-atmos/PyPartMC/",
+    }
 )

src/pypartmc.cpp

@@ -24,7 +24,7 @@
 
 namespace py = pybind11;
 
-PYBIND11_MODULE(PyPartMC, m) {
+PYBIND11_MODULE(_PyPartMC, m) {
     m.doc() = R"pbdoc(
         PyPartMC is a Python interface to PartMC.
     )pbdoc";
@@ -179,18 +179,19 @@ PYBIND11_MODULE(PyPartMC, m) {
         "Return the least power-of-2 that is at least equal to n."
     );
 
-    auto si = m.def_submodule("si", "SI units");
-    // TODO: 2xloop over prefixes and units
-    si.attr("m") = py::float_(1.);
-    si.attr("s") = py::float_(1.);
-    si.attr("K") = py::float_(1.);
-    si.attr("Pa") = py::float_(1.);
-    si.attr("hPa") = py::float_(100.);
-    si.attr("mol") = py::float_(1.);
-    si.attr("kg") = py::float_(1.);
-    si.attr("g") = py::float_(1e-3);
-    si.attr("cm") = py::float_(.01);
-    si.attr("um") = py::float_(1e-6);
-
     m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
+
+    m.attr("__all__") = py::make_tuple(
+        "__version__",
+        "AeroData",
+        "AeroState",
+        "EnvState",
+        "GasData",
+        "GasState",
+        "RunPartOpt",
+        "Scenario",
+        "condense_equilib_particles",
+        "run_part",
+        "pow2_above"
+    );
 }