Merge pull request #12 from robert-nogueira/main

Refactor and Improve Type Hints, Clean Up Code, and Remove requests Attribute from StatusData

Author: JoaoOtavioS

.safety-project.ini

@@ -0,0 +1,4 @@
+[project]
+id = sdk-api-py
+url = /projects/dfc17c5f-6abc-4165-8c26-32954be241e9/findings
+name = sdk-api-py

examples/app_cache/accessing_application_cache.py

@@ -1,9 +1,11 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client('API_KEY')
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
 
     # See that since no request was made, the cache is empty
@@ -20,3 +22,6 @@ async def example():
     print(app.cache.status)  # StatusData(...)
     print(app.cache.logs)  # LogsData(...)
     print(app.cache.backup)  # BackupData(...)
+
+
+asyncio.run(example())

examples/app_cache/avoid_update_cache.py

@@ -1,9 +1,11 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client('API_KEY')
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
 
     # below we are setting "update_cache" to False,
@@ -16,3 +18,6 @@ async def example():
     print(app.cache.status)  # None
     print(app.cache.logs)  # None
     print(app.cache.backup)  # None
+
+
+asyncio.run(example())

examples/app_cache/clear_cache.py

@@ -1,9 +1,11 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client('API_KEY')
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
 
     await app.status()
@@ -19,3 +21,6 @@ async def example():
     print(app.cache.status)  # None
     print(app.cache.logs)  # None
     print(app.cache.backup)  # None
+
+
+asyncio.run(example())

examples/app_cache/update_cache.py

@@ -1,9 +1,11 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client('API_KEY')
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
 
     status = await app.status()
@@ -17,3 +19,6 @@ async def example():
     print(app.cache.status)  # StatusData(...)
     print(app.cache.logs)  # LogsData(...)
     print(app.cache.backup)  # BackupData(...)
+
+
+asyncio.run(example())

examples/app_data/with_application.py

@@ -1,9 +1,14 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client(api_key='API KEY')
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
     backup = await app.backup()
     print(backup.downloadURL)  # https://squarecloud.app/dashboard/backup/f.zip
+
+
+asyncio.run(example())

examples/app_data/with_client.py

@@ -1,8 +1,13 @@
+import asyncio
+
 import squarecloud as square
 
 client = square.Client(api_key='API KEY')
 
 
-async def example():
+async def example() -> None:
     backup = await client.backup('application_id')
     print(backup.downloadURL)  # https://squarecloud.app/dashboard/backup/f.zip
+
+
+asyncio.run(example())

examples/backup/with_application.py

@@ -1,18 +1,23 @@
-import squarecloud
+import asyncio
+
 import squarecloud as square
 from squarecloud import Endpoint
 
 client = square.Client('API_KEY', debug=False)
 
 
-async def example():
+async def example() -> None:
     app = await client.app('application_id')
 
     @app.capture(endpoint=Endpoint.logs())
-    async def on_logs_request(before: squarecloud.E, after):
+    async def on_logs_request(
+        before: square.LogsData, after: square.LogsData
+    ) -> None:
         if after != before:
             print(f'New logs!!! {after}')
 
     await app.logs()  # True
-
     await app.logs()  # False
+
+
+asyncio.run(example())