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, version, paths, inputs, globsDependent=<factory>)

Bases: object

globsDependent: list[GlobDependent]

inputs: list[Input]

kind: str

paths: Paths

version: APIVersion

class scikit_build_core.file_api.model.cmakefiles.GlobDependent(expression, recurse=False, listDirectories=False, followSymlinks=False, relative=None, paths=<factory>)

Bases: object

expression: str

followSymlinks: bool = False

listDirectories: bool = False

paths: list[Path]

recurse: bool = False

relative: str | None = None

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] | None

lto: bool | None = 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.CompileCommandFragment(fragment, backtrace=None)

Bases: object

backtrace: int | None = None

fragment: str

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

Bases: object

backtrace: int | None = None

fromDependency: FromDependency | None = None

id: str

class scikit_build_core.file_api.model.codemodel.CompileGroup(sourceIndexes, language, languageStandard=None, compileCommandFragments=<factory>, includes=<factory>, frameworks=<factory>, precompileHeaders=<factory>, defines=<factory>, sysroot=None)

Bases: object

compileCommandFragments: list[CompileCommandFragment]

defines: list[Define]

frameworks: list[Include]

includes: list[Include]

language: str

languageStandard: LanguageStandard | None = None

precompileHeaders: list[PrecompileHeader]

sourceIndexes: list[int]

sysroot: Sysroot | None = None

class scikit_build_core.file_api.model.codemodel.Configuration(name, projects, targets, directories, abstractTargets=<factory>)

Bases: object

abstractTargets: list[Target]

directories: list[Directory]

name: str

projects: list[Project]

targets: list[Target]

class scikit_build_core.file_api.model.codemodel.Debugger(workingDirectory=None)

Bases: object

workingDirectory: Path | None = None

class scikit_build_core.file_api.model.codemodel.Define(define, backtrace=None)

Bases: object

backtrace: int | None = None

define: str

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

Bases: object

backtrace: int | None = None

id: str

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

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>, abstractTargetIndexes=<factory>, minimumCMakeVersion=None, hasInstallRule=False, installers=<factory>, backtraceGraph=None, codemodelVersion=None)

Bases: object

abstractTargetIndexes: list[int]

backtraceGraph: BacktraceGraph | None = None

build: Path

childIndexes: list[int]

codemodelVersion: APIVersion | None = None

hasInstallRule: bool = False

installers: list[InstallRule]

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.FileSet(name, type, visibility, baseDirectories=<factory>)

Bases: object

baseDirectories: list[Path]

name: str

type: str

visibility: str

class scikit_build_core.file_api.model.codemodel.Folder(name)

Bases: object

name: str

class scikit_build_core.file_api.model.codemodel.FromDependency(id)

Bases: object

id: str

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

Bases: object

backtrace: int | None = None

isSystem: bool | None = None

path: Path

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.LanguageStandard(standard, backtraces=<factory>)

Bases: object

backtraces: list[int]

standard: str

class scikit_build_core.file_api.model.codemodel.Launcher(command, type, arguments=<factory>)

Bases: object

arguments: list[str]

command: Path

type: str

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

Bases: object

commandFragments: list[CommandFragment] | None

language: str

lto: bool | None = None

sysroot: Sysroot | None = None

class scikit_build_core.file_api.model.codemodel.LinkLibrary(id=None, fragment=None, backtrace=None, fromDependency=None)

Bases: object

backtrace: int | None = None

fragment: str | None = None

fromDependency: FromDependency | None = None

id: str | None = None

class scikit_build_core.file_api.model.codemodel.PrecompileHeader(header, backtrace=None)

Bases: object

backtrace: int | None = None

header: Path

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>, abstractTargetIndexes=<factory>)

Bases: object

abstractTargetIndexes: list[int]

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, fileSetIndex=None, fileSetIndexes=<factory>, backtrace=None, backtraces=<factory>)

Bases: object

backtrace: int | None = None

backtraces: list[int]

compileGroupIndex: int | None = None

fileSetIndex: int | None = None

fileSetIndexes: list[int]

isGenerated: bool | None = None

path: Path

sourceGroupIndex: int | None = None

class scikit_build_core.file_api.model.codemodel.SourceGroup(name, sourceIndexes=<factory>, interfaceSourceIndexes=<factory>)

Bases: object

interfaceSourceIndexes: list[int]

name: str

sourceIndexes: list[int]

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, sources=<factory>, nameOnDisk=None, artifacts=<factory>, isGeneratorProvided=None, install=None, link=None, archive=None, dependencies=<factory>, backtrace=None, folder=None, launchers=<factory>, debugger=None, imported=None, local=None, abstract=None, symbolic=None, linkLibraries=<factory>, interfaceLinkLibraries=<factory>, compileDependencies=<factory>, interfaceCompileDependencies=<factory>, objectDependencies=<factory>, orderDependencies=<factory>, fileSets=<factory>, interfaceSources=<factory>, sourceGroups=<factory>, compileGroups=<factory>, backtraceGraph=None, codemodelVersion=None, directoryIndex=None, projectIndex=None)

Bases: object

abstract: bool | None = None

archive: Archive | None = None

artifacts: list[Artifact]

backtrace: int | None = None

backtraceGraph: BacktraceGraph | None = None

codemodelVersion: APIVersion | None = None

compileDependencies: list[CompileDependency]

compileGroups: list[CompileGroup]

debugger: Debugger | None = None

dependencies: list[Dependency]

directoryIndex: int | None = None

fileSets: list[FileSet]

folder: Folder | None = None

id: str

imported: bool | None = None

install: Install | None = None

interfaceCompileDependencies: list[CompileDependency]

interfaceLinkLibraries: list[LinkLibrary]

interfaceSources: list[Source]

isGeneratorProvided: bool | None = None

launchers: list[Launcher]

link: Link | None = None

linkLibraries: list[LinkLibrary]

local: bool | None = None

name: str

nameOnDisk: Path | None = None

objectDependencies: list[Dependency]

orderDependencies: list[Dependency]

paths: Paths

projectIndex: int | None = None

sourceGroups: list[SourceGroup]

sources: list[Source]

symbolic: bool | None = None

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, codemodelVersion=None)

Bases: object

backtraceGraph: BacktraceGraph

codemodelVersion: APIVersion | None = None

installers: list[InstallRule]

paths: Paths

class scikit_build_core.file_api.model.directory.InstallPath(from_, to)

Bases: object

from_: Path

to: Path

class scikit_build_core.file_api.model.directory.InstallRule(component, type, 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, cxxModuleBmiTarget=None, scriptFile=None, backtrace=None)

Bases: object

backtrace: int | None = None

component: str

cxxModuleBmiTarget: Target | None = None

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[Path | InstallPath]

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: str

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

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)

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: bool | None = None

name: str

platform: str | None = 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=None, cache_v2=None, cmakefiles_v1=None, toolchains_v1=None)

Bases: object

cache_v2: Cache | None = None

cmakefiles_v1: CMakeFiles | None = None

codemodel_v2: CodeModel | None = None

toolchains_v1: Toolchains | None = None

scikit_build_core.file_api.model.toolchains module

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

Bases: object

commandFragment: str | None = None

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>)

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)