Integrate Python driver examples into automated build process

- Add examples execution to gremlin-python-integration-tests container
- Make server URLs configurable via environment variables
- Add cleanup for mutating examples
- Graph binding detection (gmodern in CI, g locally)
- Handle SSL certificates and Kerberos failures
- Build fails if any example fails to execute

Author: kirill-stepanishin

CHANGELOG.asciidoc

@@ -28,6 +28,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
 * Added properties to `Element` objects found in a `Path` for GraphSON v2 and v3 and GraphBinary.
 * Fixed edge properties for GraphBinary which were not deserializing properly.
 * Bump netty to 4.1.125.Final
+* Integrated Python driver examples into automated build process to ensure examples remain functional.
 
 [[release-3-7-4]]
 === TinkerPop 3.7.4 (Release Date: August 1, 2025)

gremlin-python/docker-compose.yml

@@ -75,7 +75,12 @@ services:
       && python3 ./setup.py test
       && python3 ./setup.py install
       && radish -f dots -e -t -b ./radish ./gremlin-test --user-data='serializer=application/vnd.gremlin-v3.0+json'
-      && radish -f dots -e -t -b ./radish ./gremlin-test --user-data='serializer=application/vnd.graphbinary-v1.0';
+      && radish -f dots -e -t -b ./radish ./gremlin-test --user-data='serializer=application/vnd.graphbinary-v1.0'
+      && echo 'Running examples...'
+      && python3 examples/basic_gremlin.py
+      && python3 examples/connections.py
+      && python3 examples/modern_traversals.py
+      && echo 'All examples completed successfully';
       EXIT_CODE=$$?; chown -R `stat -c "%u:%g" .` .; exit $$EXIT_CODE"
     depends_on:
       gremlin-server-test-python:

gremlin-python/src/main/python/examples/basic_gremlin.py

@@ -16,6 +16,7 @@
 # under the License.
 
 import sys
+import os
 
 sys.path.append("..")
 
@@ -25,9 +26,13 @@
 
 
 def main():
-    rc = DriverRemoteConnection('ws://localhost:8182/gremlin', 'g')
+    server_url = os.getenv('GREMLIN_SERVER_URL', 'ws://localhost:8182/gremlin').format(45940)
+    rc = DriverRemoteConnection(server_url, 'g')
     g = traversal().with_remote(rc)
 
+    # drop existing vertices
+    g.V().drop().iterate()
+
     # basic Gremlin: adding and retrieving data
     v1 = g.add_v('person').property('name', 'marko').next()
     v2 = g.add_v('person').property('name', 'stephen').next()
@@ -47,6 +52,9 @@ def main():
     for person in people_marko_knows:
         print("marko knows " + person)
 
+    # clean added data
+    g.V().drop().iterate()
+
     rc.close()
 
 

gremlin-python/src/main/python/examples/connections.py

@@ -16,13 +16,16 @@
 # under the License.
 
 import sys
+import os
+import ssl
 
 sys.path.append("..")
 
 from gremlin_python.process.anonymous_traversal import traversal
 from gremlin_python.process.strategies import *
 from gremlin_python.driver.driver_remote_connection import DriverRemoteConnection
 from gremlin_python.driver.serializer import GraphBinarySerializersV1
+from gremlin_python.driver.aiohttp.transport import AiohttpTransport
 
 
 def main():
@@ -40,7 +43,8 @@ def with_remote():
     #
     # which starts it in "console" mode with an empty in-memory TinkerGraph ready to go bound to a
     # variable named "g" as referenced in the following line.
-    rc = DriverRemoteConnection('ws://localhost:8182/gremlin', 'g')
+    server_url = os.getenv('GREMLIN_SERVER_URL', 'ws://localhost:8182/gremlin').format(45940)
+    rc = DriverRemoteConnection(server_url, 'g')
     g = traversal().with_remote(rc)
 
     # drop existing vertices
@@ -57,32 +61,57 @@ def with_remote():
 
 # connecting with plain text authentication
 def with_auth():
