quixote.inspection.build package

Module contents

quixote.inspection.build.gcc(*src: str, version=None, output_file: Optional[str] = None, options: Optional[List[str]] = None, env: Optional[Mapping[str, str]] = None) → quixote.inspection.exec.CompletedProcess[source]

Compile a C program

Parameters

  • src – path or list of paths of file(s) to be compiled

  • version – version of gcc to use (only major version)

  • output_file – path to the output file

  • options – list of shell options to be passed to gcc (see man page for gcc for more info)

  • env – environment to run the gcc command with (by default use the current shell environment)

quixote.inspection.build.gpp(*src: str, version=None, output_file: Optional[str] = None, options: Optional[List[str]] = None, env: Optional[Mapping[str, str]] = None) → quixote.inspection.exec.CompletedProcess[source]

Compile a C++ program

Parameters

  • src – path or list of paths of file(s) to be compiled

  • version – version of g++ to use (only major version)

  • output_file – path to the output file

  • options – list of shell options to be passed to g++ (see man page for g++ for more info)

  • env – environment to run the g++ command with (by default use the current shell environment)

quixote.inspection.build.javac(*source_files: str, options: Optional[List[str]] = None, env: Optional[Mapping[str, str]] = None) → quixote.inspection.exec.CompletedProcess[source]

Compile java classes

Parameters

  • source_files – path or list of paths of sourcesfile(s) to be compiled

  • options – list of shell option to be passed to javac (see javac man page for more info)

  • env – environment to run the javac command with (by default use the current shell environment)

quixote.inspection.build.javac_annotate(*class_files: str, options: Optional[List[str]] = None, env: Optional[Mapping[str, str]] = None) → quixote.inspection.exec.CompletedProcess[source]

Compile java classes

Parameters

  • class_files – path or list of paths of class_file(s) to be processed for annotations

  • options – list of shell option to be passed to javac (see javac man page for more info)

  • env – environment to run the javac command with (by default use the current shell environment)

quixote.inspection.build.make(*targets: str, directory: str = '.', makefile: Optional[str] = None, dry_run: bool = False, jobs: Optional[int] = None, keep_going: bool = False, ignore_errors: bool = False, question_mode: bool = False, touch_only: bool = False, environment_overrides: bool = False, with_builtin_rules: bool = True, with_builtin_variables: bool = True, env: Optional[Mapping[str, str]] = None) → quixote.inspection.exec.CompletedProcess[source]

Use the make(1) command to run build scripts

Parameters

  • targets – the names of the targets to build

  • directory – the directory to use as working directory before running make (see make -C)

  • makefile – the name of the file to use as Makefile (default is “Makefile”, see make -f)

  • dry_run – whether make should only print the commands instead of running them (default is False, see make -n)

  • jobs – the number of jobs make can run simultaneously (default is 1, see make -j)

  • keep_going – whether make should keep going as much as possible after an error (default is False, see make -k)

  • ignore_errors – whether make should ignore failing commands (default is False, see make -i)

  • question_mode – whether make should only run in question mode (default is False, see make -q)

  • touch_only – whether make should only touch target files instead of running their commands (default is False, see make -t)

  • environment_overrides – whether environment variables should override those defined in the Makefiles (default is False, see make -e)

  • with_builtin_rules – whether make should enable built-in implicit rules (default is True, see make -r)

  • with_builtin_variables – whether make should enable built-in variables (default is True, see make -R)

  • env – the environment to run the make command with (by default use the current shell environment)