Skip to main content

Automatic code conversion from python to cython

Project description

markarth

Coverage badge

markarth is a library to automatically cythonize python code.

It can receive in input python code, evaluate the primitive types that variables are going to possess, and then add codelines for pure python cython mode.

Example

This is an example of python code using markarth to take a code section as a string and returns a string with cython annotations.

code = '''
def stuff(a : int, b : int, c : float = 0.4, d = None) -> int:
    sum = 0
    m = 11
    onono = 17.4
    for i in range(4):
        p = 7
        h = float(64) * p
        sum += i
        sum = 5 * 18
    return float(sum)

'''

cycode = convert_code(code)

print(cycode)

The resulting modified code will be the following, with cython.declare codelines:

import cython

def stuff(a : int, b : int, c : float = 0.4, d = None) -> int:
    h = cython.declare(cython.float)
    p = cython.declare(cython.int)
    i = cython.declare(cython.int)
    onono = cython.declare(cython.float)
    m = cython.declare(cython.int)
    sum = cython.declare(cython.int)
    sum = 0
    m = 11
    onono = 17.4
    for i in range(4):
        p = 7
        h = float(64) * p
        sum += i
        sum = 5 * 18
    return float(sum)

Installation

Markarth is available on the PyPI index. You can install it using pip:

pip install markarth

Internal functioning

It makes heavy usage of the ast module in order to parse python code, while leveraging type annotations to infer variable types, thus adding some declarations that with python would speed the code up.

The module's functionality is divided in two main steps:

  • one in which the code parsed with ast is analyzed to detect types of variables. Results of elementary operations are used, together with invocations of functions like len().
  • another in which the types collected are converted to cython codelines.

There are additional functionalities to provide conversion options, in order to use cython.double instead of cython.float as type during conversion.

Possible improvements

Several possible improvements can be done (apart from testing and discovering bugs, obviously). Among them:

  • Store and extrapolate types of containers (lists, dicts, sets, ecc.)
  • Identify numpy array and type them as memory views
  • Detect := walrus operators
  • Possibility of selecting between pure python mode conversion and old style pure cython with cdef VARNAME int codelines

Project details


Download files

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

Source Distribution

markarth-0.0.5.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

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

markarth-0.0.5-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file markarth-0.0.5.tar.gz.

File metadata

  • Download URL: markarth-0.0.5.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for markarth-0.0.5.tar.gz
Algorithm Hash digest
SHA256 815c1b8fd221c130d9a49e7021fa6f0ad601701462777ff9b1749839bb3661bb
MD5 45eb413169952888913fa437b3fd3748
BLAKE2b-256 3251271736acfa93299e7dc142ddc1cf426a61242c4bcffacb34d035a8d50ccb

See more details on using hashes here.

File details

Details for the file markarth-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: markarth-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for markarth-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1d9b1f29eb357b3d074d80c9b51b8bd51dabf55935780443c183e9b9a60dbbd6
MD5 a91231b237794b0db656b518f04dc6cd
BLAKE2b-256 61d4378ab4cc4b1b8554eee4a8e6b7ffb89258c9bb46f75fdbb02136c7f2c996

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