pyurd 0.1.0__tar.gz

pyurd-0.1.0/.clang-format

@@ -0,0 +1,60 @@
+---
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignEscapedNewlines: Left
+AlignOperands: 'true'
+AlignTrailingComments: 'true'
+AllowAllArgumentsOnNextLine: 'false'
+AllowAllConstructorInitializersOnNextLine: 'false'
+AllowAllParametersOfDeclarationOnNextLine: 'false'
+AllowShortBlocksOnASingleLine: 'true'
+AllowShortCaseLabelsOnASingleLine: 'false'
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: 'false'
+AlwaysBreakTemplateDeclarations: 'Yes'
+BinPackArguments: 'false'
+BinPackParameters: 'false'
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Allman
+BreakBeforeTernaryOperators: 'false'
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+ColumnLimit: '160'
+CompactNamespaces: 'false'
+ConstructorInitializerAllOnOneLineOrOnePerLine: 'true'
+Cpp11BracedListStyle: 'false'
+FixNamespaceComments: 'false'
+IncludeBlocks: Regroup
+IndentAccessModifiers: 'false'
+IndentCaseLabels: 'true'
+IndentPPDirectives: None
+IndentWidth: '4'
+IndentWrappedFunctionNames: 'false'
+KeepEmptyLinesAtTheStartOfBlocks: 'false'
+Language: Cpp
+MaxEmptyLinesToKeep: '1'
+NamespaceIndentation: None
+PointerAlignment: Left
+SortIncludes: 'true'
+SortUsingDeclarations: 'true'
+SpaceAfterCStyleCast: 'true'
+SpaceAfterLogicalNot: 'false'
+SpaceAfterTemplateKeyword: 'false'
+SpaceBeforeAssignmentOperators: 'true'
+SpaceBeforeCpp11BracedList: 'true'
+SpaceBeforeCtorInitializerColon: 'true'
+SpaceBeforeInheritanceColon: 'true'
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: 'true'
+SpaceInEmptyParentheses: 'false'
+SpacesBeforeTrailingComments: '2'
+SpacesInAngles: 'false'
+SpacesInCStyleCastParentheses: 'false'
+SpacesInParentheses: 'false'
+SpacesInSquareBrackets: 'false'
+Standard: Cpp11
+TabWidth: '4'
+UseTab: Never
+...

pyurd-0.1.0/.clang-tidy

