Merge pull request #22 from adator85/V1.x.x

Moving to 1.1.0 version.

Author: adator85

.gitignore

@@ -7,5 +7,6 @@ tests/*
 docs/*
 setup.py
 test.py
+test_live.py
 CallbackObject.py
 *.zip

README.MD

@@ -18,6 +18,7 @@ If you are using Python3, this package can help you to parse all json responses
 > I recommend installing a virtual environment and then installing the package within it.
 
 ## How to establish the link
+### Using requests module
 ```python
     from unrealircd_rpc_py.Loader import Loader
     # Using requests method
@@ -27,30 +28,41 @@ If you are using Python3, this package can help you to parse all json responses
             username='apiname',
             password='apiPASSWORD'
         )
-
+```
+### Using socket method
+```python
+    from unrealircd_rpc_py.Loader import Loader
     # Using socket method
     rpc = Loader(
             req_method='socket',
             url='https://your.irc.domaine.org:8600/api',
             username='apiname',
             password='apiPASSWORD'
         )
-
+```
+### Using unixsocket method (Local only)
+```python
+    from unrealircd_rpc_py.Loader import Loader
     # Using unixsocket method (Local only)
     rpc = Loader(
             req_method='unixsocket',
             path_to_socket_file='/path/to/unrealircd/data/rpc.socket'
         )
-
+```
+### Live Connection (Local Only)
+```python
     from unrealircd_rpc_py.Live import Live
-    # Live Connection (Local only)
+    # Live Connection (Local only) using unix socket
     LiveRpc = Live(
         req_method='unixsocket',
         path_to_socket_file='/path/to/unrealircd/data/rpc.socket',
         callback_object_instance=Callback_class_instance,
         callback_method_name='your_method_name'
     )
-
+```
+### Live connection (Local or Remote)
+```python
+    from unrealircd_rpc_py.Live import Live
     # Live Connection (Local Or Remote)
     liveRpc = Live(
         req_method='websocket',
@@ -60,7 +72,6 @@ If you are using Python3, this package can help you to parse all json responses
         callback_object_instance=InitCallbackClass,
         callback_method_name='your_method_name'
     )
-
 ```
 ## How to work with (remotly)
 This package allows easy interfacing with UnrealIRCd through regular Python3 code, such as:
@@ -107,9 +118,17 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
         )
 
     # Enjoy the power of JSON-RPC
-
     User = rpc.User
     response = User.get('adator')
+    
+    # Handling errors
+    if rpc.get_error.code != 0:
+        # if code is not 0 then there is an error
+        print(f"Your Error Message: {rpc.get_error.message}")
+    
+    # You can also access errors like so:
+    if User.get_error.code != 0:
+        print(f"Your Error Message: {User.get_error.message}")
 
     print(f'Nickname: {response.name}')
     print(f'Ip: {response.ip}')
@@ -166,12 +185,12 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
 
     # This method will run forever and will send to your callback method the response
     # in SimpleNameSpace type that you can parse
-    if liveRpc.Error.code == 0:
+    if liveRpc.get_error.code == 0:
         # Subscribe to live events
         liveRpc.subscribe()
     else:
         # If error show the error message
-        print(liveRpc.Error.message)
+        print(liveRpc.get_error.message)
 ```
 ## How to work with (using Live websocket)
 ```python
@@ -193,12 +212,12 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
 
     # This method will run forever and will send to your callback method the response
     # in SimpleNameSpace type that you can parse
-    if liveRpc.Error.code == 0:
+    if liveRpc.get_error.code == 0:
         # Subscribe to live events
         liveRpc.subscribe()
     else:
         # If error show the error message
-        print(liveRpc.Error.message)
+        print(liveRpc.get_error.message)
 ```
 
 ## Exemple of a Callback Class

how_to_use_it.py

@@ -35,4 +35,4 @@
             print(mod.name)
 
 except AttributeError as ae:
-    rpc.Connection.Logs.error(ae)
+    print(ae)

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='unrealircd_rpc_py',
-    version='1.0.8',
+    version='1.1.0',
     packages=find_packages(),
     install_requires=[
         "requests>=2.25.1",

unrealircd_rpc_py/Channel.py

@@ -10,7 +10,7 @@ class Channel:
     def __init__(self, connection: Connection) -> None:
 
         # Store the original response
-        self.response_raw: str
+        self.response_raw: str = ''
         """Original response used to see available keys."""
 
         self.response_np: SimpleNamespace
@@ -25,6 +25,14 @@ def __init__(self, connection: Connection) -> None:
     def get_error(self) -> Dfn.RPCError:
         return self.Error
 
+    @property
+    def get_response(self) -> Union[dict, None]:
+        return self.Connection.get_response()
+
+    @property
+    def get_response_np(self) -> Union[SimpleNamespace, None]:
+        return self.Connection.get_response_np()
+
     def list_(self, object_detail_level: Literal[0, 1, 2, 3, 4] = 1) -> list[Dfn.Channel]:
         """List channels.
 
@@ -42,10 +50,7 @@ def list_(self, object_detail_level: Literal[0, 1, 2, 3, 4] = 1) -> list[Dfn.Cha
             self.DB_CHANNELS = []
             self.Connection.EngineError.init_error()
 
-            response = self.Connection.query(method='channel.list', param={'object_detail_level': object_detail_level})
-
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
+            response:dict[str, dict] = self.Connection.query(method='channel.list', param={'object_detail_level': object_detail_level})
 
             if response is None:
                 self.Logs.error('Empty response')
@@ -100,9 +105,6 @@ def get(self, channel: str, object_detail_level: int = 3) -> Union[Dfn.Channel,
 
             response: dict[str, dict] = self.Connection.query(method='channel.get', param={'channel': channel, 'object_detail_level': object_detail_level})
 
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
-
             if response is None:
                 self.Logs.error('Empty response')
                 self.Connection.EngineError.set_error(code=-2, message='Empty response')
@@ -146,7 +148,7 @@ def get(self, channel: str, object_detail_level: int = 3) -> Union[Dfn.Channel,
 
                 db_members.append(member_obj)
 
-            objectChannel = Dfn.Channel(
+            channel_obj = Dfn.Channel(
                         **channel_copy,
                         bans=[Dfn.ChannelBans(**ban) for ban in channel.get('bans', [])],
                         ban_exemptions=[Dfn.ChannelBanExemptions(**ban_ex) for ban_ex in channel.get('ban_exemptions', [])],
@@ -155,7 +157,7 @@ def get(self, channel: str, object_detail_level: int = 3) -> Union[Dfn.Channel,
                         members=db_members
                     )
 
-            return objectChannel
+            return channel_obj
 
         except KeyError as ke:
             self.Logs.error(f'KeyError: {ke}')
@@ -178,10 +180,7 @@ def set_mode(self, channel: str, modes: str, parameters: str = "") -> bool:
         try:
             self.Connection.EngineError.init_error()
 
-            response = self.Connection.query(method='channel.set_mode', param={"channel": channel,"modes": modes,"parameters": parameters})
-
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
+            response:dict[str, dict] = self.Connection.query(method='channel.set_mode', param={"channel": channel,"modes": modes,"parameters": parameters})
 
             if response is None:
                 self.Logs.error('Empty response')
@@ -202,8 +201,10 @@ def set_mode(self, channel: str, modes: str, parameters: str = "") -> bool:
 
         except KeyError as ke:
             self.Logs.error(f'KeyError: {ke}')
+            return False
         except Exception as err:
             self.Logs.error(f'General error: {err}')
+            return False
 
     def set_topic(self, channel: str, topic: str, set_by: str = None, set_at: str = None) -> bool:
         """Set a topic on a channel.
@@ -220,10 +221,7 @@ def set_topic(self, channel: str, topic: str, set_by: str = None, set_at: str =
         try:
             self.Connection.EngineError.init_error()
 
-            response = self.Connection.query(method='channel.set_topic', param={"channel": channel, "topic": topic, "set_by": set_by, "set_at": set_at})
-
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
+            response:dict[str, dict] = self.Connection.query(method='channel.set_topic', param={"channel": channel, "topic": topic, "set_by": set_by, "set_at": set_at})
 
             if response is None:
                 self.Logs.error('Empty response')
@@ -244,8 +242,10 @@ def set_topic(self, channel: str, topic: str, set_by: str = None, set_at: str =
 
         except KeyError as ke:
             self.Logs.error(f'KeyError: {ke}')
+            return False
         except Exception as err:
             self.Logs.error(f'General error: {err}')
+            return False
 
     def kick(self, channel: str, nick: str, reason: str) -> bool:
         """Kick a user from a channel
@@ -261,10 +261,7 @@ def kick(self, channel: str, nick: str, reason: str) -> bool:
         try:
             self.Connection.EngineError.init_error()
 
-            response = self.Connection.query(method='channel.kick', param={"channel": channel, "nick": nick, "reason": reason})
-
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
+            response:dict[str, dict] = self.Connection.query(method='channel.kick', param={"channel": channel, "nick": nick, "reason": reason})
 
             if response is None:
                 self.Logs.error('Empty response')
@@ -285,5 +282,7 @@ def kick(self, channel: str, nick: str, reason: str) -> bool:
 
         except KeyError as ke:
             self.Logs.error(f'KeyError: {ke}')
+            return False
         except Exception as err:
-            self.Logs.error(f'General error: {err}')
+            self.Logs.error(f'General error: {err}')
+            return False