BasicDocument

class BasicDocument
%3 BasicDocument BasicDocument syside.BasicDocument
Children
Members defined in BasicDocument (11 members)

build_state

RW

document_state

R

document_tier

R

language

R

mutex

R

Retrieve the mutex associated with this document

text_document

RW

url

RW

version

R

The version of the last build. This corresponds to the version of TextDocument this was built from.

__hash__

change_document_tier

Set document_tier to another value. This is a method rather than a function because tier should not change throughout document lifetime. Nevertheless, this is still useful in cases where a document has just been constructed and its attributes need to be changed.

increment_version

Increment sema version. Source version is automatically handled by source parser.

Attributes

property build_state: syside.BuildState
property document_state: syside.DocumentState
property document_tier: syside.DocumentTier
property language: str
property mutex: syside.SharedMutex[Self]

Retrieve the mutex associated with this document

property text_document: syside.SharedMutex[syside.TextDocument] | None
property url: syside.Url
property version: syside.DocumentVersion

The version of the last build. This corresponds to the version of TextDocument this was built from.

Methods

__hash__() → int
change_document_tier(arg: syside.DocumentTier, /) → None

Set document_tier to another value. This is a method rather than a function because tier should not change throughout document lifetime. Nevertheless, this is still useful in cases where a document has just been constructed and its attributes need to be changed.

increment_version() → None

Increment sema version. Source version is automatically handled by source parser.

Used in