@@ -0,0 +1,98 @@
+# clang-tidy for peachycheck: every bugprone, cppcoreguidelines and performance check is on,
+# except where the check is wrong for any code, not just for today's:
+# - unchecked container access, constant array index: the only fix, .at(), puts a bounds
+#   check into hot loops. Debug builds check those bounds instead: CMakeLists.txt defines
+#   _GLIBCXX_ASSERTIONS, so operator[] of std::vector, std::array and
+#   std::span asserts its index there, at no cost in Release;
+# - std-namespace-modification: std::ranges::enable_borrowed_range must be specialized in std;
+# - easily-swappable-parameters: a heuristic without a clear fix;
+# - pro-type-reinterpret-cast: byte storage views its bytes as objects (reinterpret_cast plus
+#   std::launder); casting through void* instead stays forbidden (bugprone-casting-through-void);
+# - avoid-c-arrays: std::unique_ptr<T[]> with make_unique_for_overwrite is the uninitialized buffer,
+#   which std::vector would zero;
+# - pro-type-const-cast: std::atomic_ref of a const object needs C++26; until then atomic loads of
+#   const blocks cast;
+# - crtp-constructor-accessibility: private mixin constructors break inheriting constructors
+#   (using Base::Base) and aggregate initialization of derived types.
+# From the other families, the checks that find defects rather than enforce a style: the static
+# analyzer (clang-analyzer-*), concurrency, include cycles, redundant expressions, external linkage
+# of file-local functions, discarded results, nested namespace syntax, C-style casts, declarations
+# whose parameter names differ from the definition, non-inline definitions in headers (ODR), ignored
+# C return values, dead code (unused declarations and parameters, redundant declarations and casts,
+# member functions that could be const) and the modern forms that rule out a defect class (override,
+# nullptr, make_unique, deleted and defaulted members, misleading identifiers and indentation). Not
+# misc-const-correctness: in templates it reports variables as never modified that an overload
+# chosen at instantiation does modify (hash_combine's seed, fold-expression counters); following it
+# made hash_combine recurse forever.
+# Not google-explicit-constructor: the standard library's own idioms need implicit conversions
+# that it forbids, with no option to allow them: proxy references convert to their value (as
+# std::vector<bool>::reference does, and iterator concepts require it), and views of mutable
+# elements convert to views of const ones (as std::span does).
+# Not portability-template-virtual-member-function: it warns that other compilers (MSVC)
+# instantiate unused virtual members of class templates; the libraries build only with GCC and
+# Clang (Linux and macOS), which instantiate only what is used, so no build can check a fix.
+# tests/ turns off more in its own file, with its reasons.
+Checks: >
+  -*,
+  bugprone-*,
+  cppcoreguidelines-*,
+  performance-*,
+  clang-analyzer-*,
+  concurrency-*,
+  misc-header-include-cycle,
+  misc-redundant-expression,
+  misc-use-internal-linkage,
+  modernize-use-nodiscard,
+  modernize-concat-nested-namespaces,
+  modernize-avoid-c-style-cast,
+  google-runtime-int,
+  readability-inconsistent-declaration-parameter-name,
+  misc-definitions-in-headers,
+  cert-err33-c,
+  misc-unused-using-decls,
+  misc-unused-alias-decls,
+  misc-unused-parameters,
+  readability-redundant-declaration,
+  readability-redundant-casting,
+  readability-redundant-string-cstr,
+  readability-make-member-function-const,
+  modernize-use-emplace,
+  modernize-use-equals-default,
+  modernize-use-equals-delete,
+  modernize-use-override,
+  modernize-use-nullptr,
+  modernize-use-using,
+  modernize-make-unique,
+  modernize-make-shared,
+  misc-misplaced-const,
+  misc-throw-by-value-catch-by-reference,
+  misc-unconventional-assign-operator,
+  misc-non-copyable-objects,
+  misc-confusable-identifiers,
+  misc-misleading-bidirectional,
+  misc-misleading-identifier,
+  readability-misleading-indentation,
+  readability-duplicate-include,
+  readability-non-const-parameter,
+  hicpp-multiway-paths-covered,
+  -cppcoreguidelines-pro-bounds-avoid-unchecked-container-access,
+  -cppcoreguidelines-pro-bounds-constant-array-index,
+  -bugprone-std-namespace-modification,
+  -bugprone-easily-swappable-parameters,
+  -cppcoreguidelines-pro-type-reinterpret-cast,
+  -cppcoreguidelines-avoid-c-arrays,
+  -cppcoreguidelines-pro-type-const-cast,
+  -bugprone-crtp-constructor-accessibility
+HeaderFilterRegex: '.*/(include/urd|tests|examples|benchmarks)/.*'
+ExcludeHeaderFilterRegex: '.*/(dependencies-install|dependencies-build|build|site-packages|_deps)/.*'
+CheckOptions:
+  # Member initializers are written `= value`, as elsewhere in the code.
+  cppcoreguidelines-use-default-member-init.UseAssignment: true
+  # Copying a reference-counted handle has a side effect (the count); it is not a wasted copy.
+  performance-unnecessary-copy-initialization.AllowedTypes: 'SharedObjectPoolPtr'
+  # Iterators are passed by value, as the standard library passes them; Boost's vector iterator declares its
+  # copy constructor, which makes the check take a pointer's copy for a costly one.
+  performance-unnecessary-value-param.AllowedTypes: 'iterator(_type)?$'
+  # URD_ASSUME (urd/config.hpp) must expand at its call site, like assert: the analysis
+  # of optionals sees a condition only in the function that states it, never through a call.
+  cppcoreguidelines-macro-usage.AllowedRegexp: '^URD_ASSUME$'

