Use PyCharm as FMEObjects Python IDE

Article by DaveAtSafe · Oct 08, 2015 at 07:14 PM · edited · Mar 02, 2016 at 04:15 PM

Article created with FME Desktop 2015.1

Introduction

PyCharm Community Edition is a free and easy to use IDE for Python projects that can be set up to provide auto-completion for FMEObjects.

Installation and Configuration

Download and install PyCharm Community edition from https://www.jetbrains.com/pycharm/download/

Python FMEObjects projects cannot use FME's internal Python, so you may need to install a full version of Python from www.python.org. You can also use the Python installed by ArcGIS.

To configure for FMEObjects:

Start PyCharm
File - New Project to bring up the Create Project dialog
Set the project location and choose the desired Python Interpreter. Use the ArcGIS Interpreter if you want to use arcpy as well.
File - Settings - to bring up the Settings dialog. Click on Project, then on Project Interpreter.

Click on the sprocket icon beside the Interpreter, then choose More to bring up the Project Interpreters dialog User-added image

Choose the desired interpreter, the click on the filetree icon on the right to bring up the Interpreter Paths dialog. User-added image

By clicking on the '+' icon, add the following paths to the Interpreter Paths (where <FME install> is the FME installation folder, ie. C:\apps\FME):

<FME install>\fmeobjects\python27
<FME install>\plugins
<FME install>\python
<FME install>\python\python27

Click OK to close the Interpreter Paths dialog

Click OK to close the Project Interpreters dialog and return to the Settings Dialog. If the 'Apply' button is still greyed-out, switch to another Project Interpreter, click 'Apply', then switch back and click 'Apply' again.

Click the 'Apply' button to save the settings, then OK to exit the dialog.

File - Invalidate Caches / Restart to update settings.

Using PyCharm

Open project created above.
Add FMEObjects reference:

 import fmeobjects

PyCharm will now auto-complete FMEObjects methods

User-added image

python tcl

Add comment · Show 3

10 |4000 characters needed characters left characters exceeded

Attachments: Up to 10 attachments (including images) can be used with a maximum of 4.0 MB each and 4.0 MB total.

danilo_fme · Dec 28, 2015 at 01:04 PM 0

@DaveAtSafe Amazing tutorial. I did install the PyCharm and i followed the all steps.

Its work in my machine:

Thanks :)

Danilo de Lima

pycharm.png (39.5 kB)

matteo_pasquini · Feb 25, 2016 at 10:19 AM 0

Thanks!

as for FMEPlugInSDK_Python.pdf it is suppose to add

[FME_INSTALLATION]\fmeobjects\python27

[FME_INSTALLATION]\plugins

to the interpreter paths, as known it doesnt work.

as you say, adding the extra :

[FME_INSTALLATION]\python

[FME_INSTALLATION]\python\python27

it resolve in a very unelegant way,

this create confusion if you are using your python path.

I've noted this in PyCharm : if you go to Project->External lib->pythonx.x.x->BinarySkeletrons you'll find that '__init__.py' is missing, there is instead a subfolder '__init__'.

I think the bug is here.

so, PyCharm permit me to right-click and create a new file '__init__.py' inside the 'fmeobjects' folder.

In this way I can configure my interpreter as for SDK instructions and have my python along fme stuffs.

on the other hand I have to use a very uncommon still unelegant import statement :

from fmeobjects.__init__ import ...

where '__init__' is the subfolder of fmeobjects.

but i can still use my python env without mixing other unwanted sources.

I've asked FME team to resolve this.

thanks.