clowder.data.model package¶
Submodules¶
clowder.data.model.clowder module¶
Representation of clowder yaml clowder
-
class
clowder.data.model.clowder.
Clowder
(yaml: Union[dict, List[clowder.data.model.project.Project]])¶ Bases:
object
clowder yaml Clowder model class
Variables: -
get_yaml
(resolved: bool = False) → Union[dict, list]¶ Return python object representation for saving yaml
Parameters: resolved (bool) – Whether to get resolved commit hashes Returns: YAML python object Return type: Union[dict, list]
-
clowder.data.model.clowder_base module¶
Representation of clowder yaml loader
-
class
clowder.data.model.clowder_base.
ClowderBase
(yaml: dict)¶ Bases:
object
clowder yaml base class
Variables: -
get_yaml
(resolved: bool = False) → dict¶ Return python object representation for saving yaml
Parameters: resolved (bool) – Whether to get resolved commit hashes Returns: YAML python object Return type: dict
-
clowder.data.model.defaults module¶
Representation of clowder yaml defaults
-
class
clowder.data.model.defaults.
Defaults
(yaml: dict)¶ Bases:
object
clowder yaml Defaults model class
Variables: - source (Optional[SourceName]) – Default source name
- remote (Optional[str]) – Default remote name
- git_settings (Optional[GitSettings]) – Custom git settings
- branch (Optional[str]) – Default git branch
- tag (Optional[str]) – Default git tag
- commit (Optional[str]) – Default commit sha-1
- upstream_defaults (Optional[UpstreamDefaults]) – Upstream defaults
-
get_formatted_ref
() → Optional[str]¶ Return formatted git ref
Returns: Formatted git ref Return type: str
-
get_yaml
() → dict¶ Return python object representation for saving yaml
Returns: YAML python object Return type: dict
clowder.data.model.git_settings module¶
Representation of clowder yaml git settings
-
class
clowder.data.model.git_settings.
GitSettings
(yaml: dict)¶ Bases:
object
clowder yaml GitSettings model class
Variables: - submodules (Optional[bool]) – Whether to fetch submodules
- lfs (Optional[bool]) – Whether to set up lfs hooks and pull files
- depth (Optional[int]) – Depth to clone git repositories
- config (Optional[GitConfig]) – Custom git config values to set
-
get_yaml
() → dict¶ Return python object representation for saving yaml
Returns: YAML python object Return type: dict
clowder.data.model.group module¶
Representation of clowder yaml group
-
class
clowder.data.model.group.
Group
(name: str, yaml: Union[dict, List[clowder.data.model.project.Project]])¶ Bases:
object
clowder yaml Group model class
Variables: - name (str) – Group name
- path (Optional[Path]) – Group path prefix
- groups (Optional[List[Group]]) – Group names
- defaults (Optional[Defaults]) – Group defaults
- projects (List[Project]) – Group projects
- protocol (Optional[str]) – Git protocol
- _has_projects_key (bool) – Whether the projects were listed under the ‘projects’ key in the yaml file
-
get_yaml
(resolved: bool = False) → Union[dict, list]¶ Return python object representation for saving yaml
Returns: YAML python object Return type: Union[dict, list]
clowder.data.model.project module¶
Representation of clowder yaml project
-
class
clowder.data.model.project.
Project
(yaml: Union[dict, str])¶ Bases:
object
clowder yaml Project model class
Variables: - resolved_project_id (Optional[int]) – Identifier for ResolvedProject instance created from this Project
- name (str) – Project name
- path (Optional[Path]) – Project relative path
- branch (Optional[str]) – Git branch
- tag (Optional[str]) – Git tag
- commit (Optional[str]) – Git commit
- groups (Optional[List[str]]) – Groups project belongs to
- remote (Optional[str]) – Project remote name
- SourceName]] source (Optional[Union[Source,) – Project source
- git_settings (Optional[GitSettings]) – Custom git settings
- upstream (Optional[Upstream]) – Project’s associated Upstream
-
get_formatted_ref
() → Optional[str]¶ Return formatted git ref
Returns: Formatted git ref Return type: Optional[str]
-
get_yaml
(resolved: bool = False) → Union[dict, str]¶ Return python object representation for saving yaml
Parameters: resolved (bool) – Whether to get resolved commit hashes Returns: YAML python object Return type: Union[dict, str]
clowder.data.model.source module¶
Representation of clowder yaml source
-
class
clowder.data.model.source.
Source
(name: clowder.data.model.source_name.SourceName, yaml: Dict[str, str])¶ Bases:
object
clowder yaml Source model class
Variables: - name (SourceName) – Source name
- url (str) – Git project url
- protocol (Optional[str]) – Git protocol
-
get_yaml
() → Dict[str, str]¶ Return python object representation for saving yaml
Returns: YAML python object Return type: Union[dict, str]
clowder.data.model.source_name module¶
Representation of clowder yaml source name
clowder.data.model.upstream module¶
Representation of clowder yaml upstream
-
class
clowder.data.model.upstream.
Upstream
(yaml: Union[str, dict])¶ Bases:
object
clowder yaml Upstream model class
Variables: - name (str) – Upstream name
- path (str) – Project relative path
- SourceName]] source (Optional[Union[Source,) – Upstream source
- remote (Optional[str]) – Upstream remote name
-
get_yaml
() → Union[str, dict]¶ Return python object representation for saving yaml
Returns: YAML python object Return type: Union[str, dict]
clowder.data.model.upstream_defaults module¶
Representation of clowder yaml upstream defaults
-
class
clowder.data.model.upstream_defaults.
UpstreamDefaults
(yaml: dict)¶ Bases:
object
clowder yaml UpstreamDefaults model class
Variables: - source (Optional[SourceName]) – Default source name
- remote (Optional[str]) – Default remote name
-
get_yaml
() → dict¶ Return python object representation for saving yaml
Returns: YAML python object Return type: dict
Module contents¶
clowder.data.model module __init__