gwpy 3.0.9__tar.gz → 3.0.11__tar.gz

gwpy-3.0.11/.gitlab/ci/compatibility.yml

@@ -0,0 +1,105 @@
+# -- Check dependency compatibility
+#
+# These jobs check that the minimum versions are well specified,
+# and that this project is compatible with the new pre-relase
+# versions of anything we can find.
+#
+
+spec:
+  inputs:
+    stage:
+      default: test
+      description: "Pipeline stage in which to add jobs"
+      type: string
+    pytest_options:
+      default: ""
+      description: "Extra options to pass to pytest"
+      type: string
+    minimum_python_version:
+      default: "3.9"
+      description: "Python version for minimum dependency compatibility check"
+      type: string
+
+---
+
+include:
+  - local: .gitlab/ci/rules.yml
+
+  # configure minimum dependency compatibility job
+  - local: .gitlab/ci/test-job.yml
+    inputs:
+      stage: $[[ inputs.stage ]]
+      job_name: "compat_minimum"
+      install_target: "."
+      install_extra: "test"
+      pip_options: "--upgrade-strategy=only-if-needed"
+      pytest_options: $[[ inputs.pytest_options ]]
+
+  # configure experimental dependency compatibility job
+  - local: .gitlab/ci/test-job.yml
+    inputs:
+      stage: $[[ inputs.stage ]]
+      job_name: "compat_experimental"
+      install_target: "."
+      install_extra: "test,dev"
+      pip_options: "--upgrade --upgrade-strategy=eager --pre"
+      pytest_options: $[[ inputs.pytest_options ]]
+
+  # configure dependency scanning
+  - component: gitlab.com/components/dependency-scanning/main@~latest
+    inputs:
+      # dependency-scanning needs to run _after_ the test job that generated
+      # the requirements.txt file
+      stage: $[[ inputs.stage ]]
+      job_name: "dependency-scanning"
+
+.compat_rules:
+  rules:
+    - if: '$CI_COMMIT_MESSAGE =~ /\[skip compat\]/'
+      when: never
+    - !reference [.rules_nightly, rules]
+    - !reference [.rules_full_test, rules]
+
+# test against the minimum specified requirements
+compat_minimum:
+  extends:
+    - .compat_minimum
+    - .compat_rules
+  image: python:$[[ inputs.minimum_python_version ]]
+  before_script:
+    # replace the requirements as follows:
+    #    >=X.Y.Z ---> X.Y.Z  (exact pin to minimum)
+    #    ^X.Y    ---> ~X.Y    (pin to X.Y.*)
+    - sed -i -E
+        -e 's/>=/==/'
+        -e 's/\^/~/'
+        pyproject.toml
+    # undo the change to python_requires
+    - sed -i -E
+        -e 's/requires-python = "==/requires-python = ">=/'
+        pyproject.toml
+    # use pip-compile to generate requirements.txt for dependency scanning
+    - python -m venv .piptools
+    - .piptools/bin/python -m pip install pip-tools
+    - .piptools/bin/pip-compile
+        --extra test
+        --output-file requirements.txt
+        --verbose
+    - rm -rf .piptools
+  artifacts:
+    paths:
+      - .coverage*
+      - requirements.txt
+
+# test against latest/pre-release versions
+compat_experimental:
+  extends:
+    - .compat_experimental
+    - .compat_rules
+  image: python:3.12
+
+# run dependency scanning against minimum specified requirements
+# (most likely to highlight issues)
+dependency-scanning:
+  needs: ["compat_minimum"]
+  rules: !reference [.compat_rules, rules]

gwpy-3.0.11/.gitlab/ci/coverage.yml

