capella2polarion package

The capella2polarion package.

Subpackages

• capella2polarion.connectors package
  • Submodules
  • capella2polarion.connectors.polarion_repo module
    • DocumentRepository
    • PolarionDataRepository
      • PolarionDataRepository.get_capella_uuid()
      • PolarionDataRepository.get_work_item_by_capella_uuid()
      • PolarionDataRepository.get_work_item_by_polarion_id()
      • PolarionDataRepository.get_work_item_id()
      • PolarionDataRepository.items()
      • PolarionDataRepository.remove_work_items_by_capella_uuid()
      • PolarionDataRepository.update_work_items()
    • check_work_items()
  • capella2polarion.connectors.polarion_worker module
    • CapellaPolarionWorker
      • CapellaPolarionWorker.check_client()
      • CapellaPolarionWorker.compare_and_update_work_item()
      • CapellaPolarionWorker.compare_and_update_work_items()
      • CapellaPolarionWorker.create_documents()
      • CapellaPolarionWorker.create_missing_work_items()
      • CapellaPolarionWorker.delete_orphaned_work_items()
      • CapellaPolarionWorker.get_document()
      • CapellaPolarionWorker.get_missing_link_ids()
      • CapellaPolarionWorker.load_polarion_documents()
      • CapellaPolarionWorker.load_polarion_work_item_map()
      • CapellaPolarionWorker.update_attachments()
      • CapellaPolarionWorker.update_documents()
    • PolarionWorkerParams
    • WORK_ITEMS_IN_PROJECT_QUERY
