gwpy 3.0.11__tar.gz → 3.0.13__tar.gz

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/compatibility.yml

@@ -65,7 +65,7 @@ compat_minimum:
   extends:
     - .compat_minimum
     - .compat_rules
-  image: python:$[[ inputs.minimum_python_version ]]
+  image: "ghcr.io/astral-sh/uv:python$[[ inputs.minimum_python_version ]]-bookworm"
   before_script:
     # replace the requirements as follows:
     #    >=X.Y.Z ---> X.Y.Z  (exact pin to minimum)
@@ -96,7 +96,7 @@ compat_experimental:
   extends:
     - .compat_experimental
     - .compat_rules
-  image: python:3.12
+  image: "ghcr.io/astral-sh/uv:python3.12-bookworm"
 
 # run dependency scanning against minimum specified requirements
 # (most likely to highlight issues)

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/coverage.yml

@@ -10,7 +10,7 @@ include:
 
 coverage:
   stage: .post
-  image: python
+  image: quay.io/lib/python
   rules: !reference [.rules_full_test, rules]
   script:
     # install coverage (with toml parsing extra)

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/platforms.yml

@@ -26,5 +26,7 @@ spec:
     # 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'"
+    # pytest-xdist doesn't auto-detect the number of CPUs sometimes
+    PYTEST_XDIST_AUTO_NUM_WORKERS: "2"
   tags:
     - saas-windows-medium-amd64

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/python-base.yml

@@ -6,7 +6,7 @@ spec:
       default: ".cache/pip"
       description: "The path to cache to (relative to CI_PROJECT_DIR)"
     image:
-      default: "python"
+      default: "quay.io/lib/python"
       description: "The default image to use for jobs"
     job_prefix:
       default: ".python"

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/python-dist.yml

@@ -16,22 +16,24 @@ build:
   rules: !reference [.rules_build, rules]
   needs: []
   stage: $[[ inputs.stage ]]
-  image: python
+  image: ghcr.io/astral-sh/uv:alpine
   variables:
     # get the full history for setuptools-scm
     GIT_DEPTH: 0
+    # debug setuptools-scm
+    SETUPTOOLS_SCM_DEBUG: 1
   before_script:
-    - python -m pip install
-        build
+    # need git for setuptools-scm
+    - apk add --no-cache git
   script:
+    - uv venv
+    - uv pip install build
+    - source .venv/bin/activate
     # 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}'";
+      if [ "${CI_COMMIT_TAG}" = "" ] && [ "${CI_PIPELINE_SOURCE}" = "push" ] && [ "${CI_COMMIT_REF_PROTECTED}" = "true" ]; then
+        export SETUPTOOLS_SCM_OVERRIDES_FOR_GWPY="{local_scheme='no-local-version'}";
       fi
     # generate the distributions
     - python -m build . -o .

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/qa.yml

@@ -39,6 +39,7 @@ include:
     rules:
       - if: '$GITLAB_FEATURES !~ /\bsast_advanced\b/'
   - local: .gitlab/ci/rules.yml
+  - local: .gitlab/ci/python-base.yml
 
 .qa:
   extends: .rules_qa_security
@@ -63,7 +64,7 @@ semgrep-sast:
 
 ruff:
   extends: .qa
-  image: python
+  image: quay.io/lib/python
   script:
     - python -m pip install
           ruff
@@ -84,7 +85,7 @@ ruff:
 
 mypy:
   extends: .qa
-  image: python
+  image: quay.io/lib/python
   script:
     - python -m pip install
           mypy
@@ -107,3 +108,16 @@ mypy:
   artifacts:
     reports:
       codequality: gl-mypy-code-quality.json
+
+rstcheck:
+  extends:
+    - .python_base
+    - .qa
+  image: quay.io/lib/python
+  script:
+    - python -m pip install rstcheck[sphinx]
+    - python .gitlab/ci/rstcheck.py > rstcheck.json
+    - python -m json.tool rstcheck.json
+  artifacts:
+    reports:
+      codequality: rstcheck.json

