PipelineOptions

class PipelineOptions

Description

Options for Pipeline construction.

Inheritance:

• PipelineOptions

Members defined in PipelineOptions (5 members)

	lib	RW	Standard library cache used to resolve elements for semantic constraints.
	library_index	RW	Index used to check access to globally accessible names.
	lint	RW	Lint options for the validation stage.
	static_index	RW	Index used to resolve globally accessible names.
	__init__		Constructor for pipeline options.

Attributes

property lib: syside.Stdlib

Standard library cache used to resolve elements for semantic constraints.

Note that the accessible elements must either be in the set of documents that are scheduled, or be accessible through the static_index. Missing elements will result in incomplete semantic constraints and a lot of errors being reported.

property library_index: syside.LibraryIndex

Index used to check access to globally accessible names.

While names will be picked up from static_index, this library_index will be used to skip names that are not direct dependencies on the active project.

property lint: syside.conf.Lint | None

Lint options for the validation stage.

property static_index: syside.StaticIndex

Index used to resolve globally accessible names.

Names in the index will only be used if the name resolution fails to resolve a name in any ancestor scopes, including inherited and imported names.

Methods

__init__(static_index: syside.StaticIndex | None = None, lib: syside.Stdlib | None = None, library_index: syside.LibraryIndex | None = None, lint: syside.conf.Lint | None = None) → None

Constructor for pipeline options.

static_index and lib are optional, and empty containers will be constructed if not provided. On each run, the pipeline will update the bound static_index and lib on every execution.

library_index is required to check dependent name accessibility in the global namespace during name resolution.

lint controls the options passed to the validation stage.

Used by

• syside: make_pipeline