pyurd-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+name: CI
+
+# main, and pull requests into it: the organization's ruleset lets main take only commits that passed `standards`.
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+env:
+  CMAKE_BUILD_PARALLEL_LEVEL: "4"
+
+jobs:
+  build-and-test:
+    name: ${{ matrix.compiler }} ${{ matrix.build_type }}
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        compiler: [g++, clang++]
+        build_type: [Debug, Release]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Restore dependencies
+        id: dependencies
+        uses: actions/cache@v4
+        with:
+          path: dependencies-install
+          key: dependencies-${{ runner.os }}-${{ hashFiles('python/native/**') }}
+
+      - name: Build dependencies
+        if: steps.dependencies.outputs.cache-hit != 'true'
+        run: |
+          cmake -S python/native -B dependencies-build -DCMAKE_INSTALL_PREFIX="$PWD/dependencies-install" -DCMAKE_INSTALL_LIBDIR=lib
+          cmake --build dependencies-build
+          cmake --install dependencies-build
+
+      - name: Configure
+        run: >
+          cmake -S . -B build -DCMAKE_CXX_COMPILER=${{ matrix.compiler }} -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+          -DCMAKE_COMPILE_WARNING_AS_ERROR=ON
+          -DURD_BUILD_BENCHMARKS=${{ (matrix.compiler == 'g++' && matrix.build_type == 'Release') && 'ON' || 'OFF' }}
+
+      - name: Build
+        run: cmake --build build
+
+      - name: Test
+        run: ctest --test-dir build -j 4 --output-on-failure
+
+  thread-sanitizer:
+    name: ThreadSanitizer
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Restore dependencies
+        id: dependencies
+        uses: actions/cache@v4
+        with:
+          path: dependencies-install
+          key: dependencies-${{ runner.os }}-${{ hashFiles('python/native/**') }}
+
+      - name: Build dependencies
+        if: steps.dependencies.outputs.cache-hit != 'true'
+        run: |
+          cmake -S python/native -B dependencies-build -DCMAKE_INSTALL_PREFIX="$PWD/dependencies-install" -DCMAKE_INSTALL_LIBDIR=lib
+          cmake --build dependencies-build
+          cmake --install dependencies-build
+
+      # ThreadSanitizer cannot map its shadow memory with the runner's default address randomization.
+      - name: Allow ThreadSanitizer's memory layout
+        run: sudo sysctl vm.mmap_rnd_bits=28
+
+      - name: Build with ThreadSanitizer
+        run: |
+          cmake -S . -B build -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Debug -DCMAKE_COMPILE_WARNING_AS_ERROR=ON \
+            -DCMAKE_CXX_FLAGS=-fsanitize=thread -DCMAKE_EXE_LINKER_FLAGS=-fsanitize=thread
+          cmake --build build --target test_properties test_rows test_pools test_store_rules test_store_sets test_store_maps test_store_multimaps test_store_scopes test_store_queues test_store_pools test_store_rows test_concurrency example_sequences
+
+      # A data race makes ThreadSanitizer report and the program exit non-zero.
+      - name: Run concurrent code
+        env:
+          TSAN_OPTIONS: halt_on_error=1
+        run: |
+          build/tests/test_properties
+          build/tests/test_rows
+          build/tests/test_pools
+          build/tests/test_store_rules
+          build/tests/test_store_sets
+          build/tests/test_store_maps
+          build/tests/test_store_multimaps
+          build/tests/test_store_scopes
+          build/tests/test_store_queues
+          build/tests/test_store_pools
+          build/tests/test_store_rows
+          build/tests/test_concurrency
+          build/examples/example_sequences

pyurd-0.1.0/.github/workflows/ci_release.yml

