Skip to main content

Branch Defaults

Branch naming defaults for SpecifyX

Overview​

This module provides centralized, immutable branch naming configurations that are packaged with SpecifyX. These are developer defaults, not user configuration.

Classes​

BranchNamingDefaults​

Developer defaults for branch naming configurations - packaged with SpecifyX

Dataclass

Methods​

get_all_pattern_names​
get_all_pattern_names(self) -> List[str]

Get list of all supported pattern names

Returns: List

get_default_pattern​
get_default_pattern(self) -> specify_cli.models.defaults.branch_defaults.BranchNamingPattern

Get default branch naming pattern

Returns: BranchNamingPattern

get_display_names​
get_display_names(self) -> Dict[str, str]

Get mapping of pattern name to display description

Returns: Dict

get_pattern_by_name​
get_pattern_by_name(self, name: str) -> specify_cli.models.defaults.branch_defaults.BranchNamingPattern

Get branch naming pattern by name

Parameters:

  • name (str, required)

Returns: BranchNamingPattern

get_pattern_choices​
get_pattern_choices(self) -> List[str]

Get list of pattern names for CLI choices

Returns: List

get_pattern_options_for_ui​
get_pattern_options_for_ui(self) -> Dict[str, Dict[str, Any]]

Get pattern options formatted for UI selection

Returns: Dict

is_supported_pattern​
is_supported_pattern(self, name: str) -> bool

Check if branch naming pattern is officially supported

Parameters:

  • name (str, required)

Returns: bool

validate_pattern_name​
validate_pattern_name(self, name: str) -> str

Validate and normalize pattern name

Parameters:

  • name (str, required)

Returns: str