gwpy-3.0.13/.gitlab/ci/rstcheck.py

@@ -0,0 +1,108 @@
+"""Run rstcheck and report output for codeclimate."""
+
+from __future__ import annotations
+
+import hashlib
+import json
+import re
+import sys
+import typing
+from pathlib import Path
+
+from rstcheck_core.config import RstcheckConfig
+from rstcheck_core.runner import RstcheckMainRunner
+
+if typing.TYPE_CHECKING:
+    from typing import Literal
+
+    from rstcheck_core.types import LintError
+
+MESSAGE_RE = re.compile(
+    r"\((?P<severity>[A-Z]+)/[0-9]+\)(\s+)(?P<message>.*)",
+)
+SEVERITY: dict[str, str] = {
+    "ERROR": "major",
+    "SEVERE": "major",
+    "INFO": "info",
+    "WARNING": "minor",
+}
+
+
+class CodeQualityLocation(typing.TypedDict):
+    """Location parameter in a `CodeQualityItem`."""
+
+    path: str
+    lines: dict[str, int]
+
+
+class CodeQualityItem(typing.TypedDict):
+    """Gitlab Code Quality item.
+
+    See <https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format>.
+    """
+
+    description: str
+    check_name: str
+    fingerprint: str
+    severity: Literal["info", "minor", "major", "critical", "blocker"]
+    location: CodeQualityLocation
+
+
+def rstcheck(
+    config_path: Path,
+    check_paths: list[str | Path],
+    *,
+    recursive: bool = True,
+) -> RstcheckMainRunner:
+    """Create, execute, and return an `rstcheck_core.runner.RstcheckMainRunner`."""
+    config = RstcheckConfig(
+        config_path=config_path,
+        recursive=recursive,
+    )
+    runner = RstcheckMainRunner(
+        check_paths=list(map(Path, check_paths)),
+        rstcheck_config=config,
+    )
+    runner.check()
+    return runner
+
+
+def codeclimate_item(item: LintError) -> CodeQualityItem:
+    """Construct a codeclimate item for this rstcheck lint error."""
+    fingerprint = hashlib.sha1(
+        "".join(map(str, item.values())).encode("utf-8"),
+        usedforsecurity=False,
+    ).hexdigest()
+    match = MESSAGE_RE.match(item["message"]).groupdict()
+    return {
+        "check_name": match["message"],
+        "description": match["message"],
+        "fingerprint": fingerprint,
+        "location": {
+            "path": str(item["source_origin"]),
+            "lines": {
+                "begin": (lineno := int(item["line_number"])),
+                "end": lineno,
+            },
+        },
+        "severity": SEVERITY.get(match["severity"], "info"),
+    }
+
+
+def codeclimate(items: list[LintError]) -> list[CodeQualityItem]:
+    """Parse a list of errors for codeclimate."""
+    return [codeclimate_item(item) for item in items]
+
+
+def main() -> None:
+    """Run `rstcheck` and print a codeclimate JSON report."""
+    results = rstcheck(
+        Path("pyproject.toml"),
+        ["docs"],
+    )
+    issues = codeclimate(results.errors)
+    json.dump(issues, sys.stdout)
+
+
+if __name__ == "__main__":
+    main()

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/rules.yml

@@ -15,18 +15,18 @@ spec:
   rules:
     - if: $CI_COMMIT_TAG
 
-# default branch (all pipelines)
-.rules_default:
+# protected branch (main or release/xxx, all pipelines)
+.rules_protected:
   rules:
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: '$CI_COMMIT_BRANCH && $CI_COMMIT_REF_PROTECTED == "true"'
 
-# default branch push (not schedules)
-.rules_default_push:
+# protected branch push (not schedules)
+.rules_protected_push:
   rules:
-    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH && $CI_COMMIT_REF_PROTECTED == "true"'
 
 # schedules on default branch
-.rules_default_schedule:
+.rules_protected_schedule:
   rules:
     - if: '$CI_PIPELINE_SOURCE == "schedule" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
