moving examples and making close() method of connection public again

Author: DanielePalaia

README.md

@@ -32,9 +32,9 @@ The client is distributed via [`PIP`](https://pypi.org/project/rabbitmq-amqp-pyt
 
 ## Getting Started
 
-An example is provided [`here`](./examples/getting_started/basic_example.py) you can run it after starting a RabbitMQ 4.0 broker with:
+An example is provided [`here`](./examples/getting_started/getting_started.py) you can run it after starting a RabbitMQ 4.0 broker with:
 
-poetry run python ./examples/getting_started/main.py
+poetry run python ./examples/getting_started/getting_started.py
 
 ### Creating a connection
 
@@ -132,21 +132,21 @@ You can consume from a given offset or specify a default starting point (FIRST,
 
 Streams filtering is also supported: https://www.rabbitmq.com/blog/2023/10/16/stream-filtering
 
-You can check the [`stream example`](./examples/getting_started/example_with_streams.py) to see how to work with RabbitMQ streams.
+You can check the [`stream example`](./examples/streams/example_with_streams.py) to see how to work with RabbitMQ streams.
 
 ### SSL connections
 
 The client supports TLS/SSL connections.
 
-You can check the [`ssl example`](./examples/getting_started/tls_example.py) to see how to establish a secured connection
+You can check the [`ssl example`](./examples/tls/tls_example.py) to see how to establish a secured connection
 
 
 ### Managing disconnections
 
 At this stage the client doesn't support auto-reconnect but a callback is invoked everytime a remote disconnection is detected.
 You can use this callback to implement your own logic and eventually attempt a reconnection.
 
-You can check the [`reconnection example`](./examples/getting_started/reconnection_example.py) to see how to manage disconnections and
+You can check the [`reconnection example`](./examples/reconnection/reconnection_example.py) to see how to manage disconnections and
 eventually attempt a reconnection
 
 

examples/README.md

@@ -0,0 +1,6 @@
+Client examples
+===
+ - [Getting started](./getting_started/getting_started.py) - Producer and Consumer example without reconnection
+ - [Reconnection](./reconnection/reconnection_example.py) - Producer and Consumer example with reconnection
+ - [TLS](./tls/tls_example.py) - Producer and Consumer using a TLS connection
+ - [Streams](./streams/example_with_streams.py) - Example supporting stream capabilities

examples/getting_started/basic_example.py renamed to examples/getting_started/getting_started.py

@@ -77,8 +77,7 @@ def management(self) -> Management:
         return self._management
 
     # closes the connection to the AMQP 1.0 server.
-    # This method should be called just from Environment and not from the user
-    def _close(self) -> None:
+    def close(self) -> None:
         logger.debug("Closing connection")
         self._conn.close()
         self._connections.remove(self)

examples/getting_started/reconnection_example.py renamed to examples/reconnection/reconnection_example.py

@@ -37,10 +37,11 @@ def connection(
         connection._set_environment_connection_list(self._connections)
         return connection
 
+    # closes all active connections
     def close(self) -> None:
         logger.debug("Environment: Closing all pending connections")
         for connection in self._connections:
-            connection._close()
+            connection.close()
 
     def connections(self) -> list[Connection]:
         return self._connections

examples/getting_started/example_with_streams.py renamed to examples/streams/example_with_streams.py

@@ -56,15 +56,15 @@ def test_environment_connections_management() -> None:
     assert len(environment.connections()) == 3
 
     # this shouldn't happen but we test it anyway
-    connection._close()
+    connection.close()
 
     assert len(environment.connections()) == 2
 
-    connection2._close()
+    connection2.close()
 
     assert len(environment.connections()) == 1
 
-    connection3._close()
+    connection3.close()
 
     assert len(environment.connections()) == 0