@@ -0,0 +1,32 @@
+# -- Python test coverage measurements
+
+spec:
+  inputs:
+
+---
+
+include:
+  - local: .gitlab/ci/rules.yml
+
+coverage:
+  stage: .post
+  image: python
+  rules: !reference [.rules_full_test, rules]
+  script:
+    # install coverage (with toml parsing extra)
+    - python -m pip install coverage[toml]
+    # combine coverage files from other jobs
+    - python -m coverage combine .coverage*
+    # write an HTML report
+    - python -m coverage html -d htmlcov
+    # print a report (for the record)
+    - python -m coverage report -m
+  allow_failure: true
+  artifacts:
+    name: htmlcov
+    expose_as: Coverage report
+    paths:
+      - htmlcov/index.html
+      - htmlcov
+  # report coverage here, now that we have all of the information
+  coverage: '/^TOTAL\s+.*\s+(\d+\.?\d*)%/'

gwpy-3.0.11/.gitlab/ci/init-creds.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+#
+# Initialise credentials for jobs
+#
+
+if [ "${KERBEROS_KEYTAB}" = "" ]; then
+echo -e "\x1B[94mNo KERBEROS_KEYTAB configured, skipping credential init.\x1B[0m"
+exit 0
+fi
+
+# install tooling
+conda install -c conda-forge -q -y ciecplib krb5
+
+# unpack keytab
+export KRB5_KTNAME="${CI_PROJECT_DIR}/.keytab"
+echo "${KERBEROS_KEYTAB}" | base64 -d > ${KRB5_KTNAME}
+chmod 0600 "${KRB5_KTNAME}"
+
+# find principal
+export KRB5_PRINCIPAL="$(klist -k ${KRB5_KTNAME} | tail -n 1 | awk '{print $2}')"
+
+# get Kerberos TGT
+kinit "${KRB5_PRINCIPAL}" -k -t "${KRB5_KTNAME}"
+klist
+
+# get LIGO.ORG X.509
+ecp-get-cert -i login.ligo.org --kerberos
+ecp-cert-info

gwpy-3.0.11/.gitlab/ci/platforms.yml

@@ -0,0 +1,30 @@
+spec:
+  inputs:
+
+---
+
+.linux:
+  rules:
+    - if: '$CI_COMMIT_MESSAGE =~ /\[skip linux\]/'
+      when: never
+  tags:
+    - saas-linux-medium-amd64
+
+.macos:
+  rules:
+    - if: '$CI_COMMIT_MESSAGE =~ /\[skip macos\]/'
+      when: never
+  tags:
+    - saas-macos-medium-m1
+  image: macos-14-xcode-15
+
+.windows:
+  rules:
+    - if: '$CI_COMMIT_MESSAGE =~ /\[skip windows\]/'
+      when: never
+  variables:
+    # windows gitlab runners don't support symbolic links, so we can't
+    # run the tests that rely upon them
+    PYTEST_ADDOPTS: "-k 'not table\\\\rate and not table\\\\tiles'"
+  tags:
+    - saas-windows-medium-amd64

gwpy-3.0.11/.gitlab/ci/python-base.yml

@@ -0,0 +1,37 @@
+# Common elements for Python components
+
+spec:
+  inputs:
+    cache_dir:
+      default: ".cache/pip"
+      description: "The path to cache to (relative to CI_PROJECT_DIR)"
+    image:
+      default: "python"
+      description: "The default image to use for jobs"
+    job_prefix:
+      default: ".python"
+      description: "Prefix to apply to all templates"
+
+---
+
+$[[ inputs.job_prefix ]]_image:
+  image: $[[ inputs.image ]]
+
+$[[ inputs.job_prefix ]]_cache:
+  variables:
+    PIP_CACHE_DIR: "${CI_PROJECT_DIR}/$[[ inputs.cache_dir ]]"
+  cache:
+    key: "pip-${CI_JOB_NAME_SLUG}"
+    paths:
+      - $[[ inputs.cache_dir ]]
+
+$[[ inputs.job_prefix ]]_base:
+  extends:
+    - $[[ inputs.job_prefix ]]_image
+    - $[[ inputs.job_prefix ]]_cache
+  retry:
+    # retry all jobs at most twice when gitlab-ci fails to start the job properly
+    # see https://docs.gitlab.com/ee/ci/yaml/#retry
+    max: 2
+    when:
+      - runner_system_failure

