Deprecate PostgrestClient.from_table()

Author: lqmanh

CHANGELOG.md

@@ -13,6 +13,7 @@
 #### Changed
 
 - Rename `Client` to `PostgrestClient` and deprecate the old name
+- Deprecate `PostgrestClient.from_table()`
 
 #### Removed
 

README.md

@@ -30,7 +30,7 @@ from postgrest_py import PostgrestClient
 
 async def main():
     async with PostgrestClient("http://localhost:3000") as client:
-        r = await client.from_table("countries").select("*")
+        r = await client.from_("countries").select("*")
         countries = r.json()
 
 asyncio.run(main())
@@ -39,7 +39,7 @@ asyncio.run(main())
 ### Create
 
 ```py
-await client.from_table("countries").insert({
+await client.from_("countries").insert({
     "name": "Việt Nam",
     "capital": "Hà Nội",
 })
@@ -48,7 +48,7 @@ await client.from_table("countries").insert({
 ### Read
 
 ```py
-r = await client.from_table("countries").select("id", "name")
+r = await client.from_("countries").select("id", "name")
 countries = r.json()
 ```
 

postgrest_py/client.py

@@ -39,13 +39,14 @@ def schema(self, schema: str):
         )
         return self
 
-    def from_table(self, table: str) -> RequestBuilder:
+    def from_(self, table: str) -> RequestBuilder:
         return RequestBuilder(self.session, f"/{table}")
 
-    def from_(self, table: str) -> RequestBuilder:
-        """Alias to Self.from_table()."""
+    @deprecated("0.2.0", "1.0.0", __version__, "Use PostgrestClient.from_() instead")
+    def from_table(self, table: str) -> RequestBuilder:
+        """Alias to Self.from_()."""
 
-        return self.from_table(table)
+        return self.from_(table)
 
     async def rpc(self, func: str, params: dict) -> Response:
         """Execute a stored procedure call."""