Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add python stub file for type annotation hint on developing. #6

Merged
merged 1 commit into from
May 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 239 additions & 0 deletions nacos_sdk_rust_binding_py.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
from typing import Callable, Dict, List, NoReturn, Optional

class ClientOptions:
def __init__(
self,
server_addr: str,
namespace: str,
app_name: Optional[str],
username: Optional[str],
password: Optional[str],
naming_push_empty_protection: Optional[bool],
naming_load_cache_at_start: Optional[bool],
) -> None: ...

class NacosConfigResponse:
@property
def namespace(self) -> str: ...
@property
def data_id(self) -> str: ...
@property
def group(self) -> str: ...
@property
def content(self) -> str: ...
@property
def content_type(self) -> str: ...
@property
def md5(self) -> str: ...

class NacosConfigClient:
def __init__(self, client_options: ClientOptions) -> None: ...
def get_config(self, data_id: str, group: str) -> str:
"""Get config's content. If it fails, pay attention to err"""

...
def get_config_resp(self, data_id: str, group: str) -> NacosConfigResponse:
"""Get NacosConfigResponse. If it fails, pay attention to err"""

...
def publish_config(self, data_id: str, group: str, content: str) -> bool:
"""Publish config. If it fails, pay attention to err"""

...
def remove_config(self, data_id: str, group: str) -> bool:
"""Remove config. If it fails, pay attention to err"""

...
def add_listener(
self,
data_id: str,
group: str,
listener: Callable[[NacosConfigResponse], NoReturn],
):
"""Add NacosConfigChangeListener callback func, which listen the config change. If it fails, pay attention to err"""

...

class AsyncNacosConfigClient:
def __init__(self, client_options: ClientOptions) -> None: ...
async def get_config(self, data_id: str, group: str) -> str:
"""Get config's content. If it fails, pay attention to err"""

...
async def get_config_resp(self, data_id: str, group: str) -> NacosConfigResponse:
"""Get NacosConfigResponse. If it fails, pay attention to err"""

...
async def publish_config(self, data_id: str, group: str, content: str) -> bool:
"""Publish config. If it fails, pay attention to err"""

...
async def remove_config(self, data_id: str, group: str) -> bool:
"""Remove config. If it fails, pay attention to err"""

...
async def add_listener(
self,
data_id: str,
group: str,
listener: Callable[[NacosConfigResponse], NoReturn],
):
"""Add NacosConfigChangeListener callback func, which listen the config change. If it fails, pay attention to err"""

...

class NacosServiceInstance:
def __init__(
self,
ip: str,
port: int,
weight: Optional[float],
healthy: Optional[bool],
enabled: Optional[bool],
ephemeral: Optional[bool],
cluster_name: Optional[str],
service_name: Optional[str],
metadata: Optional[Dict[str, str]],
) -> None: ...

class NacosNamingClient:
def __init__(self, client_options: ClientOptions) -> None: ...
def register_instance(
self, service_name: str, group: str, service_instance: NacosServiceInstance
):
"""Register instance. If it fails, pay attention to err"""

...

def deregister_instance(
self, service_name: str, group: str, service_instance: NacosServiceInstance
):
"""Deregister instance. If it fails, pay attention to err"""

...

def batch_register_instance(
self,
service_name: str,
group: str,
service_instances: List[NacosServiceInstance],
):
"""Batch register instance, improve interaction efficiency. If it fails, pay attention to err"""

...

def get_all_instances(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
) -> List[NacosServiceInstance]:
"""Get all instances by service and group. default cluster=[], subscribe=true. If it fails, pay attention to err"""

...

def select_instances(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
healthy: Optional[bool],
) -> List[NacosServiceInstance]:
"""Select instances whether healthy or not. default cluster=[], subscribe=true, healthy=true. If it fails, pay attention to err"""

...

def select_one_healthy_instance(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
) -> NacosServiceInstance:
"""Select one healthy instance. default cluster=[], subscribe=true. If it fails, pay attention to err"""

...

def subscribe(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
listener: Callable[[NacosConfigResponse], NoReturn],
) -> NacosServiceInstance:
"""Add NacosNamingEventListener callback func, which listen the instance change. If it fails, pay attention to err"""

...

class AsyncNacosNamingClient:
def __init__(self, client_options: ClientOptions) -> None: ...
async def register_instance(
self, service_name: str, group: str, service_instance: NacosServiceInstance
):
"""Register instance. If it fails, pay attention to err"""

...

async def deregister_instance(
self, service_name: str, group: str, service_instance: NacosServiceInstance
):
"""Deregister instance. If it fails, pay attention to err"""

...

async def batch_register_instance(
self,
service_name: str,
group: str,
service_instances: List[NacosServiceInstance],
):
"""Batch register instance, improve interaction efficiency. If it fails, pay attention to err"""

...

async def get_all_instances(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
) -> List[NacosServiceInstance]:
"""Get all instances by service and group. default cluster=[], subscribe=true. If it fails, pay attention to err"""

...

async def select_instances(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
healthy: Optional[bool],
) -> List[NacosServiceInstance]:
"""Select instances whether healthy or not. default cluster=[], subscribe=true, healthy=true. If it fails, pay attention to err"""

...

async def select_one_healthy_instance(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
subscribe: Optional[bool],
) -> NacosServiceInstance:
"""Select one healthy instance. default cluster=[], subscribe=true. If it fails, pay attention to err"""

...

async def subscribe(
self,
service_name: str,
group: str,
clusters: Optional[List[str]],
listener: Callable[[NacosConfigResponse], NoReturn],
) -> NacosServiceInstance:
"""Add NacosNamingEventListener callback func, which listen the instance change. If it fails, pay attention to err"""

...
Loading