geobox 2.0.1__py3-none-any.whl → 2.2.0__py3-none-any.whl

geobox/aio/settings.py

@@ -7,17 +7,17 @@ from ..enums import MaxLogPolicy, InvalidDataPolicy, LoginFailurePolicy, MaxConc
 
 if TYPE_CHECKING:
     from . import AsyncGeoboxClient
-    from ..api import GeoboxClient as SyncGeoboxClient
-    from ..settings import SystemSettings as SyncSystemSettings
+    from ..api import GeoboxClient
+    from ..settings import SystemSettings
 
 
-class SystemSettings(AsyncBase):
+class AsyncSystemSettings(AsyncBase):
 
     BASE_ENDPOINT = 'settings/'
 
     def __init__(self, 
-                 api: 'AsyncGeoboxClient', 
-                 data: Optional[Dict] = {}):
+        api: 'AsyncGeoboxClient', 
+        data: Optional[Dict] = {}):
         """
         Initialize a System Settings instance.
 
@@ -79,11 +79,11 @@ class SystemSettings(AsyncBase):
         Returns:
             str: A string representation of the system setting instance.
         """
-        return "SystemSettings()"
+        return "AsyncSystemSettings()"
 
 
     @classmethod
-    async def get_system_settings(cls, api: 'AsyncGeoboxClient') -> 'SystemSettings':
+    async def get_system_settings(cls, api: 'AsyncGeoboxClient') -> 'AsyncSystemSettings':
         """
         [async] Get System Settings object (Permission Required).
 
@@ -91,13 +91,13 @@ class SystemSettings(AsyncBase):
             api (AsyncGeoboxClient): The AsyncGeoboxClient instance for making requests.
 
         Returns:
-            SystemSetting: the system settings object.
+            AsyncSystemSetting: the system settings object.
 
         Example:
             >>> from geobox.aio import AsyncGeoboxClient
-            >>> from geobox.aio.setting import SystemSettings
+            >>> from geobox.aio.setting import AsyncSystemSettings
             >>> async with AsyncGeoboxClient() as client:
-            >>>     setting = await SystemSettings.get_system_settings(client)
+            >>>     setting = await AsyncSystemSettings.get_system_settings(client)
             or  
             >>>     setting = await client.get_system_settings()
         """
@@ -107,7 +107,7 @@ class SystemSettings(AsyncBase):
         query_string = urlencode(params)
         endpoint = urljoin(cls.BASE_ENDPOINT, f"?{query_string}")
         response = await api.get(endpoint)
-        return SystemSettings(api, response)
+        return AsyncSystemSettings(api, response)
 
 
     async def update(self, **kwargs) -> Dict:
@@ -140,9 +140,9 @@ class SystemSettings(AsyncBase):
 
         Example:
             >>> from geobox.aio import AsyncGeoboxClient
-            >>> from geobox.aio.setting import SystemSettings
+            >>> from geobox.aio.setting import AsyncSystemSettings
             >>> async with AsyncGeoboxClient() as client:
-            >>>     settings = await SystemSetting.get_system_settings(client)
+            >>>     settings = await AsyncSystemSetting.get_system_settings(client)
             or  
             >>>     settings = await client.get_system_settings()
             >>>     await settings.update(max_log=100000)
@@ -168,23 +168,23 @@ class SystemSettings(AsyncBase):
         return await super()._update(self.BASE_ENDPOINT, data)
 
 
-    def to_sync(self, sync_client: 'SyncGeoboxClient') -> 'SyncSystemSettings':
+    def to_sync(self, sync_client: 'GeoboxClient') -> 'SystemSettings':
         """
         Switch to sync version of the system settings instance to have access to the sync methods
 
         Args:
-            sync_client (SyncGeoboxClient): The sync version of the GeoboxClient instance for making requests.
+            sync_client (GeoboxClient): The sync version of the GeoboxClient instance for making requests.
 
         Returns:
-            geobox.settings.SystemSettings: the sync instance of the system settings.
+            SystemSettings: the sync instance of the system settings.
 
         Example:
             >>> from geobox import Geoboxclient
             >>> from geobox.aio import AsyncGeoboxClient
-            >>> from geobox.aio.setting import SystemSettings
+            >>> from geobox.aio.setting import AsyncSystemSettings
             >>> client = GeoboxClient()
             >>> async with AsyncGeoboxClient() as async_client:
-            >>>     settings = await SystemSetting.get_system_settings(async_client)
+            >>>     settings = await AsyncSystemSetting.get_system_settings(async_client)
             or  
             >>>     settings = await async_client.get_system_settings()
             >>>     sync_settings = settings.to_sync(client)