Create build_tools package

Author: Joseph-Edwards

build_tools/__init__.py

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021-2024 J. D. Mitchell
+#
+# Distributed under the terms of the GPL license version 3.
+#
+# The full license is in the file LICENSE, distributed with this software.
+
+"""
+This module provides some tools for building libsemigroups_pybind11.
+"""
+
+import re
+from packaging import version
+import pkgconfig
+
+
+def minimum_libsemigroups_version():
+    """
+    Returns the minimum required version of libsemigroups required to make
+    this work.
+    """
+    return "3.0.0"
+
+
+def libsemigroups_version():
+    "Get the version of libsemigroups installed using pkg-config."
+
+    vers = pkgconfig.modversion("libsemigroups")
+    if re.search(r"\d+\.\d+\.\d+-\d+-\w{7}", vers):
+        # i.e. supplied is of the form: 1.1.0-6-g8b04c08
+        vers = re.search(r"\d+\.\d\.+\d+-\d+", vers).group(0)
+    return vers
+
+
+def compare_version_numbers(supplied, required):
+    """Returns True if supplied >= required"""
+
+    if isinstance(supplied, str) and isinstance(required, str):
+        if "dev" in supplied:
+            print(
+                (
+                    "\033[93mWarning: You are using a development version of libsemigroups. This "
+                    "may cause undocumented behaviour\033[0m"
+                )
+            )
+            return True
+        return version.parse(supplied) >= version.parse(required)
+    raise TypeError(
+        f"expected (string, string), got a ({supplied.__name__}, {required.__name__})"
+    )
+
+
+def extra_link_args() -> str:
+    """Find extra link args"""
+    libs_only_L = pkgconfig.libs(  # pylint: disable=invalid-name
+        "libsemigroups"
+    )
+    # The above pkgconfig query can return an empty string (this also happens on
+    # the command line). This happens, for example, using pkg-config version 1.8.0
+    # on ArchLinux. CN 27/10/2021
+
+    assert (
+        len(libs_only_L) == 0 or libs_only_L[:2] == "-L"
+    ), "The first two characters of the library path to the libsemigroups.so etc should be '-L'"
+
+    libs_only_L = [  # pylint: disable=invalid-name
+        x for x in libs_only_L.split(" ") if x.startswith("-L")
+    ]
+
+    if len(libs_only_L) == 0:
+        libs_only_L = ["-L/usr/lib"]  # pylint: disable=invalid-name
+    return libs_only_L
+
+
+def ld_library_path() -> str:
+    """Construct the LD_LIBRARY_PATH"""
+    return ":".join([x[2:] for x in extra_link_args()])
+
+
+def validate_libsemigroups():
+    DISCLAIMER = """
+    (You should not see this message unless you are installing
+    libsemigroups_pybind11 from its sources. If you are not installing from the
+    sources, please raise an issue at:
+    https://github.com/libsemigroups/libsemigroups_pybind11)"""
+
+    if not pkgconfig.exists("libsemigroups"):
+        raise ImportError(
+            f"""cannot locate the libsemigroups library.
+    For more information about installing the libsemigroups library see
+    https://libsemigroups.github.io/libsemigroups_pybind11/install.html.
+
+    If libsemigroups is installed, then it cannot be located by pkg-config,
+    perhaps you should add the directory containing `libsemigroups.pc' to the
+    \"PKG_CONFIG_PATH\". The file `libsemigroups.pc' might be in one of the
+    following directories:
+    * /usr/local/lib/pkgconfig
+    * $CONDA_PREFIX/lib/pkgconfig if your active conda environment has pkgconfig
+    installed, and libsemigroups was installed with conda/mamba in this
+    environment.
+    {DISCLAIMER}"""
+        )
+
+    if not compare_version_numbers(
+        libsemigroups_version(), minimum_libsemigroups_version()
+    ):
+        raise ImportError(
+            f"libsemigroups version at least {minimum_libsemigroups_version()}"
+            + f" is required, found {libsemigroups_version()}"
+        )

etc/libsemigroups_version.py

@@ -2,9 +2,14 @@
 import os
 import sys
 
-__dir__ = os.path.abspath(os.path.dirname(__file__))
-sys.path.insert(0, __dir__ + "/../libsemigroups_pybind11")
-
-from tools import minimum_libsemigroups_version
+sys.path.append(
+    os.path.abspath(
+        os.path.join(
+            os.path.dirname(__file__),
+            "..",
+        )
+    )
+)
+from build_tools import minimum_libsemigroups_version
 
 print(minimum_libsemigroups_version())

src/libsemigroups_pybind11/detail/tools.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021-2024 J. D. Mitchell
+#
+# Distributed under the terms of the GPL license version 3.
+#
+# The full license is in the file LICENSE, distributed with this software.
+
+"""
+This module provides some tools for libsemigroups_pybind11.
+"""
+
+
+def ordinal(n: int):
+    """
+    Returns 1st from 1, 2nd from 2 etc.
+    From https://stackoverflow.com/questions/9647202/
+    """
+    if 11 <= (n % 100) <= 13:
+        suffix = "th"
+    else:
+        suffix = ["th", "st", "nd", "rd", "th"][min(n % 10, 4)]
+    return str(n) + suffix