@@ -41,6 +41,10 @@ spec:
     # not on branches with an open merge request
     - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
       when: never
+    # not on protected branches
+    - if: $CI_COMMIT_BRANCH && $CI_COMMIT_REF_PROTECTED == "true"
+      when: never
+    # all other branches
     - if: $CI_COMMIT_BRANCH
 
 # -- job types
@@ -53,20 +57,20 @@ spec:
 # nightly builds
 .rules_nightly:
   rules:
-    - !reference [.rules_default_schedule, rules]
+    - !reference [.rules_protected_schedule, rules]
 
 # build jobs
 .rules_build:
   rules:
     - !reference [.rules_tag, rules]
-    - !reference [.rules_default_push, rules]
+    - !reference [.rules_protected_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_protected, rules]
     - !reference [.rules_merge_request, rules]
 
 # basic test suite
@@ -76,6 +80,6 @@ spec:
 
 .rules_qa_security:
   rules:
-    - !reference [.rules_default, rules]
+    - !reference [.rules_protected, rules]
     - !reference [.rules_nightly, rules]
     - !reference [.rules_merge_request, rules]

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/sphinx.yml

@@ -7,7 +7,7 @@ spec:
       description: "Pipeline stage in which to add jobs"
       type: string
     image:
-      default: python
+      default: quay.io/lib/python
       description: "Container image to build in"
       type: string
     requirements:

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/test-job.yml

@@ -18,6 +18,10 @@ spec:
       default: "test"
       description: "Name of the extra feature group(s) to install when installing <install_target>"
       type: string
+    pip_cmd:
+      default: "python -m pip"
+      description: "Command to use to install packages (default: python -m pip)"
+      type: string
     pip_options:
       default: ""
       description: "Extra options to pass to pip install"
@@ -58,10 +62,10 @@ include:
       (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 ]]
+    - $[[ inputs.pip_cmd ]] install pytest pytest-cov $[[ inputs.pip_options ]]
+    - $[[ inputs.pip_cmd ]] install $[[ inputs.install_target ]][$[[ inputs.install_extra ]]] $[[ inputs.pip_options ]]
     # list installed packages
-    - python -m pip list installed
+    - $[[ inputs.pip_cmd ]] list
 # run the tests
     - python -m pytest --junit-xml=junit.xml $[[ inputs.pytest_options ]]
     # run any extra tests
@@ -80,7 +84,7 @@ include:
       - .coverage*
   coverage: null
   cache:
-    # cache pip packages
+    # cache Pip downloads
     - !reference [.python_base, cache]
     # cache GWpy downloaded files
     - key: "gwpy-${CI_JOB_NAME_SLUG}"

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/test.yml

@@ -8,12 +8,14 @@ include:
   - local: .gitlab/ci/test-job.yml
     inputs:
       job_name: "basic_test"
+      pip_cmd: "uv pip"
       pytest_options: "--color yes --cov gwpy --numprocesses auto gwpy/"
       install_extra: "test"
 
   # full test template
   - local: .gitlab/ci/test-job.yml
     inputs:
+      pip_cmd: "uv pip"
       pytest_options: "--color yes --cov gwpy --durations 50 --numprocesses auto gwpy/ examples/"
       install_extra: "dev,test"
 
@@ -69,6 +71,51 @@ include:
     paths:
       - .cache/choco
 
+.uv_install: &uv_install
+  # install uv
+  - wget -qO- https://astral.sh/uv/install.sh | sh -s - -q
+  - source ${XDG_BIN_HOME:-$HOME/.local/bin}/env
+
+.uv_venv: &uv_venv
+  # configure a virtual environment for the right Python version
+  - uv venv --python ${PYTHON_VERSION}
+  - source .venv/bin/activate
+
+.uv_install_windows: &uv_install_windows
+  # install uv
+  - powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+  - $env:PATH = $env:USERPROFILE + "\.local\bin;$env:PATH"
+  - $env:PATH -split ';'
+
+.uv_venv_windows: &uv_venv_windows
+  # configure a virtual environment for the right Python version
+  - uv venv --python ${PYTHON_VERSION}
+  - .venv\Scripts\activate
+
+.uv:
+  image: "ghcr.io/astral-sh/uv:python$PYTHON_VERSION-bookworm"
+  variables:
+    # set the cache directory for uv
+    UV_CACHE_DIR: "$CI_PROJECT_DIR/.cache/uv"
+  before_script:
+    - *uv_install
+    - *uv_venv
+  after_script:
+    - uv cache prune --ci
+  cache:
+    # cache uv packages
+    - key: "uv-${CI_JOB_NAME_SLUG}"
+      paths:
+        - $UV_CACHE_DIR
+
+.uv_windows:
+  extends:
+    - .uv
+    - .windows
+  before_script:
+    - *uv_install_windows
+    - *uv_venv_windows
+
 # -- basic tests for new branches without MRs
 #
 # This test matrix provides a sanity check for developers working
@@ -83,7 +130,8 @@ basic_test:
   extends:
     - .prod_test
     - .basic_test
-  image: python:${PYTHON_VERSION}
+    - .uv
+  image: "ghcr.io/astral-sh/uv:python$PYTHON_VERSION-bookworm"
   rules:
     - !reference [.rules_basic_test, rules]
 
@@ -101,17 +149,21 @@ basic_test:
 python_test_linux:
   extends:
     - .dev_test
+    - .uv
     - .linux
-  image: python:${PYTHON_VERSION}
   rules:
     - !reference [.linux, rules]
     - !reference [.rules_full_test, rules]
+  before_script:
+    # don't need to install uv, it comes with the image
+    - *uv_venv
 
 # macOS
 python_test_macos:
   extends:
     - .prod_test
-    - .brew
+    - .uv
+    - .macos
   rules:
     - !reference [.macos, rules]
     - !reference [.rules_full_test, rules]
@@ -121,41 +173,15 @@ python_test_macos:
           - "3.10"
           - "3.11"
           #- "3.12" <-- cannot build ligo-segments on macOS
-  before_script:
-    # install Python using Homebrew
-    - brew install python@${PYTHON_VERSION}
-    - PYTHON="$(brew --prefix)/opt/python@${PYTHON_VERSION}/libexec/bin/python"
-    # create a virtual environment to work in
-    - $PYTHON -m venv --system-site-packages venv
-    - . ./venv/bin/activate
-  cache:
-    # cache pip packages
-    - !reference [.test, cache]
-    # and homebrew packages
-    - !reference [.brew, cache]
 
 # Windows
 python_test_windows:
   extends:
     - .prod_test
-    - .choco
+    - .uv_windows
   rules:
     - !reference [.windows, rules]
     - !reference [.rules_full_test, rules]
-  before_script:
-    # install Python using Choco
-    - $PYTHON_VERSION_NODOTS = ${PYTHON_VERSION}.Replace('.', '')
-    - choco install
-        --cache $CHOCO_CACHE_DIR
-        --yes
-        python${PYTHON_VERSION_NODOTS}
-    - $env:PATH += ";C:\Python" + ${PYTHON_VERSION_NODOTS} + ";C:\Python" + ${PYTHON_VERSION_NODOTS} + "\Scripts"
-    - echo $PYTEST_ADDOPTS
-  cache:
-    # cache pip packages
-    - !reference [.test, cache]
-    # and choco packages
-    - !reference [.choco, cache]
 
 # -- conda tests
 #
@@ -169,12 +195,21 @@ python_test_windows:
 .conda_create_test_env:
   before_script:
     - conda info --all
-    - conda create --quiet --yes --name pip2conda pip2conda
-    - conda run -n pip2conda pip2conda
+    # create an (almost) empty environment
+    - conda create -n pip2conda
+        --yes
+        --quiet
+        python
+    - conda activate pip2conda
+    # and use uv to install pip2conda into it
+    - uv pip install pip2conda
+    # then use pip2conda to solve (sort of) the test environment
+    - python -m pip2conda
         --all
         --output environment.txt
         --python-version ${PYTHON_VERSION}
     - cat environment.txt
