[Improvement] Inconsistencies Between Python and Java APIs

[AndreVale69]

What would you like to be improved?

While working on issue #6577, I noticed (thanks to @yuqi1129, PR #6581) that there are some inconsistencies between APIs written on Python and Java. I think that this inconsistency can lead to confusion and errors.

I would like to suggest to adjust the signature functions written on Python. Here is an approximate list of incosisntecy that I found:

• On the gravitino client you can see the create_catalog method:
  

  gravitino/clients/client-python/gravitino/client/gravitino_client.py

  Lines 77 to 87 in 873c6af

  	def create_catalog(
  	self,
  	name: str,
  	catalog_type: Catalog.Type,
  	provider: str,
  	comment: str,
  	properties: Dict[str, str],
  	) -> Catalog:
  	return self.get_metalake().create_catalog(
  	name, catalog_type, provider, comment, properties
  	)

  
  

  gravitino/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoClient.java

  Lines 118 to 127 in 873c6af

  	@Override
  	public Catalog createCatalog(
  	String catalogName,
  	Catalog.Type type,
  	String provider,
  	String comment,
  	Map<String, String> properties)
  	throws NoSuchMetalakeException, CatalogAlreadyExistsException {
  	return getMetalake().createCatalog(catalogName, type, provider, comment, properties);
  	}

  
  Or the same with load_catalog:
  

  gravitino/clients/client-python/gravitino/client/gravitino_client.py

  Lines 74 to 75 in 873c6af

  	def load_catalog(self, name: str) -> Catalog:
  	return self.get_metalake().load_catalog(name)

  
  

  gravitino/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoClient.java

  Lines 113 to 116 in 873c6af

  	@Override
  	public Catalog loadCatalog(String catalogName) throws NoSuchCatalogException {
  	return getMetalake().loadCatalog(catalogName);
  	}

• On metalake you can see the same problem:
  

  gravitino/clients/client-python/gravitino/client/gravitino_metalake.py

  Lines 118 to 125 in 873c6af

  	def create_catalog(
  	self,
  	name: str,
  	catalog_type: Catalog.Type,
  	provider: str,
  	comment: str,
  	properties: Dict[str, str],
  	) -> Catalog:

  
  

  gravitino/clients/client-java/src/main/java/org/apache/gravitino/client/GravitinoMetalake.java

  Lines 215 to 222 in 873c6af

  	@Override
  	public Catalog createCatalog(
  	String catalogName,
  	Catalog.Type type,
  	String provider,
  	String comment,
  	Map<String, String> properties)
  	throws NoSuchMetalakeException, CatalogAlreadyExistsException {

I'm a new contributor to this repository (I only made a one-line commit), so if you have any suggestions, I'm ready to hear them!

How should we improve?

I suggest adapting the function signatures in the Python client to match those in the Java client. I think this will improve consistency and reduce potential bugs (for example, issue #6577 is born out of this inconsistency).

I would like to take up this issue and work on resolving it.

[AndreVale69]

If it is okay for you, I will work on this issue. Can you please assign me? Since it is not a short-term task.

Solving this issue will close #6577 (and this one), and close PR #6581 as unmerged.

I tagged you @justinmclean because I believe you're one of the moderators. I hope this isn't a problem, I'm a new contributor to this repo. Thanks for your help and time!