Skip to content

Relocate the top-level validate() into the hdmf.validate package #1530

Description

@rly

Motivation

Part of the #608 cleanup. The public top-level validate() currently lives in src/hdmf/common/__init__.py, but hdmf.common is the module for the hdmf-common data types; validation is orthogonal to it. The hdmf.validate subpackage already houses the validator classes (ValidatorMap, Validator, ...) but exposes no validate() function.

Proposed change (target a major release)

Depends on #1529 (the namespace-aware validation dispatcher).

Acceptance criteria

  • hdmf.validate.validate(io) validates against all loaded namespaces in one pass.
  • hdmf.common.validate(...) still imports and works (deprecated shim).
  • Docs/CHANGELOG updated for the new canonical location and the deprecation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions