Hello all.
Recently, I posted that if you want to build a Jython project with JDK code, it is very simple to do. However, if you want to DEVELOP your OWN Java classes, it takes a little more work. If you use an IDE to develop your code, understanding how your IDE packages your .class files is a must. Because Jython DEPENDS on knowing where your .class files are.
Understanding Java package rules will help in this are. I have found that the easiest way is to develop your Java project FIRST, then create a separate Jython project. You need to point to the directory where your .class files live. As an alternative, you could take your Java code, package it in a .JAR file, includ it in your JYTHONPATH environment variable and you're good to go.
Creating a .JAR file is simple. A short tutorial follows:
I use IntelliJ IDEA for my coding in both Java and Jython. In my project settings, under project, I defined a global /out folder for my compiled .class files. Doing this makes it easy to create .jar files depending on your project, as I will demonstrate soon. So, currently, my folder structure is
/home/patrick/out
When IntelliJ compiles the .class files, it adds a series of sub-folders, so that it looks like this\
/home/patrick/out/production/<projectname>
Under the project name is the hierarch you created with your Java project For me, it is
org.ppalczewski.<project>.<source1>.<so on>
So, in the end, my /out folder looks like this:
/home/patrick/out/production/<projectname>/org.ppalczewski.<project>/<source1>/<source2>/ etc
Wow, that's a lot of typing. But I only want to create a .jar that shows the hierarchy from org.ppaczewski dowm. I can do this two ways. First, I can navigate to my <projectname> folder (i.e. /home/patrick/out/production/<projectname>).
Then, I type this command to build my .JAR file:
jar cvf <project>.jar .
This will recurse from the <projectname> folder down and include all .class files. The switches are c(create), v(verbose), f(jar file name)
I have a root jarfiles folder that holds all of my jar files. I can navigate to this folder and type the following:
jar cvf <project>.jar -C /home/patrick/out/production/<projectname>/ .
This will do the same thing, and it retains your fully qualified package name structure (for me: org.ppalczewski.<project>.etc,etc).
It is very important to include the ending slash (or backslash in Windows). If you don't, you may get unexpected results. you can verify your package qualified name by
jar tf <jarfile>.jar
and this will list the .class files you have in your project.
So, after I have built my .jar file, and included this in my JYTHONPATH (you MUST include the actual name of your .jar file also), I can now fire up my Jython interpreter and test to see that it works.
In my code, I type this:
import org.ppalczewski.<project> as project
Now I have access to any classes I may have created.
To me, this makes it easier than having worry about whether Jython can see the .class files or not. 1. Build Java code. 2. Package in .jar file. 3. Import into Jython 4. Enjoy!
Then, for distribution, have the .jar file available and that's it.
Say you alread have a .jar file and you updated the code in your project? Do you need to delete the jar file and create a new one? No. Use the jar command's updatte feature, which will recreate the .jar file for you, adding any new files or updated code.
jar uvf <jarfile>.jar [-C <path>/<to>/<production>/] .
If I am able, I will create a blog with a simple project demonstrating this.
That's it for today. Happy coding!
Monday, July 30, 2018
Saturday, July 21, 2018
Hybrid Jython/Java projects in IntelliJ?
The post title is a pretty good question. The answer is: It's extremely difficult.
I will explain:
If you are pulling from extablished Java packages (JAR files), it's very easy.
However, if you are developing YOUR OWN Java classes, this is where the roadblocks start popping up. What I have found is that it's easier (in the long run) to develop you own classes in a Java project, and package them into a JAR file. Then create a separate Jython package that points to the JAR file. You can actually add it as a library in your Project settings,
The reason for this is that IntelliJ actually stores all your .class files in an output directory you must specify. So,m when you open up a .py file, it can see your code internally, but the actual .class files are somewhere else. And if you use a package structure, Jython cannot see the .class files, so it breaks the code.
For the really adventurous, you need to navigate to your output folder, call the java class with the FULLY qualified name, and it will work.
Much better to simply start a Jython project abnd point it to your output folderwhere your .class files are stored. Even easier to do the Java code, bundle it in a JAR and use Jython to call it with the qualified package name.
My ealier post on setting up IntelliJ was to work on Jython ITSELF, not for general Jython development.
I have also discovered that if you use IntelliJ's GUI builder to do your forms, Jython has a lot of trouble with that also. Why> IntelliJ stores the attributes (preferredSize, windowClosing, etc.) in its own .class files, contained in a com.intellij package. To pull up the form via Jython, you need to reference theis package. If you know your Jaa forms, and can do it via code, this way with alleviate the stress of Jython trying to find the particulars of your form to display.
If you separate your projects as I have stated above, you should be okay, as you can import the com.intellij packages into jython with hno problem and the form will be called correctly by the JVM your are using.
If you want to test your code via the command-line outside of IntelliJ, you can. Naviate to the folder ABOVE source folder and call it with the qulalified path name. Here's an example:
Let's say you have the following directory structure:
/home/patrick/myproj/mycode
I use a global out folder in IntelliJ, so it looks like this:
/home/patrick/out/production/myproj mycode
I create a test.java, and compile it. It puts the class files in the /mycode folder. Then I navigate to /home/patrick/out/production and call Test like so:
java mycode.Test
It will run. You need to match the package structure in your source file to properlyt call the class.
Lets sayyou have no package name. Navigate to the folder containing the .class file. Then you call Java with the -classpath option (listing your folder) and the class.
java -classpath /home/patrick/myproj/mycode Test
That's is for now. Fell free to comment, or provide correction. I still have a lot to learn. if you have successfully developed a JythonJava project using your own classes, let me know how and I will update this post.
Thank you and happy coding!
I will explain:
If you are pulling from extablished Java packages (JAR files), it's very easy.
However, if you are developing YOUR OWN Java classes, this is where the roadblocks start popping up. What I have found is that it's easier (in the long run) to develop you own classes in a Java project, and package them into a JAR file. Then create a separate Jython package that points to the JAR file. You can actually add it as a library in your Project settings,
The reason for this is that IntelliJ actually stores all your .class files in an output directory you must specify. So,m when you open up a .py file, it can see your code internally, but the actual .class files are somewhere else. And if you use a package structure, Jython cannot see the .class files, so it breaks the code.
For the really adventurous, you need to navigate to your output folder, call the java class with the FULLY qualified name, and it will work.
Much better to simply start a Jython project abnd point it to your output folderwhere your .class files are stored. Even easier to do the Java code, bundle it in a JAR and use Jython to call it with the qualified package name.
My ealier post on setting up IntelliJ was to work on Jython ITSELF, not for general Jython development.
I have also discovered that if you use IntelliJ's GUI builder to do your forms, Jython has a lot of trouble with that also. Why> IntelliJ stores the attributes (preferredSize, windowClosing, etc.) in its own .class files, contained in a com.intellij package. To pull up the form via Jython, you need to reference theis package. If you know your Jaa forms, and can do it via code, this way with alleviate the stress of Jython trying to find the particulars of your form to display.
If you separate your projects as I have stated above, you should be okay, as you can import the com.intellij packages into jython with hno problem and the form will be called correctly by the JVM your are using.
If you want to test your code via the command-line outside of IntelliJ, you can. Naviate to the folder ABOVE source folder and call it with the qulalified path name. Here's an example:
Let's say you have the following directory structure:
/home/patrick/myproj/mycode
I use a global out folder in IntelliJ, so it looks like this:
/home/patrick/out/production/myproj mycode
I create a test.java, and compile it. It puts the class files in the /mycode folder. Then I navigate to /home/patrick/out/production and call Test like so:
java mycode.Test
It will run. You need to match the package structure in your source file to properlyt call the class.
Lets sayyou have no package name. Navigate to the folder containing the .class file. Then you call Java with the -classpath option (listing your folder) and the class.
java -classpath /home/patrick/myproj/mycode Test
That's is for now. Fell free to comment, or provide correction. I still have a lot to learn. if you have successfully developed a JythonJava project using your own classes, let me know how and I will update this post.
Thank you and happy coding!
Sunday, April 1, 2018
Set up Jython Projects in IntelliJ IDEA
Hi all,
I personally use Jet Brain's IntelliJ IDEA (Community Edition 2018.1 at the time I write this) to develop my Jython projects. It can be used to help develop Jython itself. I will include screen-shots, and, hopefully you can set it up successfully. you may obtain the Community Editions from www.jetbrains.com. They are free.
I currently use Ubuntu 16.04 as my OS, but this should work in Windows as well.
Prerequisites:
You need to have Pycharm installed on your system as well, to take advantage of the Python plugin available for IntelliJ. install Pycharm first, and configure your Python interpreters. intelliJ will search for these when setting up the projects.
If you don't have Python installed, on Linux, you can download and install Python 2.X and 3.Z using the apt-get commands:
sudo apt-get install python (for Python 2) and
sudo apt-get install python3 (for Python 3.X)
Once you install Python and set up up Pycharm to use the Python interpreters, then you may install IntelliJ.
If you are cloning projects from GitHub or Mercurial, you need to have them installed on your system.
Set up IntelliJ to use Python/Jython:
When you've installed IntelliJ, the first window is where you select your project, At the bottom right, click Configure, then select Plugins. You will need to add the plugin for Pycharm.
Look for the Pycharm Community Edition plugin. If you don't have it, you need to download and install. Click "Install JetBrains plugin".
In the search dialog, type a partial name. Then select Pycharm Community Edition. On the right, there will be a green Install button. Click and follow the prompts. You may need to restart the IDE.
When you restart IntelliJ, you are now ready to set up a Jython project. The following screen-shots are for setting up the Jython development project.
Select "Check out project" from the main window, then select Mercurial. (This post will be updated later, when they move the project to GitHub). The link is https://hg.python.org/jython. The default directory will be <root>/IdeaProjects/<projectname>. If you want to store the source files somewhere else, put the path here. Then click "Clone". When it finishes, it will ask you if you want to create a project. Agree.
The project defaults can be accepted except in two places: The first one is shown below. At this screen, there are two options on setting up the projec: file based, or directory based. Choosing directory based makes it easier to compile and build your project. more explanation will follow later on, when i discuss the building your project.
The second is the modules screen. You only need one, your main folder. In the screenshot below, my folder is jydev, and that's the only module I need. unselect all the other ones. It doesn't remove the directories. Again this makes compiling your proect a lot easier.
Once you've finished setting up your project, it will open and be ready. Now, whe will go through the project structure and tweak the settings.
From the File menu, select "Project Structure".
Under the Project menu item, select the Java JDK you will work with. While you can use any JDK, for Jython, it is strongly suggested to use JDK8 or below, pending integration with JDK9. For me, I picked JDK1.8. If there are no JDKs set up yet, then click "New", then find the JDK directory. Then click OK to return to the Project setting.
Next is the "Modules" setting. When it set up your project, IntelliJ automatically found your Python sources (as shown by the arrows). Click Python, then select your Jython interpreter. If there is no Jython interpreter set up, click the ellipses to the right of the drop-down. The SDK window will appear. Click the "plus" to add an SDK and find your Jython installation path. it will add it as a SDK. Once that's done, click OK to return to the Modules menu. For all Python code, select Jython as the interpreter.
NOTE: If you are working on Jython itself, you can choose the development Jython as your interpreter. Just add it at the SDK screen, change the name label. Use the release Jython for your other projects.
Under SDK, you can leave it set to the JDK you selected in the project menu.
Under Global Libraries, check to make sure they it shows Jython and Python libraries. You may add other libraries you want to use with your project, such as your own libraries.
The above steps are for setting up general Jython projects you want to develop The following screen-shots are specifically for Jython development itself.
note: If you would like to use the "Build project" from the menu, there are some steps to ensure a successful build. You will need to run Ant at least once, to generate the build folder. Follow the Ant setup section.
You may use IntelliJ's "Build project" option (from the Build menu. Or you can use Jython's own build.xml file and Ant to build your project. I have my IDE set to show the Toolbar, and also Tool Buttons (from the View menu). Tool Buttons will give you the buttons on the left, right and bottom of the window. on the right side, are the ant and Maven buttons. Click "Ant Build" to bring up the dialog. As you see, it doesn't show anything.
Click the "plus" to add. Search for the build.xml file that is in the your project directory. Click OK and it will add it.
Now, it will show a list of Ant build options. if you click filter (the green icon to the right of "Run"), it will only show the Ant build selections contained in the build.xml file. We will use "developer-build". Right-click "deverloper-build" and select Properties.
Leave the settings the way they are. under the Execution tab, you can verify that it's set to the project's JDK. Click OK when finished. Then double-click "developer-build" and let it run. It will compile all of the Java source files. If it gives warning messages, it's all right. As long as there's no fatal errors, Jython will build successfully.
Now that you've built Jython, you can now run it from within the IDE. You must choose the Python interpreter, as it runs under Python. In your /dist/bin folder (in the projecxt file tree), find the jython.py file. The first time, it will ask you to configure it.
Windows users: You should run the jython.exe file, instead of the jython.py file
This window will open. you can put any parameters you like (such as any JVM options, or switches). For a list of options, at the terminal, run Jython with the -h for help. In the environment section, select "Use specified interpreter" and select Python 2.7. Then check the box for "Emulate terminal in output console" (so that you will see the interactive prompts, >>> and ...). When you're finished, click OK. then select "Run" from the "Run" menu item.
There, you're all done. Note: Any Python files containing inline Java code, you should select Jython 2.7 as the interpreter (if it hasn't already). Only the jython.py file needs to run under Python.
The debugger will use the same interpreter as the Run configuration, so for jython.py it will use Python. All others will use the Jython debugger or the Java debugger (if it is a .java source file).
Building the Project
If you ran Ant and it returned an error, don't despair. The next section will help in setting up the source code and libraries to build and then you can run Ant again successfully.
You need to make sure that *all* of your sourcesfolders are chosen. IntelliJ is sort of strange in this regard. open your Porject Structure, go to your Modules. you will see all the subfolders under your jython folder. After you ran Ant, it created a /build folder. Navigate to the "gensrc" folder, expand and select all folders . Once they are highlighted, click Source. The folders will turn blue. Do the same for the src and all sub-folders.
Next, you need some external libraries. I had to add an Ant library, an informix library and an ojdb library. Click _ then select "Java", navigate to the folder containing the .jar file. Select the .jar file, then click OK. Click OK again to attach it to your jython module.
Once you coomplete these stepts, click OK and then run "Build porject" from the Build menu.
I hope this tutorial is clear and easy to follow. If you continue to have trouble and need more help, please contact me at psykiatris@gmail.com and I will be very glad to help you.
Happy coding!
I personally use Jet Brain's IntelliJ IDEA (Community Edition 2018.1 at the time I write this) to develop my Jython projects. It can be used to help develop Jython itself. I will include screen-shots, and, hopefully you can set it up successfully. you may obtain the Community Editions from www.jetbrains.com. They are free.
I currently use Ubuntu 16.04 as my OS, but this should work in Windows as well.
Prerequisites:
You need to have Pycharm installed on your system as well, to take advantage of the Python plugin available for IntelliJ. install Pycharm first, and configure your Python interpreters. intelliJ will search for these when setting up the projects.
If you don't have Python installed, on Linux, you can download and install Python 2.X and 3.Z using the apt-get commands:
sudo apt-get install python (for Python 2) and
sudo apt-get install python3 (for Python 3.X)
Once you install Python and set up up Pycharm to use the Python interpreters, then you may install IntelliJ.
If you are cloning projects from GitHub or Mercurial, you need to have them installed on your system.
Set up IntelliJ to use Python/Jython:
When you've installed IntelliJ, the first window is where you select your project, At the bottom right, click Configure, then select Plugins. You will need to add the plugin for Pycharm.
Look for the Pycharm Community Edition plugin. If you don't have it, you need to download and install. Click "Install JetBrains plugin".
In the search dialog, type a partial name. Then select Pycharm Community Edition. On the right, there will be a green Install button. Click and follow the prompts. You may need to restart the IDE.
When you restart IntelliJ, you are now ready to set up a Jython project. The following screen-shots are for setting up the Jython development project.
Select "Check out project" from the main window, then select Mercurial. (This post will be updated later, when they move the project to GitHub). The link is https://hg.python.org/jython. The default directory will be <root>/IdeaProjects/<projectname>. If you want to store the source files somewhere else, put the path here. Then click "Clone". When it finishes, it will ask you if you want to create a project. Agree.
The project defaults can be accepted except in two places: The first one is shown below. At this screen, there are two options on setting up the projec: file based, or directory based. Choosing directory based makes it easier to compile and build your project. more explanation will follow later on, when i discuss the building your project.
The second is the modules screen. You only need one, your main folder. In the screenshot below, my folder is jydev, and that's the only module I need. unselect all the other ones. It doesn't remove the directories. Again this makes compiling your proect a lot easier.
Once you've finished setting up your project, it will open and be ready. Now, whe will go through the project structure and tweak the settings.
From the File menu, select "Project Structure".
Under the Project menu item, select the Java JDK you will work with. While you can use any JDK, for Jython, it is strongly suggested to use JDK8 or below, pending integration with JDK9. For me, I picked JDK1.8. If there are no JDKs set up yet, then click "New", then find the JDK directory. Then click OK to return to the Project setting.
Next is the "Modules" setting. When it set up your project, IntelliJ automatically found your Python sources (as shown by the arrows). Click Python, then select your Jython interpreter. If there is no Jython interpreter set up, click the ellipses to the right of the drop-down. The SDK window will appear. Click the "plus" to add an SDK and find your Jython installation path. it will add it as a SDK. Once that's done, click OK to return to the Modules menu. For all Python code, select Jython as the interpreter.
NOTE: If you are working on Jython itself, you can choose the development Jython as your interpreter. Just add it at the SDK screen, change the name label. Use the release Jython for your other projects.
Under SDK, you can leave it set to the JDK you selected in the project menu.
The above steps are for setting up general Jython projects you want to develop The following screen-shots are specifically for Jython development itself.
note: If you would like to use the "Build project" from the menu, there are some steps to ensure a successful build. You will need to run Ant at least once, to generate the build folder. Follow the Ant setup section.
You may use IntelliJ's "Build project" option (from the Build menu. Or you can use Jython's own build.xml file and Ant to build your project. I have my IDE set to show the Toolbar, and also Tool Buttons (from the View menu). Tool Buttons will give you the buttons on the left, right and bottom of the window. on the right side, are the ant and Maven buttons. Click "Ant Build" to bring up the dialog. As you see, it doesn't show anything.
Now, it will show a list of Ant build options. if you click filter (the green icon to the right of "Run"), it will only show the Ant build selections contained in the build.xml file. We will use "developer-build". Right-click "deverloper-build" and select Properties.
Now that you've built Jython, you can now run it from within the IDE. You must choose the Python interpreter, as it runs under Python. In your /dist/bin folder (in the projecxt file tree), find the jython.py file. The first time, it will ask you to configure it.
Windows users: You should run the jython.exe file, instead of the jython.py file
This window will open. you can put any parameters you like (such as any JVM options, or switches). For a list of options, at the terminal, run Jython with the -h for help. In the environment section, select "Use specified interpreter" and select Python 2.7. Then check the box for "Emulate terminal in output console" (so that you will see the interactive prompts, >>> and ...). When you're finished, click OK. then select "Run" from the "Run" menu item.
There, you're all done. Note: Any Python files containing inline Java code, you should select Jython 2.7 as the interpreter (if it hasn't already). Only the jython.py file needs to run under Python.
The debugger will use the same interpreter as the Run configuration, so for jython.py it will use Python. All others will use the Jython debugger or the Java debugger (if it is a .java source file).
Building the Project
If you ran Ant and it returned an error, don't despair. The next section will help in setting up the source code and libraries to build and then you can run Ant again successfully.
You need to make sure that *all* of your sourcesfolders are chosen. IntelliJ is sort of strange in this regard. open your Porject Structure, go to your Modules. you will see all the subfolders under your jython folder. After you ran Ant, it created a /build folder. Navigate to the "gensrc" folder, expand and select all folders . Once they are highlighted, click Source. The folders will turn blue. Do the same for the src and all sub-folders.
Next, you need some external libraries. I had to add an Ant library, an informix library and an ojdb library. Click _ then select "Java", navigate to the folder containing the .jar file. Select the .jar file, then click OK. Click OK again to attach it to your jython module.
Once you coomplete these stepts, click OK and then run "Build porject" from the Build menu.
I hope this tutorial is clear and easy to follow. If you continue to have trouble and need more help, please contact me at psykiatris@gmail.com and I will be very glad to help you.
Happy coding!
Friday, February 23, 2018
Fun with list comprehensions
Hello!
Occasionally, I will be adding to this post, but I've been playing with list comprehensions. So, the code snippets I have here are 'tests' for you to take. I will post the code, and I will ask for an explanation on what the code does.
I will post the answers in another post.
The goal of this is to stimulate your mind so that you can dream up techniques and code that will be a big help. If you find the code useful in your own programs, that's great. If you could credit me in your documentation, even better.
If you need any help with your own code, I'd be happy to help you.
Happy coding!
Example 1: I was goofing around and developed this list comprehension. Can you explain what this does? This code is uses Python 3. If you are using Python 2.7 use print without parentheses. If you are entering this in your interactive python session, you do not need print.
===================
alpha = 'abcdefghijklmnopqrstuvwxyz'
print([chr(ord(x)) for x in alpha if ord(x) % 2 == 0])
===============
Occasionally, I will be adding to this post, but I've been playing with list comprehensions. So, the code snippets I have here are 'tests' for you to take. I will post the code, and I will ask for an explanation on what the code does.
I will post the answers in another post.
The goal of this is to stimulate your mind so that you can dream up techniques and code that will be a big help. If you find the code useful in your own programs, that's great. If you could credit me in your documentation, even better.
If you need any help with your own code, I'd be happy to help you.
Happy coding!
Example 1: I was goofing around and developed this list comprehension. Can you explain what this does? This code is uses Python 3. If you are using Python 2.7 use print without parentheses. If you are entering this in your interactive python session, you do not need print.
===================
alpha = 'abcdefghijklmnopqrstuvwxyz'
print([chr(ord(x)) for x in alpha if ord(x) % 2 == 0])
===============
Subscribe to:
Posts (Atom)