-    rc = DriverRemoteConnection('ws://localhost:8182/gremlin', 'g', username='stephen', password='password')
+    server_url = os.getenv('GREMLIN_SERVER_BASIC_AUTH_URL', 'ws://localhost:8182/gremlin').format(45941)
+    # turn off certificate verification for testing purposes only
+    ssl_opts = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+    ssl_opts.check_hostname = False
+    ssl_opts.verify_mode = ssl.CERT_NONE
+    rc = DriverRemoteConnection(server_url, 'g', username='stephen', password='password',
+                                transport_factory=lambda: AiohttpTransport(ssl_options=ssl_opts))
     g = traversal().with_remote(rc)
 
+    # drop existing vertices
+    g.V().drop().iterate()
+
     v = g.add_v().iterate()
     count = g.V().count().next()
     print("Vertex count: " + str(count))
 
+    # clean added data
+    g.V().drop().iterate()
     rc.close()
 
 
 # connecting with Kerberos SASL authentication
 def with_kerberos():
-    rc = DriverRemoteConnection('ws://localhost:8182/gremlin', 'g', kerberized_service='[email protected]')
-    g = traversal().with_remote(rc)
+    server_url = os.getenv('GREMLIN_SERVER_URL', 'ws://localhost:8182/gremlin').format(45942)
+    kerberos_hostname = os.getenv('KRB_HOSTNAME', 'gremlin-server-test')
+    kerberized_service = f'test-service@{kerberos_hostname}'
+    
+    try:
+        rc = DriverRemoteConnection(server_url, 'g', kerberized_service=kerberized_service)
+        g = traversal().with_remote(rc)
 
-    v = g.add_v().iterate()
-    count = g.V().count().next()
-    print("Vertex count: " + str(count))
+        # drop existing vertices
+        g.V().drop().iterate()
 
-    rc.close()
+        v = g.add_v().iterate()
+        count = g.V().count().next()
+        print("Vertex count: " + str(count))
+
+        # clean added data
+        g.V().drop().iterate()
+        rc.close()
+    except Exception as e:
+        print(f"Kerberos authentication failed (expected in test environment): {e}")
+        # This is expected to fail in CI without proper Kerberos setup
 
 
 # connecting with customized configurations
 def with_configs():
+    server_url = os.getenv('GREMLIN_SERVER_URL', 'ws://localhost:8182/gremlin').format(45940)
     rc = DriverRemoteConnection(
-        'ws://localhost:8182/gremlin', 'g',
+        server_url, 'g',
         username="", password="", kerberized_service='',
         message_serializer=GraphBinarySerializersV1(), graphson_reader=None,
         graphson_writer=None, headers=None, session=None,
@@ -94,6 +123,9 @@ def with_configs():
     count = g.V().count().next()
     print("Vertex count: " + str(count))
 
+    # clean added data
+    g.V().drop().iterate()
+
     rc.close()
 
 

gremlin-python/src/main/python/examples/modern_traversals.py

@@ -16,6 +16,7 @@
 # under the License.
 
 import sys
+import os
 
 sys.path.append("..")
 
@@ -31,7 +32,15 @@ def main():
     # This example requires the Modern toy graph to be preloaded upon launching the Gremlin server.
     # For details, see https://tinkerpop.apache.org/docs/current/reference/#gremlin-server-docker-image and use
     # conf/gremlin-server-modern.yaml.
-    rc = DriverRemoteConnection('ws://localhost:8182/gremlin', 'g')
+    server_url = os.getenv('GREMLIN_SERVER_URL', 'ws://localhost:8182/gremlin').format(45940)
+    
+    # CI uses port 45940 with gmodern binding, local uses 8182 with g binding
+    if ':45940' in server_url:
+        graph_binding = 'gmodern'  # CI environment
+    else:
+        graph_binding = 'g'        # Local environment
+    
+    rc = DriverRemoteConnection(server_url, graph_binding)
     g = traversal().with_remote(rc)
 
     e1 = g.V(1).both_e().to_list()  # (1)