scikit_build_core.file_api.model package

Submodules

scikit_build_core.file_api.model.cache module

class scikit_build_core.file_api.model.cache.Cache(kind, version, entries)

Bases: object

entries: List[Entry]

kind: str

version: APIVersion

class scikit_build_core.file_api.model.cache.Entry(name, value, type, properties)

Bases: object

name: str

properties: List[Property]

type: str

value: str

class scikit_build_core.file_api.model.cache.Property(name, value)

Bases: object

name: str

value: str

scikit_build_core.file_api.model.cmakefiles module

class scikit_build_core.file_api.model.cmakefiles.CMakeFiles(kind, paths, inputs)

Bases: object

inputs: List[Input]

kind: str

paths: Paths

class scikit_build_core.file_api.model.cmakefiles.Input(path, isGenerated=False, isExternal=False, isCMake=False)

Bases: object

isCMake: bool = False

isExternal: bool = False

isGenerated: bool = False

path: Path

scikit_build_core.file_api.model.codemodel module

class scikit_build_core.file_api.model.codemodel.Archive(commandFragments=<factory>, lto=None)

Bases: object

commandFragments: List[CommandFragment]

lto: Optional[bool] = None

class scikit_build_core.file_api.model.codemodel.Artifact(path)

Bases: object

path: Path

class scikit_build_core.file_api.model.codemodel.CodeModel(kind, version, paths, configurations)

Bases: object

configurations: List[Configuration]

kind: str

paths: Paths

version: APIVersion

class scikit_build_core.file_api.model.codemodel.CommandFragment(fragment, role)

Bases: object

fragment: str

role: str

class scikit_build_core.file_api.model.codemodel.Configuration(name, projects, targets, directories)

Bases: object

directories: List[Directory]

name: str

projects: List[Project]

targets: List[Target]

class scikit_build_core.file_api.model.codemodel.Dependency(id, backtrace=None)

Bases: object

backtrace: Optional[int] = None

id: str

class scikit_build_core.file_api.model.codemodel.Destination(path, backtrace=None)

Bases: object

backtrace: Optional[int] = None

path: Path

class scikit_build_core.file_api.model.codemodel.Directory(source, build, projectIndex, jsonFile=None, parentIndex=None, childIndexes=<factory>, targetIndexes=<factory>, minimumCMakeVersion=None, hasInstallRule=False)

Bases: object

build: Path

childIndexes: List[int]

hasInstallRule: bool = False

jsonFile: Optional[Path] = None

minimumCMakeVersion: Optional[StringCMakeVersion] = None

parentIndex: Optional[int] = None

projectIndex: int

source: Path

targetIndexes: List[int]

class scikit_build_core.file_api.model.codemodel.Install(prefix, destinations)

Bases: object

destinations: List[Destination]

prefix: Prefix

class scikit_build_core.file_api.model.codemodel.Link(language, commandFragments, lto=None, sysroot=None)

Bases: object

commandFragments: List[CommandFragment]

language: str

lto: Optional[bool] = None

sysroot: Optional[Sysroot] = None

class scikit_build_core.file_api.model.codemodel.Prefix(path)

Bases: object

path: Path

class scikit_build_core.file_api.model.codemodel.Project(name, directoryIndexes, parentIndex=None, childIndexes=<factory>, targetIndexes=<factory>)

Bases: object

childIndexes: List[int]

directoryIndexes: List[int]

name: str

parentIndex: Optional[int] = None

targetIndexes: List[int]

class scikit_build_core.file_api.model.codemodel.Source(path, compileGroupIndex=None, sourceGroupIndex=None, isGenerated=None, backtrace=None)

Bases: object

backtrace: Optional[int] = None

compileGroupIndex: Optional[int] = None

isGenerated: Optional[bool] = None

path: Path

sourceGroupIndex: Optional[int] = None

class scikit_build_core.file_api.model.codemodel.StringCMakeVersion(string)

Bases: object

string: str

class scikit_build_core.file_api.model.codemodel.Sysroot(path)

Bases: object

path: Path

class scikit_build_core.file_api.model.codemodel.Target(name, id, type, paths, nameOnDisk=None, artifacts=<factory>, isGeneratorProvided=None, install=None, link=None, archive=None, dependencies=<factory>)

Bases: object

archive: Optional[Archive] = None

artifacts: List[Artifact]

dependencies: List[Dependency]

id: str

install: Optional[Install] = None

isGeneratorProvided: Optional[bool] = None

link: Optional[Link] = None

name: str

nameOnDisk: Optional[Path] = None

paths: Paths

sources

alias of List[Source]

type: str

scikit_build_core.file_api.model.common module

class scikit_build_core.file_api.model.common.APIVersion(major, minor)

Bases: object