gwpy-3.0.11/.gitlab/ci/python-dist.yml

@@ -0,0 +1,43 @@
+# -- Build Python project distributions
+
+spec:
+  inputs:
+    stage:
+      default: build
+      description: "Pipeline stage in which to add jobs"
+      type: string
+
+---
+
+include:
+  - local: .gitlab/ci/rules.yml
+
+build:
+  rules: !reference [.rules_build, rules]
+  needs: []
+  stage: $[[ inputs.stage ]]
+  image: python
+  variables:
+    # get the full history for setuptools-scm
+    GIT_DEPTH: 0
+  before_script:
+    - python -m pip install
+        build
+  script:
+    # if running a default branch push pipeline, strip the +g<HASH> suffix
+    # from the version to give something that test.pypi.org will accept
+    - |
+      if [ "${CI_COMMIT_TAG}" = "" ] && [ "${CI_PIPELINE_SOURCE}" = "push" ] && [ "${CI_COMMIT_BRANCH}" = "${CI_DEFAULT_BRANCH}" ]; then
+        python -m pip install -q setuptools setuptools-scm
+        echo "Real version is '$(python -m setuptools_scm)'";
+        export SETUPTOOLS_SCM_PRETEND_VERSION=$(python3 -c "from setuptools import setup; setup(use_scm_version={'local_scheme': 'no-local-version'})" --version);
+        echo "Pretending version is '${SETUPTOOLS_SCM_PRETEND_VERSION}'";
+      fi
+    # generate the distributions
+    - python -m build . -o .
+    - python -m tarfile --list *.tar.*
+    - python -m zipfile --list *.whl
+  artifacts:
+    paths:
+      - "*.tar.*"
+      - "*.whl"

gwpy-3.0.11/.gitlab/ci/qa.yml

@@ -0,0 +1,109 @@
+# -- Quality Assurance jobs
+
+spec:
+  inputs:
+    stage:
+      default: test
+      description: "Pipeline stage in which to add jobs"
+      type: string
+    project_dir:
+      default: "."
+      description: "Project directory to scan"
+      type: string
+    requirements:
+      default: ""
+      description: "Extra requirements to install with pip"
+      type: string
+    ruff_options:
+      default: ""
+      description: "Extra options to pass to ruff check"
+      type: string
+    mypy_options:
+      default: ""
+      description: "Extra options to pass to mypy"
+      type: string
+
+---
+
+include:
+  - component: gitlab.com/components/sast/sast@~latest
+    inputs:
+      stage: $[[ inputs.stage ]]
+      run_advanced_sast: true
+    rules:
+      - if: '$GITLAB_FEATURES =~ /\bsast_advanced\b/'
+  - component: gitlab.com/components/sast/sast@~latest
+    inputs:
+      stage: $[[ inputs.stage ]]
+      run_advanced_sast: false
+    rules:
+      - if: '$GITLAB_FEATURES !~ /\bsast_advanced\b/'
+  - local: .gitlab/ci/rules.yml
+
+.qa:
+  extends: .rules_qa_security
+  stage: $[[ inputs.stage ]]
+  needs: []
+
+gitlab-advanced-sast:
+  needs: !reference [.qa, needs]
+  rules:
+    # skip if we just can't run advanced sast
+    - if: '$GITLAB_FEATURES !~ /\bsast_advanced\b/'
+      when: never
+    - !reference [.qa, rules]
+
+semgrep-sast:
+  needs: !reference [.qa, needs]
+  rules:
+    # skip if we can run advanced sast
+    - if: '$GITLAB_FEATURES =~ /\bsast_advanced\b/'
+      when: never
+    - !reference [.qa, rules]
+
+ruff:
+  extends: .qa
+  image: python
+  script:
+    - python -m pip install
+          ruff
+          $[[ inputs.requirements ]]
+    - python -m ruff check
+          $[[ inputs.ruff_options ]]
+          $[[ inputs.project_dir ]]
+          --exit-zero
+    - python -m ruff check
+          $[[ inputs.ruff_options ]]
+          $[[ inputs.project_dir ]]
+          --exit-zero
+          --output-format gitlab
+          --output-file gl-ruff.json
+  artifacts:
+    reports:
+      codequality: gl-ruff.json
+
+mypy:
+  extends: .qa
+  image: python
+  script:
+    - python -m pip install
+          mypy
+          mypy-gitlab-code-quality
+    # run mypy and print to console
+    - python -m mypy
+          $[[ inputs.mypy_options ]]
+          --install-types
+          --non-interactive
+          $[[ inputs.project_dir ]]
+      || exitcode="$?"
+    # run mypy again and format as code quality report
+    - python -m mypy
+          $[[ inputs.mypy_options ]]
+          --no-error-summary
+          $[[ inputs.project_dir ]]
+      | mypy-gitlab-code-quality > gl-mypy-code-quality.json || true
+    # propagate fatal exitcode
+    - if [ "${exitcode:-0}" -gt 1 ]; then exit ${exitcode}; fi
+  artifacts:
+    reports:
+      codequality: gl-mypy-code-quality.json

