capella2polarion.data_model package¶

A module for custom data models of cappela2polarion.

Submodules¶

capella2polarion.data_model.converter_config module¶

Module providing pydantic classes for the converter config.

class capella2polarion.data_model.converter_config.AddAttributesParams(*, attributes: list[dict[str, str]] = [])¶

Bases: BaseModel

Parameters for ‘add_attributes’ serializer.

attributes: list[dict[str, str]]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod normalize_attribute_items(attributes: list[str | dict[str, Any]]) → list[dict[str, str]]¶: Normalize string entries to the dictionary format during input.

class capella2polarion.data_model.converter_config.AddJinjaFieldsParams(*, fields: dict[str, Any] = {})¶

Bases: BaseModel

Parameters for ‘add_jinja_fields’, expects a dict of fields.

classmethod ensure_input_is_fields_dict(values: dict[str, Any]) → dict[str, Any]¶: Ensure the input dict has the ‘fields’ key.

fields: dict[str, t.Any]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class capella2polarion.data_model.converter_config.BaseModel¶

Bases: BaseModel

Custom base model for common configuration.

class Config¶

Bases: object

Config for BaseModel.

extra = 'forbid'¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Bases: BaseModel

Represents a single entry for a Capella type config from YAML.

is_actor: bool | None¶

links: list[str | LinkConfigInput]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nature: str | None¶

classmethod normalize_link_input(v: Any) → list[dict[str, Any]] | Any¶: Allow link input list items as string or dict.

classmethod normalize_serializer_input(v: Any) → dict[str, Any] | Any¶: Normalize various serializer input formats to a dictionary.

polarion_type: str | None¶

serializer: None | str | list[str] | dict[str, t.Any]¶

class capella2polarion.data_model.converter_config.CapellaTypeConfigProcessed(*, p_type: str, converters: dict[str, BaseModel] = {}, links: list[LinkConfigProcessed] = [], is_actor_specifier: bool | None = None, nature_specifier: str | None = None)¶

Bases: BaseModel

Represents a fully validated and processed type configuration.

class Config¶

Bases: object

Config for CapellaTypeConfigProcessed.

arbitrary_types_allowed = True¶

converters: dict[str, BaseModel]¶

is_actor_specifier: bool | None¶

links: list[LinkConfigProcessed]¶

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nature_specifier: str | None¶

p_type: str¶

class capella2polarion.data_model.converter_config.DiagramFilter(*, func: Callable, args: dict[str, Any] = {})¶

Bases: BaseModel

Represents a single filter function reference.

class Config¶

Bases: object

Config for DiagramFilter.

arbitrary_types_allowed = True¶

args: dict[str, t.Any]¶

func: t.Callable¶

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod resolve_filter_func(filter_id: str) → Callable¶: Resolve filter function name string to callable.

class capella2polarion.data_model.converter_config.DiagramParams(*, filters: list[DiagramFilter] = [], render_params: dict[str, Any] = {})¶

Bases: BaseModel

Parameters for diagram serializers like ‘add_context_diagram’.

filters: list[DiagramFilter]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod normalize_filter_input(items: list[str | dict[str, Any]]) → list[dict[str, Any]] | Any¶: Handle diagram filters.

render_params: dict[str, t.Any]¶

class capella2polarion.data_model.converter_config.FullConfigInput(root: RootModelRootType = PydanticUndefined)¶

Bases: RootModel[dict[str, dict[str, list[CapellaTypeConfigInput]]]]

Parses the entire YAML structure, ensuring types map to lists.

classmethod ensure_type_configs_are_lists(values: Any) → Any¶: Ensure that each Capella type maps to a list of configs.

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: dict[str, dict[str, list[CapellaTypeConfigInput]]]¶

class capella2polarion.data_model.converter_config.JinjaAsDescriptionParams(*, template_folder: Annotated[Path, PathType(path_type=dir)], template_path: str, resolved_template_path: Path | None = None)¶

Bases: BaseModel

Parameters for ‘jinja_as_description’ serializer.

check_full_template_path() → JinjaAsDescriptionParams¶: Check existence of resolved template path.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resolved_template_path: pathlib.Path | None¶

template_folder: DirectoryPath¶

template_path: str¶

class capella2polarion.data_model.converter_config.LinkConfigInput(*, capella_attr: str, polarion_role: str | None = None, include: ~capella2polarion.data_model.converter_config.LinkIncludeConfig = <factory>, link_field: str | None = None, reverse_field: str | None = None)¶

Bases: BaseModel

Raw input structure for a link config (dict format from YAML).

capella_attr: str¶

include: LinkIncludeConfig¶

link_field: str | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

polarion_role: str | None¶

reverse_field: str | None¶

class capella2polarion.data_model.converter_config.LinkConfigProcessed(*, capella_attr: str, polarion_role: str | None = None, include: ~capella2polarion.data_model.converter_config.LinkIncludeConfig = <factory>, link_field: str | None = None, reverse_field: str | None = None)¶

Bases: LinkConfigInput

Processed Link Config.

Defaults are applied and prefixes potentially added.

