Skip to content

Python async driver and small updates #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

apetenchea
Copy link
Member

Description

I suggest making the following changes:

  1. Adding the python-arango-async driver to the list of supported drivers. It is now stable and can be used. The link I pointed at for the tutorial is not yet ready, but there will be a tutorial on the wiki very soon. I just wanted to put it there already in order to skip an additional PR just for that.
  2. The "The response is a JSON object with the following attributes:" statements don't specify any attributes. I believe these are remnants from a previous edit. IMO these are not even needed, because the Responses section already contains a description of the output, and these methods have appropriate examples.

@apetenchea apetenchea requested a review from Simran-B August 12, 2025 06:41
@apetenchea apetenchea self-assigned this Aug 12, 2025
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-760--docs-hugo.netlify.app

@cla-bot cla-bot bot added the cla-signed label Aug 12, 2025
@Simran-B
Copy link
Contributor

@apetenchea Is the different package name the only difference between the sync and async Python drivers? Or is there anything else to point out, some behavior that deviates if you use the async variant?

The HTTP API free-text descriptions used to contain (and some still do) the full description of the response bodies indeed, and we can remove this if there is a structured description now. This is an ongoing process and will take time but I appreciate any help like yours!

@apetenchea
Copy link
Member Author

@apetenchea Is the different package name the only difference between the sync and async Python drivers? Or is there anything else to point out, some behavior that deviates if you use the async variant?

The async driver follows closely the API of python-arango. For example, methods and classes have the same names, and 99% of the time the arguments stay the same. It should be straightforward for someone familiar with python-arango to jump into python-arango-async.
But, it is not a drop-in replacement. For one, is uses a different technology (async functions) which require difference packages and dependencies (eg aiohttp instead of the classic requests). And sometimes a method or class may be modified to accommodate this differences.

I have put together a small summary of the main differences here, to support devs during a potential migration: https://python-arango-async.readthedocs.io/en/latest/migration.html

@Simran-B Simran-B changed the title Small Updates Python async driver and small updates Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants