castxml 0.8.0__tar.gz

castxml-0.8.0/CMakeLists.txt

@@ -0,0 +1,39 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(CastXMLPythonDistributions LANGUAGES C CXX)
+
+#-----------------------------------------------------------------------------
+# Build CastXML from source with the CastXML superbuild, which builds
+# LLVM/Clang and then CastXML against them.
+#-----------------------------------------------------------------------------
+set(CASTXML_SUPERBUILD_GIT_TAG "0b677ec7bd49fa64bf7761aaed5a5129293c8094"
+  CACHE STRING "CastXMLSuperbuild Git revision")
+
+# The superbuild pins its own CastXML revision and FORCE-sets it in the cache,
+# so it can't be overridden with -D. PatchCastXMLSuperbuild.cmake rewrites
+# that pin to this revision instead.
+set(CASTXML_GIT_TAG "v0.8.0" CACHE STRING "CastXML Git revision")
+
+include(FetchContent)
+FetchContent_Declare(castxmlsuperbuild
+  GIT_REPOSITORY https://github.com/CastXML/CastXMLSuperbuild.git
+  GIT_TAG ${CASTXML_SUPERBUILD_GIT_TAG}
+  PATCH_COMMAND ${CMAKE_COMMAND}
+    -DCASTXML_GIT_TAG=${CASTXML_GIT_TAG}
+    -P ${CMAKE_CURRENT_SOURCE_DIR}/PatchCastXMLSuperbuild.cmake
+  )
+FetchContent_MakeAvailable(castxmlsuperbuild)
+
+message(STATUS "CastXMLSuperbuild revision: ${CASTXML_SUPERBUILD_GIT_TAG}")
+message(STATUS "CastXML revision: ${CASTXML_GIT_TAG}")
+
+#-----------------------------------------------------------------------------
+# Install
+#-----------------------------------------------------------------------------
+# The superbuild installs CastXML into <superbuild binary dir>/castxml while
+# building. Ship that whole tree: bin/castxml finds its bundled Clang headers
+# relative to itself in share/castxml.
+install(DIRECTORY ${castxmlsuperbuild_BINARY_DIR}/castxml/
+  DESTINATION .
+  USE_SOURCE_PERMISSIONS
+  )

