blark.solution.TcSource

class blark.solution.TcSource(name: 'str', guid: 'str', decl: 'TcDeclImpl', metadata: 'dict[str, str]', filename: 'Optional[pathlib.Path]', parent: 'Optional[TwincatSourceCodeItem]', xml: 'dataclasses.InitVar[lxml.etree.Element | None]' = None, source_type: 'Optional[SourceType]' = None)[source]

Bases: object

Methods

`__init__`(name, guid, decl, metadata, ...[, ...])
`from_contents`(contents[, filename, parent])
`from_filename`(filename[, parent])
`from_xml`(xml[, filename, parent])
`rewrite_code`(identifier, contents)
`to_file_contents`([delimiter])
`to_xml`()

Attributes

`default_source_type`
`source_type`
`xml`
`name`
`guid`
`decl`
`metadata`
`filename`
`parent`

name: str

guid: str

decl: TcDeclImpl

metadata: dict[str, str]

filename: pathlib.Path | None

parent: TwincatSourceCodeItem | None

xml: dataclasses.InitVar[lxml.etree.Element | None] = None

source_type: SourceType | None = None

default_source_type: ClassVar[SourceType | None] = None

rewrite_code(identifier: str, contents: str)[source]

to_file_contents(delimiter: str = '\r\n') → bytes[source]

to_xml() → Element[source]

static from_xml(xml: Element, filename: Path | None = None, parent: TwincatSourceCodeItem | None = None) → TcDUT | TcTTO | TcPOU | TcIO | TcGVL[source]

classmethod from_contents(contents: bytes, filename: Path | None = None, parent: TcSource | None = None) → TcDUT | TcPOU | TcIO | TcTTO | TcGVL[source]

classmethod from_filename(filename: str | Path, parent: TcSource | None = None) → TcDUT | TcPOU | TcIO | TcTTO | TcGVL[source]

__init__(name: str, guid: str, decl: TcDeclImpl, metadata: dict[str, str], filename: pathlib.Path | None, parent: TwincatSourceCodeItem | None, xml: dataclasses.InitVar[lxml.etree.Element | None] = None, source_type: SourceType | None = None) → None