Merge pull request #2109 from effigies/maint/pyproject-acres

rf(schemacode): Update packaging, minimum Python, resource loading

Author: effigies

.github/workflows/schemacode_ci.yml

@@ -61,7 +61,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         include:
           - os: macos-latest
             python-version: 3

.gitignore

@@ -1,3 +1,5 @@
+src/schema.json
+
 site/
 .DS_Store
 .idea

.pre-commit-config.yaml

@@ -72,9 +72,9 @@ repos:
       - id: mypy
         # Sync with project.optional-dependencies.typing
         additional_dependencies:
+          - acres
           - click
           - markdown-it-py
-          - importlib_resources
           - pandas-stubs
           - pyparsing
           - pytest

tools/schemacode/MANIFEST.in

@@ -1,34 +1,98 @@
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=61.2"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "bidsschematools"
+description = "Python tools for working with the BIDS schema."
+authors = [{name = "bids-standard developers"}]
+maintainers = [{name = "bids-standard developers", email = "[email protected]"}]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "acres",
+    "click",
+    "pyyaml",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+validation = [
+    "jsonschema",
+]
+doc = [
+    "sphinx>=1.5.3",
+    "sphinx_rtd_theme",
+]
+render = [
+    "tabulate",
+    "pandas",
+    "markdown-it-py",
+]
+expressions = ["pyparsing"]
+tests = [
+    "bidsschematools[validation,render,expressions]",
+    "codecov",
+    "coverage[toml]",
+    "flake8",
+    "flake8-black",
+    "flake8-isort",
+    "pytest",
+    "pytest-cov",
+]
+all = [
+    "bidsschematools[doc,tests]",
+]
+
+[project.scripts]
+bst = "bidsschematools.__main__:cli"
+
+[project.urls]
+Homepage = "https://github.com/bids-standard/bids-specification"
+
+[tool.setuptools.package-data]
+bidsschematools = [
+    "data/metaschema.json",
+    "data/schema.json",
+    "data/schema/BIDS_VERSION",
+    "data/schema/SCHEMA_VERSION",
+    "data/schema/**/*.yaml",
+    "tests/data/*",
+]
+
+[tool.setuptools.dynamic]
+version = {file = ["src/bidsschematools/data/schema/SCHEMA_VERSION"]}
+
 [tool.black]
 line-length = 99
-target-version = ['py37']
 include = '\.pyi?$'
-exclude = '''
-(
-  /(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.github
-    | \.hg
-    | \.pytest_cache
-    | _build
-    | build
-    | dist
-  )/
-)
-'''
 
 [tool.isort]
 profile = "black"
 multi_line_output = 3
 
 [tool.pytest.ini_options]
+addopts = "-ra --strict-markers --strict-config"
+log_cli = true
+log_cli_level = "INFO"
 markers = [
   "validate_schema: tests that validate the schema itself",
 ]