@@ -0,0 +1,254 @@
+name: CI Release
+
+# Builds what the two releases publish, without publishing: pyurd-native's wheels and source distribution
+# (release-native.yml) and, against the Linux wheel, pyurd's wheel and source distribution (release.yml).
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+  workflow_dispatch:
+
+env:
+  CMAKE_BUILD_PARALLEL_LEVEL: "2"
+  URD_JOBS: "2"
+
+jobs:
+  build_native_sdist:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install build frontend
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build source distribution
+        run: python -m build --sdist python --outdir native-dist
+
+      - name: Upload sdist artifact
+        uses: actions/upload-artifact@v5
+        with:
+          name: native-sdist
+          path: native-dist/*.tar.gz
+
+  build_corresponding_source:
+    needs: build_native_sdist
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Download source distribution
+        uses: actions/download-artifact@v5
+        with:
+          name: native-sdist
+          path: native-dist
+
+      - name: Download upstream sources
+        run: |
+          cmake -S python/native -B source-build \
+                -DCMAKE_INSTALL_PREFIX="$RUNNER_TEMP/urd-source-prefix" \
+                -DCMAKE_INSTALL_LIBDIR=lib \
+                -DPython_EXECUTABLE="$(python -c 'import sys; print(sys.executable)')"
+          cmake --build source-build --target corresponding-source-downloads --parallel 2
+
+      - name: Build corresponding-source bundle
+        run: |
+          SDISTS=(native-dist/*.tar.gz)
+          test "${#SDISTS[@]}" -eq 1
+          test -f "${SDISTS[0]}"
+          SOURCE_ARCHIVE=${SDISTS[0]#native-dist/}
+          SOURCE_ARCHIVE=${SOURCE_ARCHIVE%.tar.gz}-corresponding-source.tar.gz
+          mkdir -p release-assets
+          python cmake/build_corresponding_source.py \
+            --manifest python/native/SOURCES.json \
+            --sdist "${SDISTS[0]}" \
+            --sources source-build \
+            --output "release-assets/${SOURCE_ARCHIVE}"
+
+      - name: Upload corresponding-source artifact
+        uses: actions/upload-artifact@v5
+        with:
+          name: corresponding-source
+          path: release-assets/*.tar.gz
+
+  build_native_wheels_linux:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        architecture: ["x86_64"]
+        python-version: ["cp311"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install cibuildwheel
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install cibuildwheel
+
+      # python/ is pyurd-native's project; cibuildwheel copies the repository, from whose root it runs, into the container.
+      - name: Build Linux wheels
+        run: cibuildwheel python --output-dir wheelhouse
+        env:
+          CIBW_ENVIRONMENT: "URD_JOBS=2 CMAKE_BUILD_PARALLEL_LEVEL=2"
+          CIBW_PLATFORM: linux
+          CIBW_BUILD: "${{ matrix.python-version }}-*"
+          CIBW_SKIP: "*-musllinux_*"
+          CIBW_ARCHS: "${{ matrix.architecture }}"
+          CIBW_BUILD_VERBOSITY: "1"
+
+      - name: Upload Linux wheels artifact
+        uses: actions/upload-artifact@v5
+        with:
+          name: native-wheels-linux-${{ matrix.python-version }}-${{ matrix.architecture }}
+          path: wheelhouse/*.whl
+
+  build_native_wheels_macos:
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        architecture: ["arm64"]
+        python-version: ["cp311"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install cibuildwheel
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install cibuildwheel
+
+      - name: Build macOS wheels
+        run: cibuildwheel python --output-dir wheelhouse
+        env:
+          CIBW_ENVIRONMENT: "URD_JOBS=2 CMAKE_BUILD_PARALLEL_LEVEL=2"
+          CIBW_PLATFORM: macos
+          CIBW_BUILD: "${{ matrix.python-version }}-*"
+          CIBW_ARCHS: "${{ matrix.architecture }}"
+          CIBW_BUILD_VERBOSITY: "1"
+
+      - name: Upload macOS wheels artifact
+        uses: actions/upload-artifact@v5
+        with:
+          name: native-wheels-macos-${{ matrix.python-version }}-${{ matrix.architecture }}
+          path: wheelhouse/*.whl
+
+  # pyurd pins pyurd-native exactly; the wheel built above stands in for the one on PyPI.
+  build_pyurd:
+    needs: build_native_wheels_linux
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Download the Linux pyurd-native wheel
+        uses: actions/download-artifact@v5
+        with:
+          name: native-wheels-linux-cp311-x86_64
+          path: native-wheels
+
+      - name: Install build frontend
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build source distribution and wheel
+        run: python -m build
+        env:
+          PIP_FIND_LINKS: ${{ github.workspace }}/native-wheels
+
+      - name: Install the wheel and find urd through it
+        run: |
+          python -m pip install --find-links native-wheels dist/*.whl "cmake>=3.21"
+          mkdir -p "$RUNNER_TEMP/consumer"
+          printf '%s\n' 'cmake_minimum_required(VERSION 3.21)' 'project(consumer CXX)' 'find_package(urd CONFIG REQUIRED)' \
+            'add_library(consumer INTERFACE)' 'target_link_libraries(consumer INTERFACE urd::urd)' > "$RUNNER_TEMP/consumer/CMakeLists.txt"
+          cmake -S "$RUNNER_TEMP/consumer" -B "$RUNNER_TEMP/consumer/build" \
+                -DCMAKE_PREFIX_PATH="$(python -m pyurd --prefix);$(python -m pyurd_native --prefix)"
+
+      - name: Upload pyurd artifact
+        uses: actions/upload-artifact@v5
+        with:
+          name: pyurd
+          path: dist/*
+
+  validate_release:
+    needs:
+      - build_corresponding_source
+      - build_native_wheels_linux
+      - build_native_wheels_macos
+      - build_pyurd
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download pyurd-native wheels
+        uses: actions/download-artifact@v5
+        with:
+          pattern: native-wheels-*
+          path: native-dist
+          merge-multiple: true
+
+      - name: Download pyurd-native source distribution
+        uses: actions/download-artifact@v5
+        with:
+          name: native-sdist
+          path: native-dist
+
+      - name: Download pyurd
+        uses: actions/download-artifact@v5
+        with:
+          name: pyurd
+          path: dist
+
+      - name: Download corresponding-source bundle
+        uses: actions/download-artifact@v5
+        with:
+          name: corresponding-source
+          path: release-assets
+
+      - name: Validate release assets
+        run: |
+          test "$(find native-dist -maxdepth 1 -type f -name 'pyurd_native-*.whl' | wc -l)" -eq 2
+          test "$(find native-dist -maxdepth 1 -type f -name 'pyurd_native-*.tar.gz' | wc -l)" -eq 1
+          test "$(find dist -maxdepth 1 -type f -name 'pyurd-*.tar.gz' | wc -l)" -eq 1
+          test "$(find dist -maxdepth 1 -type f -name 'pyurd-*-py3-none-any.whl' | wc -l)" -eq 1
+          test "$(find release-assets -maxdepth 1 -type f -name '*-corresponding-source.tar.gz' | wc -l)" -eq 1
+          tar -tzf release-assets/*-corresponding-source.tar.gz >/dev/null

pyurd-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Docs
+
+# The documentation (docs/, Sphinx), built with warnings as errors on every pull request; main's is published on
+# GitHub Pages (https://planning-and-learning.github.io/urd/), where the README links.
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      # The category diagrams are drawn by Graphviz's dot.
+      - run: sudo apt-get update && sudo apt-get install -y graphviz
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -r docs/requirements.txt
+      - run: sphinx-build -W --keep-going -b html docs build/docs/html
+      - uses: actions/upload-pages-artifact@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          path: build/docs/html
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-24.04
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4