capella_attr¶: The attribute name on the capellambse model object.

polarion_role¶: The identifier used in Polarion for the link role (guaranteed).

include¶: Dictionary mapping display names to included attributes from linked objects.

link_field¶: The Polarion field name for the forward link (guaranteed).

reverse_field¶: The Polarion field name for the reverse link (guaranteed).

classmethod apply_link_defaults(values: dict[str, Any]) → dict[str, Any]¶: Derive role, link_field, reverse_field if not provided.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class capella2polarion.data_model.converter_config.LinkIncludeConfig(root: RootModelRootType = PydanticUndefined)¶

Bases: RootModel[dict[str, str]]

Represents the ‘include’ dictionary: {DisplayName: capella_attr}.

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: dict[str, str]¶

class capella2polarion.data_model.converter_config.SimpleParams(**extra_data: Any)¶

Bases: BaseModel

Parameters for simple serializers (accepts any dict or empty).

class Config¶

Bases: object

Config for SimpleParams.

extra = 'allow'¶

model_config: ClassVar[ConfigDict] = {'extra': 'allow'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

capella2polarion.data_model.document_data module¶

Module providing data classes for documents.

class capella2polarion.data_model.document_data.DocumentData(document: Document, headings: list[WorkItem], text_work_item_provider: TextWorkItemProvider)¶

Bases: object

A class to store data related to a rendered document.

document: Document¶

headings: list[WorkItem]¶

text_work_item_provider: TextWorkItemProvider¶

class capella2polarion.data_model.document_data.DocumentInfo(project_id: str | None, module_folder: str, module_name: str, text_work_item_type: str, text_work_item_id_field: str)¶

Bases: object

Class for information regarding a document which should be created.

module_folder: str¶

module_name: str¶

project_id: str | None¶

text_work_item_id_field: str¶

text_work_item_type: str¶

capella2polarion.data_model.work_item_attachments module¶

Module providing the CapellaWorkItemAttachment classes.

class capella2polarion.data_model.work_item_attachments.Capella2PolarionAttachment(work_item_id: str, id: str, title: str | None = None, content_bytes: bytes | None = None, mime_type: str | None = None, file_name: str | None = None, _checksum: str | None = None)¶

Bases: WorkItemAttachment

Stub Base-Class for Capella2Polarion attachments.

property content_checksum: str¶: Calculate the checksum for the content of the attachment.

class capella2polarion.data_model.work_item_attachments.CapellaContextDiagramAttachment(diagram: ContextDiagram, file_name: str, render_params: dict[str, Any] | None, title: str)¶

Bases: CapellaDiagramAttachment

A dedicated attachment type for Capella context diagrams.

Implements a checksum property using the elk input instead of content. This will speed up the checksum calculation a lot.

property content_checksum: str¶: Return checksum based on elk input for ContextDiagrams else None.

class capella2polarion.data_model.work_item_attachments.CapellaDiagramAttachment(diagram: AbstractDiagram, file_name: str, render_params: dict[str, Any] | None, title: str)¶

Bases: Capella2PolarionAttachment

A class for lazy loading content_bytes for diagram attachments.

property content_bytes: bytes | None¶: Diagrams are only rendered, if content_bytes are requested.

class capella2polarion.data_model.work_item_attachments.PngConvertedSvgAttachment(attachment: WorkItemAttachment)¶

Bases: Capella2PolarionAttachment

A special attachment type for PNGs which shall be created from SVGs.

An SVG attachment must be provided to create this attachment. The actual conversion of SVG to PNG takes place when content bytes are requested. For that reason creating this attachment does not trigger diagram rendering as long as context_bytes aren’t requested.

property content_bytes: bytes | None¶: The content bytes are created from the SVG when requested.

capella2polarion.data_model.work_item_attachments.calculate_content_checksum(attachment: WorkItemAttachment) → str¶: Calculate content checksum for an attachment.

capella2polarion.data_model.work_items module¶

Module providing the CapellaWorkItem class.

class capella2polarion.data_model.work_items.CapellaWorkItem(id: str | None = None, *, title: str | None = None, description_type: str | None = None, description: TextContent | str | None = None, type: str | None = None, status: str | None = None, additional_attributes: dict[str, Any] | None = None, linked_work_items: list[WorkItemLink] | None = None, attachments: list[WorkItemAttachment] | None = None, linked_work_items_truncated: bool = False, attachments_truncated: bool = False, home_document: DocumentReference | None = None, **kwargs)¶

Bases: WorkItem

A WorkItem class with additional Capella related attributes.

property attachment_checksums: dict[str, str]¶: Return attachment checksums.

calculate_checksum() → str¶

Calculate and return a checksum for this WorkItem.

In addition, the checksum will be written to self._checksum. Filenames must be unique and same filenames are only valid for png&svg pairs.

checksum: str | None¶

clear_attributes()¶: Clear all additional attributes except the checksum.

property content_checksum: str¶: Return checksum of the WorkItem content.

postCondition: polarion_api.HtmlContent | None¶

preCondition: polarion_api.HtmlContent | None¶

uuid_capella: str¶