• capella2polarion.converters package
  • Submodules
  • capella2polarion.converters.converter_config module
    • CapellaTypeConfig
      • CapellaTypeConfig.converters
      • CapellaTypeConfig.is_actor
      • CapellaTypeConfig.links
      • CapellaTypeConfig.nature
      • CapellaTypeConfig.p_type
    • ConverterConfig
      • ConverterConfig.add_layer()
      • ConverterConfig.get_type_config()
      • ConverterConfig.layers_and_types()
      • ConverterConfig.read_config_file()
      • ConverterConfig.set_diagram_config()
      • ConverterConfig.set_global_config()
      • ConverterConfig.set_layer_config()
    • LinkConfig
      • LinkConfig.capella_attr
      • LinkConfig.include
      • LinkConfig.link_field
      • LinkConfig.polarion_role
      • LinkConfig.reverse_field
    • add_prefix()
    • config_matches()
  • capella2polarion.converters.data_session module
    • ConverterData
      • ConverterData.capella_element
      • ConverterData.description_references
      • ConverterData.errors
      • ConverterData.layer
      • ConverterData.type_config
      • ConverterData.work_item
  • capella2polarion.converters.document_config module
    • BaseDocumentRenderingConfig
      • BaseDocumentRenderingConfig.heading_numbering
      • BaseDocumentRenderingConfig.instances
      • BaseDocumentRenderingConfig.model_config
      • BaseDocumentRenderingConfig.project_id
      • BaseDocumentRenderingConfig.status_allow_list
      • BaseDocumentRenderingConfig.template_directory
      • BaseDocumentRenderingConfig.text_work_item_id_field
      • BaseDocumentRenderingConfig.text_work_item_type
      • BaseDocumentRenderingConfig.work_item_layouts
    • DocumentConfigs
      • DocumentConfigs.full_authority
      • DocumentConfigs.iterate_documents()
      • DocumentConfigs.mixed_authority
      • DocumentConfigs.model_config
    • DocumentRenderingInstance
      • DocumentRenderingInstance.model_config
      • DocumentRenderingInstance.params
      • DocumentRenderingInstance.polarion_name
      • DocumentRenderingInstance.polarion_space
      • DocumentRenderingInstance.polarion_title
    • FullAuthorityDocumentRenderingConfig
      • FullAuthorityDocumentRenderingConfig.model_config
      • FullAuthorityDocumentRenderingConfig.template
    • MixedAuthorityDocumentRenderingConfig
      • MixedAuthorityDocumentRenderingConfig.instances
      • MixedAuthorityDocumentRenderingConfig.model_config
      • MixedAuthorityDocumentRenderingConfig.sections
    • SectionBasedDocumentRenderingInstance
      • SectionBasedDocumentRenderingInstance.model_config
      • SectionBasedDocumentRenderingInstance.section_params
    • WorkItemLayout
      • WorkItemLayout.fields_at_end
      • WorkItemLayout.fields_at_start
      • WorkItemLayout.model_config
      • WorkItemLayout.show_description
      • WorkItemLayout.show_fields_as_table
      • WorkItemLayout.show_title
    • generate_work_item_layouts()
    • read_config_file()
  • capella2polarion.converters.document_renderer module
    • AREA_END_CLS
    • AREA_START_CLS
    • DocumentRenderer
      • DocumentRenderer.render_document()
      • DocumentRenderer.render_documents()
      • DocumentRenderer.setup_env()
      • DocumentRenderer.update_mixed_authority_document()
    • ProjectData
      • ProjectData.new_docs
      • ProjectData.updated_docs
    • RenderingSession
      • RenderingSession.document_project_id
      • RenderingSession.heading_ids
      • RenderingSession.headings
      • RenderingSession.inserted_work_item_ids
      • RenderingSession.rendering_layouts
      • RenderingSession.text_work_items
  • capella2polarion.converters.element_converter module
    • CapellaWorkItemSerializer
      • CapellaWorkItemSerializer.diagram_cache_path
      • CapellaWorkItemSerializer.model
      • CapellaWorkItemSerializer.serialize()
      • CapellaWorkItemSerializer.serialize_all()
      • CapellaWorkItemSerializer.setup_env()
    • resolve_element_type()
  • capella2polarion.converters.link_converter module
    • LinkSerializer
      • LinkSerializer.create_grouped_back_link_fields()
      • LinkSerializer.create_grouped_link_fields()
      • LinkSerializer.create_links_for_work_item()
    • find_link_config()
    • make_link_logging_message()
  • capella2polarion.converters.model_converter module
    • ModelConverter
      • ModelConverter.generate_work_item_links()
      • ModelConverter.generate_work_items()
      • ModelConverter.read_model()
  • capella2polarion.converters.polarion_html_helper module
    • JinjaRendererMixin
      • JinjaRendererMixin.check_model_element()
      • JinjaRendererMixin.jinja_envs
      • JinjaRendererMixin.setup_env()
    • camel_case_to_words()
    • ensure_fragments()
    • extract_headings()
    • extract_work_items()
    • generate_image_html()
    • get_layout_index()
    • remove_table_ids()
    • strike_through()
  • capella2polarion.converters.text_work_item_provider module
    • TextWorkItemProvider
      • TextWorkItemProvider.generate_text_work_items()
      • TextWorkItemProvider.insert_text_work_items()
• capella2polarion.data_model package
  • Submodules
  • capella2polarion.data_model.document_data module
    • DocumentData
      • DocumentData.document
      • DocumentData.headings
      • DocumentData.text_work_item_provider
    • DocumentInfo
      • DocumentInfo.module_folder
      • DocumentInfo.module_name
      • DocumentInfo.project_id
      • DocumentInfo.text_work_item_id_field
      • DocumentInfo.text_work_item_type
  • capella2polarion.data_model.work_item_attachments module
    • Capella2PolarionAttachment
      • Capella2PolarionAttachment.content_checksum
    • CapellaContextDiagramAttachment
      • CapellaContextDiagramAttachment.content_checksum
    • CapellaDiagramAttachment
      • CapellaDiagramAttachment.content_bytes
    • PngConvertedSvgAttachment
      • PngConvertedSvgAttachment.content_bytes
    • calculate_content_checksum()
  • capella2polarion.data_model.work_items module
    • CapellaWorkItem
      • CapellaWorkItem.attachment_checksums
      • CapellaWorkItem.calculate_checksum()
      • CapellaWorkItem.checksum
      • CapellaWorkItem.clear_attributes()
      • CapellaWorkItem.content_checksum
      • CapellaWorkItem.postCondition
      • CapellaWorkItem.preCondition
      • CapellaWorkItem.uuid_capella

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.