Skip to content

crv.core.versioning

Experimental API

Version helpers may change while APIs converge toward 1.0. Since: 2025-09-25.

crv.core.versioning

Schema version metadata and helpers for CRV JSON schemas and table descriptors.

Exposes the canonical schema version (SCHEMA_V) used across artifacts and provides compatibility and successor checks. This module is zero-IO.

Notes
  • Downstream components embed SCHEMA_V to tag produced artifacts.
  • Tests assert constants match SCHEMA_V and validate bump sequences.
  • Loaders/writers may use is_compatible to enforce contract alignment.
References
  • specs: src/crv/core/.specs/spec-0.1.md, spec-0.2.md
  • ADR: src/crv/core/.specs/adr-2025-09-20-core-schema-0.1-and-graphedit-normalization.md

crv.core.versioning.SCHEMA_MAJOR_VERSION module-attribute 

SCHEMA_MAJOR_VERSION = 0

crv.core.versioning.SCHEMA_MINOR_VERSION module-attribute 

SCHEMA_MINOR_VERSION = 1

crv.core.versioning.SCHEMA_V module-attribute 

SCHEMA_V = crv.core.versioning.SchemaVersion(0, 1, '2025-09-20')

crv.core.versioning.SCHEMA_COMPAT_MAJOR module-attribute 

SCHEMA_COMPAT_MAJOR = crv.core.versioning.SCHEMA_V.major

crv.core.versioning.SCHEMA_COMPAT_MINOR module-attribute 

SCHEMA_COMPAT_MINOR = crv.core.versioning.SCHEMA_V.minor

crv.core.versioning.SchemaVersion dataclass

Immutable semantic version with ISO release date for CRV artifacts.

Attributes:

Name Type Description
major int

Non-negative major component signalling breaking changes.
minor int

Non-negative minor component for additive, non-breaking changes.
date str

ISO YYYY-MM-DD release timestamp retained for JSON/metadata payloads.

Raises:

Type Description
ValueError

If any component is negative or the date is not ISO compliant.
Source code in src/crv/core/versioning.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@dataclass(frozen=True)
class SchemaVersion:
    """
    Immutable semantic version with ISO release date for CRV artifacts.

    Attributes:
        major (int): Non-negative major component signalling breaking changes.
        minor (int): Non-negative minor component for additive, non-breaking changes.
        date (str): ISO YYYY-MM-DD release timestamp retained for JSON/metadata payloads.

    Raises:
        ValueError: If any component is negative or the date is not ISO compliant.
    """

    major: int
    minor: int
    date: str  # ISO YYYY-MM-DD

    def __post_init__(self) -> None:
        if self.major < 0:
            raise ValueError(f"SchemaVersion major must be non-negative, got {self.major}")
        if self.minor < 0:
            raise ValueError(f"SchemaVersion minor must be non-negative, got {self.minor}")
        try:
            date.fromisoformat(self.date)
        except ValueError as exc:
            raise ValueError(
                f"SchemaVersion date must be ISO YYYY-MM-DD, got {self.date!r}"
            ) from exc

crv.core.versioning.SchemaVersion.major instance-attribute 

major: int

crv.core.versioning.SchemaVersion.minor instance-attribute 

minor: int

crv.core.versioning.SchemaVersion.date instance-attribute 

date: str

crv.core.versioning.is_compatible 

is_compatible(ver: crv.core.versioning.SchemaVersion) -> bool

Check whether a version matches the supported schema contract.

Parameters:

Name Type Description Default
ver crv.core.versioning.SchemaVersion

Version descriptor to validate against the canonical schema metadata.

 required

Returns:

Name Type Description
bool bool

True if ver shares both the major and minor numbers with SCHEMA_V; False otherwise.

Examples:

>>> from crv.core.versioning import SchemaVersion, SCHEMA_V, is_compatible
>>> is_compatible(SCHEMA_V)
True
Source code in src/crv/core/versioning.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def is_compatible(ver: SchemaVersion) -> bool:
    """
    Check whether a version matches the supported schema contract.

    Args:
        ver (SchemaVersion): Version descriptor to validate against the canonical schema metadata.

    Returns:
        bool: True if ver shares both the major and minor numbers with SCHEMA_V; False otherwise.

    Examples:
        >>> from crv.core.versioning import SchemaVersion, SCHEMA_V, is_compatible
        >>> is_compatible(SCHEMA_V)
        True
    """
    return ver.major == SCHEMA_COMPAT_MAJOR and ver.minor == SCHEMA_COMPAT_MINOR

crv.core.versioning.is_successor_of 

is_successor_of(
    candidate: crv.core.versioning.SchemaVersion,
    current: crv.core.versioning.SchemaVersion,
) -> bool

Determine whether a version is the immediate successor of another.

CRV schema updates follow semantic versioning semantics
  • Minor bumps increase the minor component while keeping the major fixed.
  • Major bumps increase the major component by exactly one and reset minor to zero.
  • Larger jumps (skipping minor numbers or jumping more than one major version) are non-sequential.

Parameters:

Name Type Description Default
candidate crv.core.versioning.SchemaVersion

Proposed schema revision.

 required
current crv.core.versioning.SchemaVersion

Baseline schema version currently supported.

 required

Returns:

Name Type Description
bool bool

True if candidate immediately follows current; False otherwise.

Examples:

>>> from crv.core.versioning import SchemaVersion, SCHEMA_V, is_successor_of
>>> is_successor_of(SchemaVersion(SCHEMA_V.major, SCHEMA_V.minor + 1, SCHEMA_V.date), SCHEMA_V)
True
>>> is_successor_of(SchemaVersion(SCHEMA_V.major + 1, 0, SCHEMA_V.date), SCHEMA_V)
True
>>> is_successor_of(SchemaVersion(SCHEMA_V.major, SCHEMA_V.minor + 2, SCHEMA_V.date), SCHEMA_V)
False
Source code in src/crv/core/versioning.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def is_successor_of(candidate: SchemaVersion, current: SchemaVersion) -> bool:
    """
    Determine whether a version is the immediate successor of another.

    CRV schema updates follow semantic versioning semantics:
      - Minor bumps increase the minor component while keeping the major fixed.
      - Major bumps increase the major component by exactly one and reset minor to zero.
      - Larger jumps (skipping minor numbers or jumping more than one major version) are non-sequential.

    Args:
        candidate (SchemaVersion): Proposed schema revision.
        current (SchemaVersion): Baseline schema version currently supported.

    Returns:
        bool: True if candidate immediately follows current; False otherwise.

    Examples:
        >>> from crv.core.versioning import SchemaVersion, SCHEMA_V, is_successor_of
        >>> is_successor_of(SchemaVersion(SCHEMA_V.major, SCHEMA_V.minor + 1, SCHEMA_V.date), SCHEMA_V)
        True
        >>> is_successor_of(SchemaVersion(SCHEMA_V.major + 1, 0, SCHEMA_V.date), SCHEMA_V)
        True
        >>> is_successor_of(SchemaVersion(SCHEMA_V.major, SCHEMA_V.minor + 2, SCHEMA_V.date), SCHEMA_V)
        False
    """
    if candidate.major == current.major:
        return candidate.minor == current.minor + 1
    if candidate.major == current.major + 1 and candidate.minor == 0:
        return True
    return False