+    # create the test environment
     - conda create --quiet --yes --name test --file environment.txt
     - conda list --name test
     - conda activate test
@@ -182,11 +217,12 @@ python_test_windows:
 .conda_test:
   extends:
     - .prod_test
+    - .uv
   stage: conda
   variables:
     CONDA_PKGS_DIRS: "${CI_PROJECT_DIR}/.cache/conda/pkgs"
   cache:
-    - !reference [.test, cache]
+    - !reference [.uv, cache]
     - key: "conda-${CI_JOB_NAME_SLUG}"
       paths:
         - .cache/conda/pkgs/*.conda
@@ -199,11 +235,13 @@ conda_test_linux:
   rules:
     - !reference [.linux, rules]
     - !reference [.rules_full_test, rules]
-  image: condaforge/miniforge3
+  image: quay.io/condaforge/miniforge3
   before_script:
+    # install uv
+    - *uv_install
     # init conda
     - . $(conda info --base)/etc/profile.d/conda.sh
-    # create test environment using pip2conda
+    # create the test environment using conda, uv, and pip2conda
     - !reference [.conda_create_test_env, before_script]
     # initialise credentials
     - bash -ex .gitlab/ci/init-creds.sh
@@ -222,20 +260,25 @@ conda_test_macos:
     # then do the same init as Linux
     - !reference [conda_test_linux, before_script]
   cache:
-    # cache conda packages
+    # cache uv/conda packages
     - !reference [.conda_test, cache]
     # and homebrew packages
     - !reference [.brew, cache]
 
 # Windows
 conda_test_windows:
+  # allow windows a bit more time for provisioning
+  timeout: 90m
   extends:
     - .conda_test
     - .choco
+    - .uv_windows
   rules:
     - !reference [.windows, rules]
     - !reference [.rules_full_test, rules]
   before_script:
+    # install uv
+    - *uv_install_windows
     # install miniforge using choco
     - choco install
         --cache $CHOCO_CACHE_DIR
@@ -244,7 +287,7 @@ conda_test_windows:
     - $env:PATH += ";C:\tools\miniforge3\Scripts;C:\tools\miniforge3"
     - conda init powershell
     - . C:\tools\miniforge3\shell\condabin\conda-hook.ps1
-    # create the test environment using conda
+    # create the test environment using conda, uv, and pip2conda
     - !reference [.conda_create_test_env, before_script]
   cache:
     # cache conda packages

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab/ci/twine.yml

@@ -19,7 +19,7 @@ twine:
       when: never
     - !reference [.rules_deploy, rules]
   stage: $[[ inputs.stage ]]
-  image: python
+  image: quay.io/lib/python
   environment:
     name: $PYPI_REPOSITORY
     url: https://$PYPI_HOSTNAME/project/$CI_PROJECT_NAME
@@ -59,7 +59,7 @@ twine_test:
   rules:
     - if: '$CI_COMMIT_MESSAGE =~ /\[skip deploy\]/'
       when: never
-    - !reference [.rules_default_push, rules]
+    - !reference [.rules_protected_push, rules]
   variables:
     PYPI_REPOSITORY: "testpypi"
     PYPI_HOSTNAME: "test.pypi.org"

{gwpy-3.0.11 → gwpy-3.0.13}/.gitlab-ci.yml

@@ -22,7 +22,11 @@ default:
   retry:
     max: 2
     when:
+      - job_execution_timeout
       - runner_system_failure
+      - stuck_or_timeout_failure
+  # no job should take more than an hour
+  timeout: 1h
 
 include:
   # -- Quality assurance checks

gwpy-3.0.13/.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: "ubuntu-lts-latest"
+  tools:
+    python: "mambaforge-latest"
+  jobs:
+    post_install:
+      # show what is installed in the build environment
+      - conda list
+
+conda:
+  environment: docs/environment.yaml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
+        - docs
+
+sphinx:
+  builder: dirhtml
+  configuration: docs/conf.py