Cython support

1. Create a new project as explained in Create a Python project.

2. Press CtrlAlt0S to open the project settings and navigate to Project: <project name> | Python Interpreter.

3. Click on the package toolbar, then type Cython in the search field of the Available Packages dialog, and click Install Package. Close the window upon successful installation and click OK in the interpreter settings.

   

4. Now create a .pyx file. Select File | New from the main menu, then select File. Type the filename, for example, example.pyx and save the changes. The file opens in the editor.

5. You can copy and paste the following code:

   def function (a: int, b: int) -> str:
       return str(a + b)
   
   function(2, 4)

   Alternatively, you can type code to see how PyCharm assists you with code completion and type checking:

   Code completion

   Type checking

   

   

6. Now create the setup.py file. Select Tools | Create setup.py from the main menu. PyCharm creates a template setup.py file and opens it in the editor. You can copy and paste the following setup options:

   from setuptools import setup, Extension
   
   module = Extension ('example', sources=['example.pyx'])
   
   setup(
       name='cythonTest',
       version='1.0',
       author='jetbrains',
       ext_modules=[module]
   )

7. To compile the example.pyx file, select Tools | Run setup.py Task command from the main menu. In the Enter setup.py task name type build and select the build_ext task. For more information, refer to Create and run setup.py.

   

   In the Run Setup Task build_ext dialog, add the --inplace command-line agrument

   

   Once the build task successfully completes, the .so file is created.

   

At this point, you can use the compiled .so file to import function:

from example import function

See Cython documentation for the complete instructions.