gwpy-3.0.11/.gitlab/ci/rules.yml

@@ -0,0 +1,81 @@
+# -- GWpy CI/CD workflow rules
+
+spec:
+  inputs:
+#    project_path:
+#      description: "Path of parent project for which to define rules"
+#      type: string
+
+---
+
+# -- basics
+
+# tag pipelines
+.rules_tag:
+  rules:
+    - if: $CI_COMMIT_TAG
+
+# default branch (all pipelines)
+.rules_default:
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+# default branch push (not schedules)
+.rules_default_push:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+# schedules on default branch
+.rules_default_schedule:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "schedule" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+# merge requests
+.rules_merge_request:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
+# new branches
+.rules_branch:
+  rules:
+    # not on branches with an open merge request
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI_COMMIT_BRANCH
+
+# -- job types
+
+# deployment jobs
+.rules_deploy:
+  rules:
+    - !reference [.rules_tag, rules]
+
+# nightly builds
+.rules_nightly:
+  rules:
+    - !reference [.rules_default_schedule, rules]
+
+# build jobs
+.rules_build:
+  rules:
+    - !reference [.rules_tag, rules]
+    - !reference [.rules_default_push, rules]
+    - !reference [.rules_merge_request, rules]
+    - !reference [.rules_branch, rules]
+
+# full test suite
+.rules_full_test:
+  rules:
+    - !reference [.rules_default_push, rules]
+    - !reference [.rules_merge_request, rules]
+
+# basic test suite
+.rules_basic_test:
+  rules:
+    - !reference [.rules_branch, rules]
+
+.rules_qa_security:
+  rules:
+    - !reference [.rules_default, rules]
+    - !reference [.rules_nightly, rules]
+    - !reference [.rules_merge_request, rules]

gwpy-3.0.11/.gitlab/ci/sphinx.yml

