SIP(1)

🌸 SIP(1) — the bindings generator, bestie edition 🌸

ok so this is sip from the General Commands Manual section 1, and she's here to turn your spec files into C++/Python bindings. iykyk. 💅

✨ NAME ✨

sip — generates C++/Python bindings 🐍🔥

🎀 SYNOPSIS 🎀

sip [-h] [-V] [-a file] [-b file] [-B tag] [-c dir] [-d file] [-D] [-e]
[-f] [-g] [-I dir] [-j number] [-k] [-m file] [-n name] [-o] [-p module]
[-P] [-r] [-s suffix] [-t tag] [-w] [-x feature] [-X id:file] [-y file]
[-z file] [@file] [file]

🦋 DESCRIPTION 🦋

so basically sip takes a set of specification files and generates C++ code, documentation and build files. that's her whole job. she's booked and busy ✨

the format of the needed specification file is similar to a C++ header. and sip includes run-time support for the generated code. no cap.

💖 OPTIONS 💖

• -h — show a lil summary of all the options. your cheat sheet fr.
• -V — display the sip version number. vibe check on which sip you're running.
• -a file — the name of the QScintilla API file. if you don't indicate it, it will not be generated. sad but true.
• -b file — the name of the build file. if you don't indicate it, it will not be generated.
• -B tag — add tag to the list of timeline backstops. > ⚠️ deprecated, bestie — it's giving legacy energy.
• -c dir — the name of the directory where the generated source file will be put. if you don't indicate it, no code will be generated. so like… use it. 🙈
• -d file — the name of the documentation file. if you don't indicate it, no documentation will be generated. > ⚠️ also deprecated. the elders have spoken.
• -D — generate code for a debug build of Python. for the debugging girlies 🫶
• -e — enable support for exceptions. disabled by default, so it's giving opt-in only.
• -f — handle warnings as errors. harsh but iconic 💀
• -g — always release and reacquire the GIL. main character threading behavior.
• -I dir — directory where sip can search for included files. her little treasure map 🗺️
• -j number — splits the generated code into number files (1 by default). this flag was added for parallel compilation on SMP machines. so yes, she's doing the most, on purpose 🔥
• -k — support keyword arguments in functions and methods. kwarg girlies rise 🌈
• -m file — the name of the XML export file. if you don't indicate it, the file will not be generated.
• -n name — the qualified name of the private copy of the sip module. very demure, very private ✨
• -o — enable the automatic generation of docstrings. disabled by default — flip that switch, bestie.
• -p module — give the name of the consolidated module this module should be a component of. she's in her group-project era 👑
• -P — enable the protected/public hack. yes it's called a hack. we don't question the hack. 💅
• -r — enable tracing on generated code. she's nosy and we love that.
• -s suffix — the suffix used for generated C or C++ files (".c" or ".cpp" if none specified).
• -t tag — the version/platform to generate code for. pick your target, babe 🎯
• -w — enable warning messages. let her talk.
• -x feature — disable a feature. not everything deserves to make the cut 🚫
• -X id:file — create the extracts for an id in a file.
• -y file — the name of the .pyi stub file to generate. if you don't indicate it, it will not be generated. type-hint besties, this one's for you 🧚
• -z file — the name of a file containing additional command line flags. > ⚠️ this option is deprecated, use @file instead. old news, move on, we're doing @file now.
• @ file — the name of a file containing more command line flags. the modern way to do the -z thing 💖
• file — the name of the file containing the specification. if you skip it, sip will expect to be fed by stdin. so like, she'll just sit there waiting for you to say something 😭 don't leave her hanging.

💜 AUTHOR 💜

this manual page was written by Ricardo Javier Cardenes Medina <rcardenes@debian.org>, Torsten Marek <shlomme@debian.org> and Dmitry Shachnev <mitya57@debian.org>, for the Debian project (but may be used by others). legends, honestly 👑

ok that's the whole page, you ate that 💅✨ go generate some bindings bestie, and remember: every flag above is real, every default is real, and every deprecation is real. periodt.

sign-off time 🎀 — this is SIP(1), dated 2019-10-15, and it lives in the General Commands Manual section. mwah 💖