major: int

minor: int

class scikit_build_core.file_api.model.common.Paths(source, build)

Bases: object

build: Path

source: Path

scikit_build_core.file_api.model.directory module

class scikit_build_core.file_api.model.directory.BacktraceGraph(nodes, commands, files)

Bases: object

commands: List[str]

files: List[Path]

nodes: List[Node]

class scikit_build_core.file_api.model.directory.Directory(paths, installers, backtraceGraph)

Bases: object

backtraceGraph: BacktraceGraph

installers: List[InstallRule]

paths: Paths

class scikit_build_core.file_api.model.directory.InstallRule(component, destination=None, paths=<factory>, isExcludeFromAll=False, isForAllComponents=False, isOptional=False, targetId=None, targetIndex=None, targetIsImportLibrary=False, targetInstallNameLink=None, exportName=None, exportTargets=<factory>, runtimeDependencySetName=None, runtimeDependencySetType=None, fileSetName=None, fileSetType=None, fileSetDirectories=<factory>, fileSetTarget=None, scriptFile=None, backtrace=None)

Bases: object

backtrace: Optional[int] = None

component: str

destination: Optional[Path] = None

exportName: Optional[str] = None

exportTargets: List[Target]

fileSetDirectories: List[Path]

fileSetName: Optional[str] = None

fileSetTarget: Optional[Target] = None

fileSetType: Optional[str] = None

isExcludeFromAll: bool = False

isForAllComponents: bool = False

isOptional: bool = False

paths: List[Union[str, Paths]]

runtimeDependencySetName: Optional[str] = None

runtimeDependencySetType: Optional[str] = None

scriptFile: Optional[Path] = None

targetId: Optional[str] = None

targetIndex: Optional[int] = None

targetInstallNameLink: Optional[str] = None

targetIsImportLibrary: bool = False

type

alias of str

class scikit_build_core.file_api.model.directory.Node(file, line=None, command=None, parent=None)

Bases: object

command: Optional[int] = None

file: int

line: Optional[int] = None

parent: Optional[int] = None

class scikit_build_core.file_api.model.directory.Target(id, index)

Bases: object

id: str

index: int

scikit_build_core.file_api.model.index module

class scikit_build_core.file_api.model.index.CMake(version, paths, generator)

Bases: object

generator: Generator

paths: CMakePaths

version: CMakeVersion

class scikit_build_core.file_api.model.index.CMakePaths(cmake, ctest, cpack, root)

Bases: object

cmake: Path

cpack: Path

ctest: Path

root: Path

class scikit_build_core.file_api.model.index.CMakeVersion(major, minor, patch, suffix, string, isDirty)

Bases: object

isDirty: bool

major: int

minor: int

patch: int

string: str

suffix: str

class scikit_build_core.file_api.model.index.Generator(name, multiConfig=None, platform=None)

Bases: object

multiConfig: Optional[bool] = None

name: str

platform: Optional[str] = None

class scikit_build_core.file_api.model.index.Index(cmake, objects, reply)

Bases: object

cmake: CMake

objects: List[Object]

reply: Reply

class scikit_build_core.file_api.model.index.Object(kind, version, jsonFile)

Bases: object

jsonFile: Path

kind: str

version: APIVersion

class scikit_build_core.file_api.model.index.Reply(codemodel_v2, cache_v2, cmakefiles_v1, toolchains_v1)

Bases: object

cache_v2: Optional[Cache]

cmakefiles_v1: Optional[CMakeFiles]

codemodel_v2: Optional[CodeModel]

toolchains_v1: Optional[Toolchains]

scikit_build_core.file_api.model.toolchains module

class scikit_build_core.file_api.model.toolchains.Compiler(implicit, path=None, id=None, version=None, target=None)

Bases: object

id: Optional[str] = None

implicit: Implicit

path: Optional[Path] = None

target: Optional[str] = None

version: Optional[str] = None

class scikit_build_core.file_api.model.toolchains.Implicit(includeDirectories=<factory>, linkDirectories=<factory>, linkFrameworkDirectories=<factory>, linkLibraries=<factory>)

Bases: object

includeDirectories: List[Path]

linkDirectories: List[Path]

linkFrameworkDirectories: List[Path]

linkLibraries: List[Path]

class scikit_build_core.file_api.model.toolchains.Toolchain(language, compiler, sourceFileExtensions=<factory>)

Bases: object

compiler: Compiler

language: str

sourceFileExtensions: List[str]

class scikit_build_core.file_api.model.toolchains.Toolchains(kind='toolchains', version=APIVersion(major=1, minor=0), toolchains=<factory>)

Bases: object

kind: str = 'toolchains'

toolchains: List[Toolchain]

version: APIVersion = APIVersion(major=1, minor=0)