castxml-0.8.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: castxml
+Version: 0.8.0
+Summary: Parse C-family source files and optionally write a subset of the Abstract Syntax Tree (AST) to a representation in XML.
+Keywords: castxml,ast,xml,cmake,cross-platform,c++,llvm,build
+Author-Email: Kitware <kitware@kitware.com>
+Maintainer-Email: John Parent <john.parent@kitware.com>
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: C
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Build Tools
+Project-URL: Homepage, https://github.com/castxml/castxml
+Project-URL: Documentation, https://github.com/CastXML/CastXML/blob/master/doc/manual/castxml.1.rst
+Project-URL: Repository, https://github.com/CastXML/CastXML-python-distributions
+Project-URL: Issues, https://github.com/CastXML/CastXML-python-distributions/issues
+Requires-Python: >=3
+Description-Content-Type: text/markdown
+
+# CastXML Python Distribution
+
+Introduction
+============
+
+The latest CastXML python wheels provide the CastXML 0.8.0 executable, built
+from source with the [CastXML superbuild][superbuild].
+
+CastXML is a C-family abstract syntax tree XML output tool.
+
+This project is maintained by [Kitware][kitware] in support of [ITK][itk],
+the Insight Segmentation and Registration Toolkit.
+
+[superbuild]: https://github.com/CastXML/CastXMLSuperbuild
+[kitware]: https://www.kitware.com/
+[itk]: https://itk.org/
+
+Manual
+======
+
+See the [castxml(1)][manual] manual page for instructions to run the tool.
+
+[manual]: https://github.com/CastXML/CastXML/blob/master/doc/manual/castxml.1.rst#castxml1
+
+Latest Release
+==============
+
+[![][pypi-version-img]][pypi] [![][pypi-download-img]][pypi]
+
+[pypi-version-img]: https://img.shields.io/pypi/v/castxml.svg
+[pypi-download-img]: https://img.shields.io/pypi/dm/castxml.svg
+[pypi]: https://pypi.python.org/pypi/castxml
+
+Build Status
+============
+
+[![][ci-status-img]][ci-status]
+
+[ci-status-img]: https://github.com/CastXML/CastXML-python-distributions/actions/workflows/ci.yml/badge.svg?branch=master
+[ci-status]: https://github.com/CastXML/CastXML-python-distributions/actions/workflows/ci.yml
+
+Maintainers
+===========
+
+* [How to make a release ?](https://github.com/CastXML/CastXML-python-distributions/blob/master/docs/make_a_release.md)
+
+Miscellaneous
+=============
+
+* Documentation: https://github.com/CastXML/CastXML-python-distributions#readme
+* Source code: https://github.com/CastXML/CastXML-python-distributions
+* Mailing list: https://public.kitware.com/mailman/listinfo/castxml
+
+License
+=======
+
+CastXML is licensed under the [Apache License, Version 2.0][apache-license-2.0].
+See the [LICENSE][license] and [NOTICE][notice] files for details.
+
+[apache-license-2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[license]: https://github.com/CastXML/CastXML/blob/master/LICENSE
+[notice]: https://raw.githubusercontent.com/CastXML/CastXML/master/NOTICE
+
+Community
+=========
+
+Subscribe and post to the [CastXML Mailing List][mailing-list] for discussion of CastXML.
+
+[mailing-list]: https://public.kitware.com/mailman/listinfo/castxml

castxml-0.8.0/PatchCastXMLSuperbuild.cmake

@@ -0,0 +1,24 @@
+# Rewrite the CastXML revision pinned by the CastXML superbuild.
+#
+# Usage, from the superbuild source directory:
+#   cmake -DCASTXML_GIT_TAG=<revision> -P PatchCastXMLSuperbuild.cmake
+#
+# The superbuild sets CastXML_GIT_TAG with CACHE ... FORCE, so the pin can only
+# be changed by editing its CMakeLists.txt. Re-running this is harmless.
+
+if(NOT CASTXML_GIT_TAG)
+  message(FATAL_ERROR "CASTXML_GIT_TAG must be set")
+endif()
+
+file(READ CMakeLists.txt content)
+
+set(pin_regex "set\\(CastXML_GIT_TAG \"[^\"]*\"")
+if(NOT content MATCHES "${pin_regex}")
+  message(FATAL_ERROR
+    "Could not find the CastXML_GIT_TAG pin in the superbuild's CMakeLists.txt; "
+    "PatchCastXMLSuperbuild.cmake needs updating for this superbuild revision.")
+endif()
+
+string(REGEX REPLACE "${pin_regex}" "set(CastXML_GIT_TAG \"${CASTXML_GIT_TAG}\""
+  content "${content}")
+file(WRITE CMakeLists.txt "${content}")

castxml-0.8.0/README.md

@@ -0,0 +1,69 @@
+# CastXML Python Distribution
+
+Introduction
+============
+
+The latest CastXML python wheels provide the CastXML 0.8.0 executable, built
+from source with the [CastXML superbuild][superbuild].
+
+CastXML is a C-family abstract syntax tree XML output tool.
+
+This project is maintained by [Kitware][kitware] in support of [ITK][itk],
+the Insight Segmentation and Registration Toolkit.
+
+[superbuild]: https://github.com/CastXML/CastXMLSuperbuild
+[kitware]: https://www.kitware.com/
+[itk]: https://itk.org/
+
+Manual
+======
+
+See the [castxml(1)][manual] manual page for instructions to run the tool.
+
+[manual]: https://github.com/CastXML/CastXML/blob/master/doc/manual/castxml.1.rst#castxml1
+
+Latest Release
+==============
+
+[![][pypi-version-img]][pypi] [![][pypi-download-img]][pypi]
+
+[pypi-version-img]: https://img.shields.io/pypi/v/castxml.svg
+[pypi-download-img]: https://img.shields.io/pypi/dm/castxml.svg
+[pypi]: https://pypi.python.org/pypi/castxml
+
+Build Status
+============
+
+[![][ci-status-img]][ci-status]
+
+[ci-status-img]: https://github.com/CastXML/CastXML-python-distributions/actions/workflows/ci.yml/badge.svg?branch=master
+[ci-status]: https://github.com/CastXML/CastXML-python-distributions/actions/workflows/ci.yml
+
+Maintainers
+===========
+
+* [How to make a release ?](https://github.com/CastXML/CastXML-python-distributions/blob/master/docs/make_a_release.md)
+
+Miscellaneous
+=============
+
+* Documentation: https://github.com/CastXML/CastXML-python-distributions#readme
+* Source code: https://github.com/CastXML/CastXML-python-distributions
+* Mailing list: https://public.kitware.com/mailman/listinfo/castxml
+
+License
+=======
+
+CastXML is licensed under the [Apache License, Version 2.0][apache-license-2.0].
+See the [LICENSE][license] and [NOTICE][notice] files for details.
+
+[apache-license-2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[license]: https://github.com/CastXML/CastXML/blob/master/LICENSE
+[notice]: https://raw.githubusercontent.com/CastXML/CastXML/master/NOTICE
+
+Community
+=========
+
+Subscribe and post to the [CastXML Mailing List][mailing-list] for discussion of CastXML.
+
+[mailing-list]: https://public.kitware.com/mailman/listinfo/castxml

castxml-0.8.0/castxml/__init__.py

@@ -0,0 +1,25 @@
+import os
+import subprocess
+import sys
+
+from ._version import __version__  # noqa: F401
+
+DATA = os.path.join(os.path.dirname(__file__), 'data')
+
+# In an editable install (pip install -e .) this file runs from the source
+# tree, but the CMake-installed files live in site-packages. scikit-build-core
+# adds that location to the package's __path__, so look there too.
+for _path in __path__:
+    if os.path.isdir(os.path.join(_path, 'data')):
+        DATA = os.path.join(_path, 'data')
+        break
+
+BIN_DIR = os.path.join(DATA, 'bin')
+
+
+def _program(name, args):
+    return subprocess.call([os.path.join(BIN_DIR, name)] + args)
+
+
+def castxml():
+    raise SystemExit(_program('castxml', sys.argv[1:]))

castxml-0.8.0/castxml/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.8.0'
+__version_tuple__ = version_tuple = (0, 8, 0)
+
+__commit_id__ = commit_id = 'g082c846b7'

castxml-0.8.0/pyproject.toml

@@ -0,0 +1,114 @@
+[build-system]
+requires = ["scikit-build-core>=1.0", "setuptools-scm>=8"]
+build-backend = "scikit_build_core.build"
+
+[tool.scikit-build]
+minimum-version = "build-system.requires"
+# Keep the build tree between local builds so rebuilding doesn't redo the
+# LLVM/Clang build from scratch. CI and sdist builds always start fresh.
+build-dir = "build/{wheel_tag}"
+
+[tool.scikit-build.ninja]
+make-fallback = false
+
+[tool.scikit-build.sdist]
+# Only files matching `include` go into the sdist.
+inclusion-mode = "explicit"
+include = [
+    "/castxml/*.py",
+    "/CMakeLists.txt",
+    "/*.cmake",
+    "/pyproject.toml",
+    "/README.md",  # referenced by project.readme
+    "/tests/*.py",  # lets downstream packagers test the wheel they build from the sdist
+]
+
+[tool.scikit-build.wheel]
+packages = ["castxml"]
+install-dir = "castxml/data"
+# The wheel ships a standalone executable, not an extension module, so tag it
+# py3-none-<platform> instead of tying it to one CPython version.
+py-api = "py3"
+
+[project]
+name = "castxml"
+dynamic = ["version"]  # supplied by setuptools-scm from git tags
+description = "Parse C-family source files and optionally write a subset of the Abstract Syntax Tree (AST) to a representation in XML."
+readme = "README.md"
+requires-python = ">=3"
+license = "Apache-2.0"
+authors = [
+    {name = "Kitware", email = "kitware@kitware.com"},
+]
+maintainers = [
+    {name = "John Parent", email = "john.parent@kitware.com"},
+]
+keywords = ["castxml", "ast", "xml", "cmake", "cross-platform", "c++", "llvm", "build"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: C",
+    "Programming Language :: C++",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Build Tools",
+]
+# The package only wraps the CastXML executable, so there are no runtime dependencies.
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/castxml/castxml"
+Documentation = "https://github.com/CastXML/CastXML/blob/master/doc/manual/castxml.1.rst"
+Repository = "https://github.com/CastXML/CastXML-python-distributions"
+Issues = "https://github.com/CastXML/CastXML-python-distributions/issues"
+
+[project.scripts]
+castxml = "castxml:castxml"
+
+[dependency-groups]
+test = [
+    "path",
+    "pytest>=9",  # needed for the native [tool.pytest] table below
+    "pytest-virtualenv",
+]
+lint = ["flake8>=7"]
+release = ["build", "twine"]
+dev = [
+    {include-group = "test"},
+    {include-group = "lint"},
+]
+
+[tool.pytest]
+testpaths = ["tests"]
+addopts = ["-v", "--import-mode=importlib"]
+
+[[tool.dynamic-metadata]]
+provider = "scikit_build_core.metadata.setuptools_scm"
+
+[tool.setuptools_scm]
+version_file = "castxml/_version.py"
+
+[tool.cibuildwheel]
+manylinux-x86_64-image = "manylinux2014"
+manylinux-aarch64-image = "manylinux_2_28"
+# Each wheel build compiles LLVM/Clang, so build only for the runner's own
+# architecture (no 32-bit or cross builds), and skip musllinux, which would
+# be a second LLVM build on every Linux runner.
+archs = ["native"]
+skip = ["*-musllinux_*"]
+
+test-requires = "pytest"
+test-command = "pytest --import-mode=importlib {project}/tests/test_castxml.py"
+
+[tool.cibuildwheel.windows]
+# Build with Ninja instead of Visual Studio/MSBuild: much faster for LLVM, and
+# the superbuild switches its LLVM/Clang/CastXML builds to Ninja whenever it
+# finds ninja anyway. The workflow sets up the MSVC environment Ninja needs.
+#
+# Build in a short directory at the drive root. The LLVM build nests deeply
+# (FetchContent, then the superbuild's ExternalProjects), and under the default
+# %TEMP%\cibw-sdist-*\castxml-<version>\build\<wheel tag> its paths exceed what
+# the MSVC tools can open (MAX_PATH), even with Windows long paths enabled.
+environment = { CMAKE_GENERATOR = "Ninja", SKBUILD_BUILD_DIR = "C:/cxb" }

castxml-0.8.0/tests/__init__.py

@@ -0,0 +1,12 @@
+
+import sys
+
+from contextlib import contextmanager
+
+
+@contextmanager
+def push_argv(argv):
+    old_argv = sys.argv
+    sys.argv = argv
+    yield
+    sys.argv = old_argv

castxml-0.8.0/tests/test_castxml.py

@@ -0,0 +1,18 @@
+
+import pytest
+
+import castxml
+
+from . import push_argv
+
+
+def _run(program, args):
+    func = getattr(castxml, program)
+    args = ["%s.py" % program] + args
+    with push_argv(args), pytest.raises(SystemExit) as excinfo:
+        func()
+    assert 0 == excinfo.value.code
+
+
+def test_castxml_module():
+    _run("castxml", ["--version"])

castxml-0.8.0/tests/test_distribution.py

@@ -0,0 +1,29 @@
+
+import os
+import pytest
+
+from path import Path
+
+DIST_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '../dist'))
+
+
+def _check_castxml_install(virtualenv, tmpdir):
+    expected_version = "0.8.0"
+
+    for executable_name in ["castxml"]:
+        output = virtualenv.run(
+            "%s --version" % executable_name, capture=True).splitlines()[0]
+        assert output == "%s version %s" % (executable_name, expected_version)
+
+
+@pytest.mark.skipif(not Path(DIST_DIR).exists(), reason="dist directory does not exist")
+def test_wheel(virtualenv, tmpdir):
+    wheels = Path(DIST_DIR).files(match="*.whl")
+    if not wheels:
+        pytest.skip("no wheel available")
+    assert len(wheels) == 1
+    print(wheels)
+
+    virtualenv.run("pip install --no-index %s" % wheels[0])
+
+    _check_castxml_install(virtualenv, tmpdir)