+minversion = "6.0"
+xfail_strict = true
+
 
 [tool.coverage.paths]
 source = [

tools/schemacode/pyproject.toml

@@ -1,75 +1,7 @@
-[metadata]
-name = bidsschematools
-version = file:src/bidsschematools/data/schema/SCHEMA_VERSION
-url = https://github.com/bids-standard/bids-specification
-author = bids-standard developers
-author_email = [email protected]
-description = Python tools for working with the BIDS schema.
-long_description = file:README.md
-long_description_content_type = text/markdown; charset=UTF-8; variant=GFM
-license = MIT
-classifiers =
-    Development Status :: 4 - Beta
-    Intended Audience :: Science/Research
-    Topic :: Scientific/Engineering :: Information Analysis
-    License :: OSI Approved :: MIT License
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-    Programming Language :: Python :: 3.11
-
-[options]
-python_requires = >=3.8
-install_requires =
-    click
-    pyyaml
-    importlib_resources; python_version < "3.9"
-    jsonschema
-zip_safe = false
-
-[options.extras_require]
-doc =
-    sphinx>=1.5.3
-    sphinx_rtd_theme
-render =
-    tabulate
-    pandas
-    markdown-it-py
-expressions =
-    pyparsing
-tests =
-    codecov
-    coverage[toml]
-    flake8
-    flake8-black
-    flake8-isort
-    pytest
-    pytest-cov
-all =
-    %(doc)s
-    %(render)s
-    %(tests)s
-    %(expressions)s
-
-[options.package_data]
-bidsschematools =
-    data/metaschema.json
-    data/schema/BIDS_VERSION
-    data/schema/SCHEMA_VERSION
-    data/schema/**/*.yaml
-    tests/data/*
-
-[options.entry_points]
-console_scripts =
-    bst=bidsschematools.__main__:cli
-
 [flake8]
 max-line-length = 99
 exclude = *build/
 ignore = E203,E402,E722,W503
 per-file-ignores =
     */__init__.py : F401
 docstring-convention = numpy
-
-[tool:pytest]
-log_cli = true

tools/schemacode/setup.cfg

@@ -4,15 +4,32 @@
 .. autodata:: __bids_version__
 """
 
-try:  # Prefer backport to leave consistency to dependency spec
-    from importlib_resources import files
-except ImportError:
-    from importlib.resources import files  # type: ignore
-
-version_file = files("bidsschematools.data") / "schema" / "SCHEMA_VERSION"
-__version__ = version_file.read_text().strip()
-"Schema version"
-
-bids_version_file = files("bidsschematools.data") / "schema" / "BIDS_VERSION"
-__bids_version__ = bids_version_file.read_text().strip()
-"BIDS specification version"
+__version__: str
+__bids_version__: str
+
+__all__ = ("__version__", "__bids_version__")
+
+
+def __getattr__(attr: str) -> str:
+    """Lazily load the schema version and BIDS version from the filesystem."""
+    from typing import TypeVar
+
+    from .data import load
+
+    T = TypeVar("T")
+
+    def document(obj: T, docstring: str) -> T:
+        tp = type(obj)
+        return type(tp.__name__, (tp,), {"__doc__": docstring})(obj)
+
+    versions = {
+        "__version__": ("schema/SCHEMA_VERSION", "Schema version"),
+        "__bids_version__": ("schema/BIDS_VERSION", "BIDS specification version"),
+    }
+
+    if attr in versions:
+        resource, docstring = versions[attr]
+        globals()[attr] = document(load.readable(resource).read_text().strip(), docstring)
+        return globals()[attr]
+
+    raise AttributeError(f"module {__spec__.name!r} has no attribute {attr!r}")

tools/schemacode/src/bidsschematools/__init__.py

@@ -7,11 +7,6 @@
 
 import click
 
-if sys.version_info < (3, 9):
-    from importlib_resources import files
-else:
-    from importlib.resources import files
-
 from .rules import regexify_filename_rules
 from .schema import export_schema, load_schema
 from .utils import configure_logger, get_logger
@@ -52,7 +47,9 @@ def export(ctx, schema, output):
 @click.pass_context
 def export_metaschema(ctx, output):
     """Export BIDS schema to JSON document"""
-    metaschema = files("bidsschematools.data").joinpath("metaschema.json").read_text()
+    from .data import load
+
+    metaschema = load.readable("metaschema.json").read_text()
     if output == "-":
         print(metaschema, end="")
     else:

tools/schemacode/src/bidsschematools/__main__.py

@@ -2,9 +2,12 @@
 import tempfile
 from pathlib import Path
 from subprocess import run
+from typing import Generator
 
 import pytest
 
+from . import data
+
 lgr = logging.getLogger()
 
 # This selects a subset of the bids-examples collection to run the test suite on.
@@ -90,12 +93,10 @@ def fixture(tests_data_dir):
 
 
 @pytest.fixture(scope="session")
-def schema_dir():
+def schema_dir() -> Generator[str, None, None]:
     """Path to the schema housed in the bids-specification repo."""
-    from bidsschematools import utils
-
-    bids_schema = utils.get_bundled_schema_path()
-    return bids_schema
+    with data.load.as_path("schema") as schema_path:
+        yield str(schema_path)
 
 
 @pytest.fixture(scope="session")