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)[source]¶

Bases: object

entries: List[Entry]¶

kind: str¶

version: APIVersion¶

class scikit_build_core.file_api.model.cache.Entry(name, value, type, properties)[source]¶

Bases: object

name: str¶

properties: List[Property]¶

type: str¶

value: str¶

class scikit_build_core.file_api.model.cache.Property(name, value)[source]¶

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)[source]¶

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)[source]¶

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)[source]¶

Bases: object

commandFragments: List[CommandFragment] | None¶

lto: bool | None = None¶

class scikit_build_core.file_api.model.codemodel.Artifact(path)[source]¶

Bases: object

path: Path¶

class scikit_build_core.file_api.model.codemodel.CodeModel(kind, version, paths, configurations)[source]¶

Bases: object

configurations: List[Configuration]¶

kind: str¶

paths: Paths¶

version: APIVersion¶

class scikit_build_core.file_api.model.codemodel.CommandFragment(fragment, role)[source]¶

Bases: object

fragment: str¶

role: str¶

class scikit_build_core.file_api.model.codemodel.Configuration(name, projects, targets, directories)[source]¶

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)[source]¶

Bases: object

backtrace: int | None = None¶

id: str¶

class scikit_build_core.file_api.model.codemodel.Destination(path, backtrace=None)[source]¶

Bases: object

backtrace: int | None = 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)[source]¶

Bases: object

build: Path¶

childIndexes: List[int]¶

hasInstallRule: bool = False¶

jsonFile: Path | None = None¶

minimumCMakeVersion: StringCMakeVersion | None = None¶

parentIndex: int | None = None¶

projectIndex: int¶

source: Path¶

targetIndexes: List[int]¶

class scikit_build_core.file_api.model.codemodel.Install(prefix, destinations)[source]¶

Bases: object

destinations: List[Destination]¶

prefix: Prefix¶

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

Bases: object

commandFragments: List[CommandFragment] | None¶

language: str¶

lto: bool | None = None¶

sysroot: Sysroot | None = None¶

class scikit_build_core.file_api.model.codemodel.Prefix(path)[source]¶

Bases: object

path: Path¶

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

Bases: object

childIndexes: List[int]¶

directoryIndexes: List[int]¶

name: str¶

parentIndex: int | None = None¶

targetIndexes: List[int]¶

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

Bases: object

backtrace: int | None = None¶

compileGroupIndex: int | None = None¶

isGenerated: bool | None = None¶

path: Path¶

sourceGroupIndex: int | None = None¶

class scikit_build_core.file_api.model.codemodel.StringCMakeVersion(string)[source]¶

Bases: object

string: str¶

class scikit_build_core.file_api.model.codemodel.Sysroot(path)[source]¶

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>)[source]¶

Bases: object

archive: Archive | None = None¶

artifacts: List[Artifact]¶

dependencies: List[Dependency]¶

id: str¶

install: Install | None = None¶

isGeneratorProvided: bool | None = None¶

link: Link | None = None¶

name: str¶

nameOnDisk: Path | None = 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)[source]¶

Bases: object

major: int¶

minor: int¶

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

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)[source]¶

Bases: object

commands: List[str]¶

files: List[Path]¶

nodes: List[Node]¶

class scikit_build_core.file_api.model.directory.Directory(paths, installers, backtraceGraph)[source]¶

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)[source]¶

Bases: object

backtrace: int | None = None¶

component: str¶

destination: Path | None = None¶

exportName: str | None = None¶

exportTargets: List[Target]¶

fileSetDirectories: List[Path]¶

fileSetName: str | None = None¶

fileSetTarget: Target | None = None¶

fileSetType: str | None = None¶

isExcludeFromAll: bool = False¶

isForAllComponents: bool = False¶

isOptional: bool = False¶

paths: List[str | Paths]¶

runtimeDependencySetName: str | None = None¶

runtimeDependencySetType: str | None = None¶

scriptFile: Path | None = None¶

targetId: str | None = None¶

targetIndex: int | None = None¶

targetInstallNameLink: str | None = None¶

targetIsImportLibrary: bool = False¶

type¶: alias of str

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

Bases: object

command: int | None = None¶

file: int¶

line: int | None = None¶

parent: int | None = None¶

class scikit_build_core.file_api.model.directory.Target(id, index)[source]¶

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)[source]¶

Bases: object

generator: Generator¶

paths: CMakePaths¶

version: CMakeVersion¶

class scikit_build_core.file_api.model.index.CMakePaths(cmake, ctest, cpack, root)[source]¶

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)[source]¶

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)[source]¶

Bases: object

multiConfig: bool | None = None¶

name: str¶

platform: str | None = None¶

class scikit_build_core.file_api.model.index.Index(cmake, objects, reply)[source]¶

Bases: object

cmake: CMake¶

objects: List[Object]¶

reply: Reply¶

class scikit_build_core.file_api.model.index.Object(kind, version, jsonFile)[source]¶

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)[source]¶

Bases: object

cache_v2: Cache | None¶

cmakefiles_v1: CMakeFiles | None¶

codemodel_v2: CodeModel | None¶

toolchains_v1: Toolchains | None¶

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)[source]¶

Bases: object

id: str | None = None¶

implicit: Implicit¶

path: Path | None = None¶

target: str | None = None¶

version: str | None = None¶

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

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>)[source]¶

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>)[source]¶

Bases: object

kind: str = 'toolchains'¶

toolchains: List[Toolchain]¶

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