refactor: Rewrite pytox using Cython.

The C code was too brittle, too manual, and segfaulted all over the place
if you hold it wrong. This is an attempt at making pytox more
maintainable and safer, as well as giving it a better API.

Author: iphydf

.circleci/config.yml

@@ -44,11 +44,11 @@ jobs:
           -DTRACE=ON
           -DMUST_BUILD_TOXAV=ON
       - run: cd c-toxcore/_build && ninja install -j$(nproc)
-      - run:
-          export CFLAGS="-I$PWD/c-toxcore/_install/include -fsanitize=address";
-          export LDFLAGS="-L$PWD/c-toxcore/_install/lib -Wl,-rpath,$PWD/c-toxcore/_install/lib";
-          python3 setup.py build_ext --inplace
-      - run: ASAN_OPTIONS=detect_leaks=0
-          LD_PRELOAD=libasan.so.5
-          PYTHONPATH=.
-          python3 tests/tests.py
+#     - run:
+#         export CFLAGS="-I$PWD/c-toxcore/_install/include -fsanitize=address";
+#         export LDFLAGS="-L$PWD/c-toxcore/_install/lib -Wl,-rpath,$PWD/c-toxcore/_install/lib";
+#         python3 setup.py build_ext --inplace
+#     - run: ASAN_OPTIONS=detect_leaks=0
+#         LD_PRELOAD=libasan.so.5
+#         PYTHONPATH=.
+#         python3 tests/tests.py

.github/workflows/ci.yml

@@ -5,55 +5,55 @@ on:
     branches: [master]
 
 jobs:
