capella2polarion package

The capella2polarion package.

Subpackages

Submodules

capella2polarion.cli module

Tool for CLI work.

class capella2polarion.cli.Capella2PolarionCli(debug: bool, polarion_project_id: str, polarion_url: str, polarion_pat: str, polarion_delete_work_items: bool, capella_model: MelodyModel | None, force_update: bool = False)

Bases: object

Call Level Interface.

load_synchronize_config(synchronize_config_io: TextIO, type_prefix: str = '', role_prefix: str = '') → None

Read the sync config into SynchronizeConfigContent.

  • example in /tests/data/model_elements/config.yaml

print_state() → None

Print the State of the cli tool.

setup_logger() → None

Set the logger in the right mood.

capella2polarion.errors module

Module for Capella-Polarion errors and handling.

capella2polarion.errors.ERROR_IMAGE = b'<svg xmlns="http://www.w3.org/2000/svg" width="800" height="200">\n  <rect width="800" height="200" fill="#d32f2f"/>\n  <text x="400" y="90" text-anchor="middle" fill="white" font-size="24" font-weight="bold">\n    Capella2Polarion: Diagram Failed to Render\n  </text>\n  <text x="400" y="130" text-anchor="middle" fill="white" font-size="18">\n    Please contact support for assistance\n  </text>\n</svg>'

Static SVG image to use when diagram rendering fails.

capella2polarion.errors.RENDER_ERROR_CHECKSUM = '__RENDER_ERROR__'

Marker used as checksum when diagram rendering fails.

capella2polarion.polarion_html_helper module

Capella2Polarion-specific Polarion HTML helpers.

class capella2polarion.polarion_html_helper.JinjaRendererMixin

Bases: object

A MixIn for converters that render Jinja templates for work items.

check_model_element(obj: object) → ModelElement | AbstractDiagram | None

Check if a model element was passed.

Return None if no element and raise a TypeError if a wrong typed element was passed. Returns the element if it matches expectations.

jinja_envs: dict[str, Environment]
setup_env(env: Environment) → None

Implement this method to adjust a newly created environment.

capella2polarion.polarion_html_helper.TEXT_WORK_ITEM_ID_FIELD = '__C2P__id'

Custom ID field for text work items created by capella2polarion.

The upstream default is __AUTO_RENDER__id; we use a distinct name so documents rendered by this tool can be distinguished.

capella2polarion.polarion_html_helper.add_attachment_to_workitem(work_item: WorkItem, attachment: Capella2PolarionAttachment) → None

Add the attachment to the workitem and add a PNG version if needed.

capella2polarion.polarion_html_helper.strike_through(string: str) → str

Return a striked-through HTML span from string.

If the string is a <deleted element UUID> placeholder, the UUID itself is shown struck-through instead of the full placeholder text.