Agentic Development in Python

[coherent17]

Hi RapidWright team,

I'm looking for advice on how to help AI tools write better code using the RapidWright Python API.

My challenge:
When using RapidWright in Python (via JPype), AI coding assistants sometimes struggle because:

1. The Python API is a wrapper around the Java implementation
2. The differences between Java and Python APIs can confuse the AI. This leads to incorrect code suggestions

What I've tried:
I cloned the documentation from https://github.com/clavin-xlnx/RapidWrightPages and provided it to the AI as reference material. However, the Java-to-Python translation still causes issues.

My question:
Do you have any recommendations, reference materials, or best practices that could help AI coding assistants better understand and generate correct code for the RapidWright Python API?

Thanks,
Coherent

[clavin-xlnx]

This is a great question! I have not experienced this issue myself, (at least not chronically). What AI model(s) are you using that are exhibiting this behavior?

One idea would be to point your agent at this page of Jpype documentation that provides a Quick Start Guide for Java/Python interaction:
https://jpype.readthedocs.io/en/latest/quickguide.html

That might give it the added context to avoid the Java/Python differences in syntax. Let us know how it goes or if there are any specific attempts we can make to try to reproduce.

[coherent17]

Hi Chris,

Thanks for replying, I'm using Claude sonnet model, I'll try point out to the Jpype document and see if the discrepancy can be eliminated!

Thanks for the suggestion.