datalad_next.constraints.git

Constraints for Git-related concepts and parameters

class datalad_next.constraints.git.EnsureGitRefName(allow_onelevel: bool = True, normalize: bool = True, refspec_pattern: bool = False)[source]

Bases: Constraint

Ensures that a reference name is well formed

Validation is performed by calling git check-ref-format.

short_description()[source]

This method is deprecated. Use input_synopsis instead

class datalad_next.constraints.git.EnsureRemoteName(known: bool | None = None, dsarg: DatasetParameter | None = None)[source]

Bases: Constraint

Ensures a valid remote name, and optionally if such a remote is known

for_dataset(dataset: DatasetParameter) Constraint[source]

Return an similarly parametrized variant that checks remote names against a given dataset (argument)

short_description()[source]

This method is deprecated. Use input_synopsis instead

class datalad_next.constraints.git.EnsureSiblingName(known: bool | None = None, dsarg: DatasetParameter | None = None)[source]

Bases: EnsureRemoteName

Identical to EnsureRemoteName, but used the term "sibling"

Only error messages and documentation differ, with "remote" being replaced with "sibling".