-  build:
-    name: python-${{ matrix.version }}
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        include:
-        - version: "2.7"
-        - version: "3.5"
-        - version: "3.6"
-        - version: "3.8"
-        - version: "3.9"
-        - version: "3.10"
-
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.version }}
-    - name: Install
-      run: |
-        sudo apt update
-        sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
-    - name: Build
-      run: python setup.py build_ext --inplace
-    - name: Test
-      run: PYTHONPATH=. python tests/tests.py
-
-  coverage:
-    name: python-3.7-coverage
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-      with:
-        python-version: "3.7"
-    - name: Install
-      run: |
-        sudo apt update
-        sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
-    - name: Build
-      run: |
-        export CFLAGS="-fprofile-arcs -ftest-coverage"
-        python setup.py build_ext --inplace
-    - name: Test
-      run: PYTHONPATH=. python tests/tests.py
-    - name: Upload coverage
-      run: bash <(curl -s https://codecov.io/bash)
+# build:
+#   name: python-${{ matrix.version }}
+#   runs-on: ubuntu-latest
+#
+#   strategy:
+#     matrix:
+#       include:
+#       - version: "2.7"
+#       - version: "3.5"
+#       - version: "3.6"
+#       - version: "3.8"
+#       - version: "3.9"
+#       - version: "3.10"
+#
+#   steps:
+#   - uses: actions/checkout@v2
+#   - uses: actions/setup-python@v2
+#     with:
+#       python-version: ${{ matrix.version }}
+#   - name: Install
+#     run: |
+#       sudo apt update
+#       sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
+#   - name: Build
+#     run: python setup.py build_ext --inplace
+#   - name: Test
+#     run: PYTHONPATH=. python tests/tests.py
+#
+# coverage:
+#   name: python-3.7-coverage
+#   runs-on: ubuntu-latest
+#
+#   steps:
+#   - uses: actions/checkout@v2
+#   - uses: actions/setup-python@v2
+#     with:
+#       python-version: "3.7"
+#   - name: Install
+#     run: |
+#       sudo apt update
+#       sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
+#   - name: Build
+#     run: |
+#       export CFLAGS="-fprofile-arcs -ftest-coverage"
+#       python setup.py build_ext --inplace
+#   - name: Test
+#     run: PYTHONPATH=. python tests/tests.py
+#   - name: Upload coverage
+#     run: bash <(curl -s https://codecov.io/bash)
 
   docker:
     runs-on: ubuntu-latest
@@ -63,16 +63,16 @@ jobs:
     - name: Build
       run: docker build -t pytox .
 
-  clang-analyze:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Install
-      run: |
-        sudo apt update
-        sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
-    - name: Build
-      run: |
-        clang -fsyntax-only pytox/*.c -Werror -Weverything -Wno-reserved-id-macro -Wno-documentation-deprecated-sync -Wno-shorten-64-to-32 -Wno-unused-parameter -Wno-missing-field-initializers -Wno-sign-conversion -Wno-padded -Wno-conversion $(pkg-config --cflags-only-I python3)
-        clang --analyze pytox/*.c $(pkg-config --cflags-only-I python3)
+# clang-analyze:
+#   runs-on: ubuntu-latest
+#
+#   steps:
+#   - uses: actions/checkout@v2
+#   - name: Install
+#     run: |
+#       sudo apt update
+#       sudo apt install -y --no-install-recommends --no-install-suggests libtoxcore-dev
+#   - name: Build
+#     run: |
+#       clang -fsyntax-only pytox/*.c -Werror -Weverything -Wno-reserved-id-macro -Wno-documentation-deprecated-sync -Wno-shorten-64-to-32 -Wno-unused-parameter -Wno-missing-field-initializers -Wno-sign-conversion -Wno-padded -Wno-conversion $(pkg-config --cflags-only-I python3)
+#       clang --analyze pytox/*.c $(pkg-config --cflags-only-I python3)

.gitignore

@@ -6,4 +6,5 @@
 .*.swp
 *.so
 *.o
-.tox
+*.tox
+.mypy_cache

AUTHORS

@@ -1,9 +1,3 @@
 Developers
 ----------
-AZ Huang <aitjcize@gmail.com>
-Alexander van der Meij <alexandervdm@gliese.me>
-
-Contributors
-------------
-Alexandre Viau <reazem@reazem.net>
-Jman012 <jman012guy@gmail.com>
+Iphigenia Df <iphydf@gmail.com>

BUILD.bazel

@@ -1,28 +1,28 @@
-load("@rules_cc//cc:defs.bzl", "cc_binary")
+load("//third_party/python:build_defs.bzl", "pyx_library")
 load("//tools/project:build_defs.bzl", "project")
 
+package(features = ["layering_check"])
+
 project()
 
-cc_binary(
-    name = "pytox.so",
-    srcs = glob([
-        "pytox/*.c",
-        "pytox/*.h",
-    ]),
-    copts = [
-        "-DENABLE_AV",
-        "-Wno-strict-aliasing",
+genrule(
+    name = "pytox/core",
+    srcs = [
+        "pytox/src/core.pyx",
+        "//c-toxcore:tox/tox.h",
     ],
-    linkopts = select({
-        "@toktok//tools/config:freebsd": ["-Wl,--version-script,$(location pytox.ld)"],
-        "@toktok//tools/config:linux": ["-Wl,--version-script,$(location pytox.ld)"],
-        "@toktok//tools/config:osx": [],
-    }),
-    linkshared = True,
-    visibility = ["//visibility:public"],
-    deps = [
-        "pytox.ld",
-        "//c-toxcore",
-        "@python3//:python",
+    outs = ["pytox/core.pyx"],
+    cmd = "$(location //py_toxcore_c/tools:gen_api) $(location pytox/src/core.pyx) $(location //c-toxcore:tox/tox.h) > $@",
+    tools = ["//py_toxcore_c/tools:gen_api"],
+)
+
+pyx_library(
+    name = "pytox",
+    srcs = [
+        "pytox/av.pyx",
+        "pytox/core.pyx",
     ],
+    cdeps = ["//c-toxcore"],
+    cython_directives = {"language_level": "3"},
+    visibility = ["//visibility:public"],
 )

Dockerfile

@@ -1,17 +1,45 @@
-FROM ubuntu:18.04
+FROM ubuntu:20.04
 LABEL maintainer="iphydf@gmail.com"
 
 RUN apt-get update \
- && apt-get install --no-install-recommends -y ca-certificates cmake gcc g++ git libopus-dev libsodium-dev libvpx-dev pkg-config python-dev \
+ && DEBIAN_FRONTEND="noninteractive" apt-get install --no-install-recommends -y \
+ ca-certificates \
+ cmake \
+ cython \
+ gcc \
+ g++ \
+ git \
+ libopus-dev \
+ libsodium-dev \
+ libvpx-dev \
+ ninja-build \
+ pkg-config \
+ python3 \
+ python3-dev \
+ python3-pip \
  && apt-get clean \
- && rm -rf /var/lib/apt/lists/*
-
-COPY pytox.ld setup.py /build/
-COPY pytox /build/pytox/
+ && rm -rf /var/lib/apt/lists/* \
+ && pip3 install mypy
 
 WORKDIR /build
-RUN git clone https://github.com/TokTok/c-toxcore /build/c-toxcore \
- && cmake -B/build/c-toxcore/_build -H/build/c-toxcore -DBOOTSTRAP_DAEMON=OFF -DMUST_BUILD_TOXAV=ON \
- && make -C/build/c-toxcore/_build install -j"$(nproc)" \
- && python setup.py install \
- && rm -r /build/*
+RUN git clone --depth=1 https://github.com/TokTok/c-toxcore /build/c-toxcore \
+ && cmake -GNinja -B/build/c-toxcore/_build -H/build/c-toxcore \
+ -DBOOTSTRAP_DAEMON=OFF \
+ -DENABLE_STATIC=OFF \
+ -DMUST_BUILD_TOXAV=ON \
+ && cmake --build /build/c-toxcore/_build --target install --parallel "$(nproc)" \
+ && ldconfig
+
+COPY pytox /build/pytox
+COPY tools /build/tools
+
+RUN mypy --strict tools/gen_api.py \
+ && tools/gen_api.py pytox/src/core.pyx /usr/local/include/tox/tox.h > pytox/core.pyx \
+ && cython pytox/av.pyx pytox/core.pyx
+
+COPY setup.py /build/
+RUN python3 setup.py install \
+ && python3 -c 'from pytox import core; print(core.__doc__)'
+
+COPY test /build/test
+RUN python3 test/core_test.py

MANIFEST.in

@@ -1,92 +1,5 @@
-[![Build Status](http://img.shields.io/travis/TokTok/py-toxcore-c.svg)](https://travis-ci.org/TokTok/py-toxcore-c)
-[![Coverage Status](https://coveralls.io/repos/github/TokTok/py-toxcore-c/badge.svg?branch=master)](https://coveralls.io/github/TokTok/py-toxcore-c?branch=master)
-
 # PyTox
 
 Python binding for [Project Tox](https://github.com/TokTok/c-toxcore).
 
-Docker hub: <https://hub.docker.com/r/toxchat/py-toxcore-c/>
-
-```sh
-docker pull toxchat/py-toxcore-c
-```
-
-PyTox provides a Pythonic binding, i.e Object-oriented instead of C style, raise
-exception instead of returning error code. A simple example is as follows:
-
-```python
-from pytox import Tox
-
-class ToxOptions(object):
-    def __init__(self):
-        self.ipv6_enabled = True
-        self.udp_enabled = True
-        self.proxy_type = 0  # 1=http, 2=socks
-        self.proxy_host = ''
-        self.proxy_port = 0
-        self.start_port = 0
-        self.end_port = 0
-        self.tcp_port = 0
-        self.savedata_type = 0  # 1=toxsave, 2=secretkey
-        self.savedata_data = b''
-        self.savedata_length = 0
-
-
-class EchoBot(Tox):
-    def __init__(self, opts):
-        super(EchoBot, self).__init__(opts)
-
-    def loop(self):
-        while True:
-            self.iterate()
-            time.sleep(0.03)
-
-    def on_friend_request(self, pk, message):
-        print 'Friend request from %s: %s' % (pk, message)
-        self.friend_add_norequest(pk)
-        print 'Accepted.'
-
-    def on_friend_message(self, fid, message):
-        name = self.self_get_name(fid)
-        print '%s: %s' % (name, message)
-        print 'EchoBot: %s' % message
-        self.friend_send_message(fid, Tox.MESSAGE_TYPE_NORMAL, message)
-
-
-EchoBot(ToxOptions()).loop()
-```
-
-As you can see callbacks are mapped into class method instead of using it the
-the c ways. For more details please refer to
-[examples/echo.py](https://github.com/TokTok/py-toxcore-c/blob/master/examples/echo.py).
-
-## Getting started
-
-To get started, a Makefile is provided to run PyTox inside a docker container:
-
-- `make test`: This will launch tests in a container.
-- `make run`: This will launch an interactive container with PyTox installed.
-- `make echobot`: This will launch the example echobot in a container.
-
-## Examples
-
-- [echo.py](https://github.com/TokTok/py-toxcore-c/blob/master/examples/echo.py):
-  A working echo bot that wait for friend requests, and than start echoing
-  anything that friend send.
-
-## Documentation
-
-Full API documentation can be read [here](http://aitjcize.github.io/PyTox/).
-
-## Todo
-
-- Complete API binding (use tools/apicomplete.py to check)
-- Unittest for ToxAV
-
-## Contributing
-
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
+TODO: Docs.