Skip to content

apkg errors

apkg communicates errors using custom exceptions in apkg/ex.py.

Each exception contains message explaining what went wrong as well as returncode to return in case it's raised during CLI run.

A list of all apkg errors/exceptions with their default error message sorted by exit code:

ApkgException

An unknown error occurred

exit code: 1

QuietExit


exit code: 1

InvalidUsage

Invalid usage: {fail}

exit code: 10

InvalidInput

Invalid input: {fail}

exit code: 11

InvalidType

Invalid type: $(var) must be {desired} but is {type}

exit code: 12

InvalidChoice

Invalid choice: {var} must be one of: {opts} (is: {val})

exit code: 13

InvalidVersion

Invalid version: {ver}

exit code: 14

InvalidFormat

Invalid format: {fmt}

exit code: 16

InvalidArchiveFormat

Invalid archive format: {fmt}

exit code: 17

InvalidSourcePackageFormat

Invalid source package format: {fmt}

exit code: 18

InvalidCompatLevel

Project compat level {proj} is newer than current apkg compat level {apkg}.

Run `apkg compat` for more information.

Please upgrade apkg to work with this project.

exit code: 20

InvalidVariablesSource

Invalid variables source: {src}

exit code: 26

MissingRequiredArgument

Missing required argument: {arg}

exit code: 30

MissingRequiredConfigOption

Missing required config option: {opt}

exit code: 31

MissingPackagingTemplate

Missing package template: {temp}

exit code: 32

ArchiveNotFound

{type} archive not found: {ar}

exit code: 36

SourcePackageNotFound

{type} source package not found: {srcpkg}

exit code: 37

ParsingFailed

Unable to parse: {fail}

exit code: 42

FileDownloadFailed

Failed to download file with code {code}:

{url}

exit code: 52

CommandNotFound

Command not found: {cmd}

exit code: 60

CommandFailed

Command failed: {cmdout.args_str} (return code: {cmdout.returncode})

exit code: 62

UnexpectedCommandOutput

Unexpected command output: {out}

exit code: 64

DistroNotSupported

Distro not supported: {distro}

exit code: 70

UnableToDetectUpstreamVersion

Unable to detect upstream version.

Please consider one of following:

1) set upstream.archive_url
2) set upstream.version_script to custom script
3) manually supply version using -v/--version option

exit code: 84

PkgTestFail

Packaging tests failed.

exit code: 100