Skip to main content

Professional C++ Python bindings with type-generic templates, pystubs and native threading

Project description

IncludeCPP

Write C++ code, use it in Python. Auto-generates pybind11 bindings.

pip install IncludeCPP

Setup

includecpp init

Creates cpp.proj, include/, plugins/.

Write C++ Code

Put your code in namespace includecpp:

// include/fast_list.cpp
#include <vector>

namespace includecpp {

class FastList {
public:
    void append(int val) { data.push_back(val); }
    int get(int i) { return data[i]; }
private:
    std::vector<int> data;
};

int add(int a, int b) { return a + b; }

}  // namespace includecpp

Without namespace includecpp, your code won't be found.

Generate Plugin

includecpp plugin fast_list include/fast_list.cpp

Creates plugins/fast_list.cp with detected classes, methods, functions.

Build

includecpp rebuild

Or includecpp build (same thing).

Use in Python

from includecpp import fast_list

my_list = fast_list.FastList()
my_list.append(42)
print(fast_list.add(1, 2))  # 3

Or classic style:

from includecpp import CppApi

api = CppApi()
fast_list = api.include("fast_list")

Commands

Command What it does
init Create project structure
plugin <name> <files> Generate .cp from C++
rebuild / build Compile modules
get <module> Show module API
install <name> Install community module
update Update IncludeCPP
bug Report issue
--doc Show docs

rebuild options

includecpp rebuild --clean          # Full rebuild
includecpp rebuild --verbose        # See compiler output
includecpp rebuild -m crypto        # Rebuild specific module
includecpp rebuild -j 8             # 8 parallel jobs

Plugin Syntax (.cp files)

SOURCE(fast_list.cpp) fast_list

PUBLIC:

fast_list CLASS(FastList) {
    CONSTRUCTOR()
    METHOD(append)
    METHOD(get)
}

fast_list FUNC(add)

Overloaded Methods

MODULE CLASS(Circle) {
    METHOD_CONST(intersects, const Circle&)
    METHOD_CONST(intersects, const Rect&)
}

Templates

MODULE TEMPLATE_FUNC(maximum) TYPES(int, float, double)

MODULE STRUCT(Point) TYPES(int, float) {
    FIELD(T, x)
    FIELD(T, y)
}

Dependencies

DEPENDS(math_utils, geometry)

VSCode Support

Generates .pyi stubs automatically. Full autocomplete works.

Enable in cpp.proj:

{
  "CPI-IntelliSense": true
}

cpp.proj

{
  "project": "MyProject",
  "include": "/include",
  "plugins": "/plugins",
  "compiler": {
    "standard": "c++17",
    "optimization": "O3"
  }
}

Requirements

  • Python 3.8+
  • C++ compiler (g++, clang++, MSVC)
  • pybind11 (installed automatically)

Notes

  • Builds go to AppData/IncludeCPP, source stays clean
  • SHA256 change detection, only rebuilds what changed
  • Parallel compilation by default

MIT License | v2.9.2 | GitHub

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

includecpp-2.9.2.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

includecpp-2.9.2-py3-none-any.whl (97.4 kB view details)

Uploaded Python 3

File details

Details for the file includecpp-2.9.2.tar.gz.

File metadata

  • Download URL: includecpp-2.9.2.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for includecpp-2.9.2.tar.gz
Algorithm Hash digest
SHA256 18e92d6289cf2a943cfc297668905e69d9eb6faa294f49c8698f8e908edcc89b
MD5 864f0475d634417283961ac3ebc66617
BLAKE2b-256 99258cbf64c058909d6479de4dcb350f9d47e07d5a5c12da8eb454335f448d68

See more details on using hashes here.

File details

Details for the file includecpp-2.9.2-py3-none-any.whl.

File metadata

  • Download URL: includecpp-2.9.2-py3-none-any.whl
  • Upload date:
  • Size: 97.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for includecpp-2.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 30db1ae8e5c81da6312ed7bc7aa1488c0156054d5f43e6c14248fadc49e2867d
MD5 b9aa0543cb33d5ca3bedaf26ddb025f7
BLAKE2b-256 93163e411fc38cfc856f8a25afa15941424b31556620bd6e7c947295ab0a20c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page