@@ -0,0 +1,65 @@
+# -- Sphinx documentation
+
+spec:
+  inputs:
+    stage:
+      default: test
+      description: "Pipeline stage in which to add jobs"
+      type: string
+    image:
+      default: python
+      description: "Container image to build in"
+      type: string
+    requirements:
+      default: ""
+      description: "Extra packages to install with pip before building"
+      type: string
+    builder:
+      default: "html"
+      description: "Sphinx builder to use"
+      type: string
+    sphinx_sourcedir:
+      default: ""
+      description: "Path of directory containing the Sphinx conf.py (auto-discovered if not set)"
+      type: string
+    sphinx_options:
+      default: ""
+      description: "Extra options to pass to sphinx-build"
+      type: string
+    sphinx_outputdir:
+      default: "sphinx"
+      description: "Sphinx build output directory (relative to `$CI_PROJECT_DIR`)"
+      type: string
+
+---
+
+include:
+  - local: .gitlab/ci/rules.yml
+  - local: .gitlab/ci/python-base.yml
+  - local: .gitlab/ci/conda-test.yml
+    inputs:
+      job_name: ".conda_test"
+
+sphinx:
+  extends: .python_base
+  rules: !reference [.rules_full_test, rules]
+  stage: $[[ inputs.stage ]]
+  image: $[[ inputs.image ]]
+  before_script:
+    - !reference [.conda_test_linux, before_script]
+  script:
+    # install sphinx
+    - python -m pip install sphinx $[[ inputs.requirements ]]
+    - python -m pip list installed
+    # run sphinx
+    - python -m sphinx
+        -b $[[ inputs.builder ]]
+        $[[ inputs.sphinx_sourcedir | expand_vars ]]
+        $[[ inputs.sphinx_outputdir | expand_vars ]]
+        $[[ inputs.sphinx_options ]]
+  artifacts:
+    name: "sphinx"
+    expose_as: "Sphinx docs"
+    paths:
+      - $[[ inputs.sphinx_outputdir ]]/index.html
+      - $[[ inputs.sphinx_outputdir ]]

gwpy-3.0.11/.gitlab/ci/test-job.yml

@@ -0,0 +1,88 @@
+# -- Basic Pytest-based test template
+
+spec:
+  inputs:
+    stage:
+      default: test
+      description: "Pipeline stage in which to add jobs"
+      type: string
+    job_name:
+      default: test
+      description: "Name to give this job"
+      type: string
+    install_target:
+      default: "."
+      description: "Directory/distribution/package to install"
+      type: string
+    install_extra:
+      default: "test"
+      description: "Name of the extra feature group(s) to install when installing <install_target>"
+      type: string
+    pip_options:
+      default: ""
+      description: "Extra options to pass to pip install"
+      type: string
+    pytest_options:
+      default: ""
+      description: "Extra options to pass to pytest"
+      type: string
+    extra_test_commands:
+      default: []
+      description: "Extra test commands to run (after pytest)"
+      type: array
+
+---
+
+include:
+  - local: .gitlab/ci/python-base.yml
+
+.$[[ inputs.job_name ]]:
+  extends:
+    - .python_base
+  variables:
+    # store coverage in a file named for this job (to be combined later)
+    COVERAGE_FILE: ".coverage-${CI_JOB_NAME_SLUG}"
+    # cache downloaded data
+    GWPY_CACHE: "1"
+    # store caches in .cache
+    XDG_CACHE_HOME: "$CI_PROJECT_DIR/.cache"
+  script:
+    # print some basic information about python
+    - python --version
+    - python -m site
+    - python -m sysconfig
+    # create the cache directory (so that astropy will actually use it)
+    # (this isn't just 'mkdir -p ...' because Windows)
+    - python -c "import os;
+      from pathlib import Path;
+      (Path(os.getenv('XDG_CACHE_HOME')) / 'astropy').mkdir(parents=True, exist_ok=True)
+      "
+    # install pytest
+    - python -m pip install pytest pytest-cov $[[ inputs.pip_options ]]
+    - python -m pip install $[[ inputs.install_target ]][$[[ inputs.install_extra ]]] $[[ inputs.pip_options ]]
+    # list installed packages
+    - python -m pip list installed
+# run the tests
+    - python -m pytest --junit-xml=junit.xml $[[ inputs.pytest_options ]]
+    # run any extra tests
+    - $[[ inputs.extra_test_commands ]]
+    # format the coverage report
+    - python -m coverage xml -o coverage.xml
+  artifacts:
+    reports:
+      # coverage report
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+      # test report
+      junit: junit.xml
+    paths:
+      - .coverage*
+  coverage: null
+  cache:
+    # cache pip packages
+    - !reference [.python_base, cache]
+    # cache GWpy downloaded files
+    - key: "gwpy-${CI_JOB_NAME_SLUG}"
+      paths:
+        - .cache/astropy/download