pycityagent 1.0.0__py3-none-any.whl → 2.0.0a2__py3-none-any.whl

pycityagent/brain/sence.py

@@ -1,375 +0,0 @@
-from typing import Optional, Union
-from datetime import datetime
-from pycitysim.apphub import UserMessage, AgentMessage
-from citystreetview import (
-    BaiduStreetView,
-    GoogleStreetView,
-    Equirectangular,
-    wgs842bd09mc,
-)
-from .brainfc import BrainFunction
-from .static import POI_TYPE_DICT, LEVEL_ONE_PRE
-
-class SencePlug:
-    """
-    感知模块插件
-    Plugin of Sence Module
-
-    Args:
-    - user_func (function): user defined function
-    - out (str): the output target in sence, the sence result will be insert to Sence.plug_buffer[out]
-    """
-    def __init__(self, user_func, out:str) -> None:
-        # TODO: 添加合法性检查
-        self.user_func = user_func
-        self.out = out
-
-class Sence(BrainFunction):
-    """
-    Agent感知模块
-    Agent Sence module
-    """
-    def __init__(self, agent, sence_raduis:int=10) -> None:
-        super().__init__(agent)
-        self._streetview_engine = ""
-        self._streetviewAK = ""
-        self._streetviewProxy = None
-        self._sence_radius = sence_raduis
-        """
-        感知半径
-        The sence raduis: meter
-        """
-        self.sence_buffer = {}
-        """
-        感知Buffer: 用于存储感知到的内容
-        Sence Buffer: used to stroe those senced content
-        """
-        self.plugs = []
-        """
-        感知插件集合
-        Collection of SencePlugs
-        """
-        self.plug_buffer = {}
-        """
-        感知插件结果Buffer: 用于存储感知插件的输出结果
-        SencePlug Buffer: used to store those sence plug content
-        """
-        self.enable_streeview = False
-        """
-        街景感知功能接口, 默认为False
-        Interface of streetview function, defualt: False
-        """
-
-    def add_plugs(self, plugs:list[SencePlug]):
-        """
-        添加感知插件
-        Add SencePlug
-
-        Args:
-        - plugs (list[SencePlug]): the list of SencePlug
-        """
-        self.plugs += plugs
-
-    def set_sence_radius(self, radius:int):
-        """
-        设置感知半径
-        Set sence radius
-
-        Args:
-        - radius (int): meter
-        """
-        self._sence_radius = radius
-
-    def state_influence(self):
-        """
-        状态-感知影响接口, 该函数会在感知前自动执行
-        State-Sence influence interface, this function will be automatically invoked
-        """
-        return super().state_influence()
-    
-    async def Sence(self) -> dict:
-        """
-        感知功能主体
-        Main function of sence
-
-        Returns:
-        - (dict): the sence content in dict format
-            - time (int): current time in second (from 00:00:00)
-            - pois ()
-        """
-        self.state_influence()
-        # * time
-        self.sence_buffer['time'] = self._agent._simulator.time
-
-        # * pois
-        self.sence_buffer['pois'] = self.PerceivePoi()
-
-        # * lanes
-        self.sence_buffer['lanes'] = self.PerceiveLane()
-        lane_ids = self.PerceiveLane(only_id=True)
-        self.sence_buffer['lane_ids'] = lane_ids
-
-        # * person
-        self.sence_buffer['persons'] = []
-        for lane_id in lane_ids:
-            self.sence_buffer['persons'] += await self.PerceivePersonInLanes([lane_id])
-        if 'aoi_position' in self._agent.motion['position'].keys():
-            # 说明agent在aoi中
-            persons_aoi = await self.PerceiveAoi(only_person=True)
-            self.sence_buffer['persons'] += persons_aoi
-
-        # * streetview
-        if self.enable_streeview:
-            self.sence_buffer['streetview'] = self.PerceiveStreetView()
-        else:
-            self.sence_buffer['streetview'] = None
-
-        # * user message
-        if self._agent.Hub != None:
-            self.sence_buffer['user_messages'] = self.PerceiveUserMessage()
-        else:
-            self.sence_buffer['user_messages'] = []
-
-        # * agent message
-        self.sence_buffer['social_messages'] = await self.PerceiveMessageFromPerson()
-
-        # * 插件感知
-        if len(self.plugs) > 0:
-            for plug in self.plugs:
-                out_key = plug.out
-                out = plug.user_func(self.sence_buffer)
-                self.plug_buffer[out_key] = out
-
-        return self.sence_buffer
-
-    # * AOI and POI Related
-    async def PerceiveAoi(self, only_person:bool=False):
-        """
-        感知Agent当前所在的AOI
-        Sence AOI where Agent currently in
-
-        Args:
-        - only_person (bool): whether only return persons in AOI, default: False
-
-        Returns:
-        - Union[https://cityproto.sim.fiblab.net/#city.map.v2.AoiState, list[https://cityproto.sim.fiblab.net/#city.person.v1.PersonMotion]]
-        """
-        resp = await self._agent._simulator._client.aoi_service.GetAoi({'aoi_ids': [self._agent.motion['position']['aoi_position']['aoi_id']]})
-        if only_person:
-            persons = resp['states'][0]['persons']
-            return persons
-        return resp['states'][0]
-
-    def PerceivePoi(self, radius:int=None, category:str=None):
-        """
-        POI感知
-        Sence POI
-
-        Args:
-        - radius: 感知范围, 默认使用统一感知半径. Sence raduis, default use basic radius
-        - category: 6位数字类型编码, 如果为None则获取所有类型POI. 6-digit coding which represents the poi type, if None, then sence all type of poi
-
-        Returns:
-        - List[Tuple[Any, float]]: poi列表, 每个元素为(poi, 距离). poi list, each element is (poi, distance).
-        """
-        radius_ = self._sence_radius
-        if radius != None:
-            radius_ = radius
-        if category != None:
-            category_prefix = category
-            resp = self._agent._simulator.map.query_pois(
-                center=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                radius=radius_,
-                category_prefix=category_prefix
-            )
-        else:
-            resp = []
-            for category_prefix in LEVEL_ONE_PRE:
-                resp += self._agent._simulator.map.query_pois(
-                    center=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                    radius=radius_,
-                    category_prefix=category_prefix
-                )
-        # * 从六位代码转变为具体类型
-        for poi in resp:
-            cate_str = poi[0]['category']
-            poi[0]['category'] = POI_TYPE_DICT[cate_str]
-        return resp
-
-    # * Lane Related
-    def PerceiveLane(self, radius:int=None, type:int=3, only_id:bool=False) -> Union[list, dict]:
-        """
-        Agent视角下的Lane感知
-        Lane Sence
-
-        Args:
-        - radius: 感知半径, 默认使用基础半径. Sence radius, default use basic radius
-        - type: 感知的道路类型. Sence type
-            - 3: 车道+人行道. drive lane + sidewalk
-            - 2: 人行道. sidewalk
-            - 1: 车道. drive lane
-        - only_with_person: 仅返回包含人的车道. only those lanes with persons/cars
-        - only_id: 仅返回laneid. only lane id
-
-        Returns:
-        - Union[list, dict]
-            - if only_id, return a list of lane id
-            - if sence type equal 2 or 1, return a List[Tuple[Any, float, float]]: lane列表, 每个元素为(lane, s, distance)
-            - if sence type equal 3, return a dict
-                - 'roadway': List[Tuple[Any, float, float]]: lane列表, 每个元素为(lane, s, distance)
-                - 'sidewalk': List[Tuple[Any, float, float]]: lane列表, 每个元素为(lane, s, distance)
-        """
-        radius_ = self._sence_radius
-        if radius != None:
-            radius_ = radius
-        if type == 3:
-            resp = {}
-            resp['roadway'] = self._agent._simulator.map.query_lane(
-                xy=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                radius=radius_,
-                lane_type=1
-            )
-            resp['sidewalk'] = resp = self._agent._simulator.map.query_lane(
-                xy=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                radius=radius_,
-                lane_type=2
-            )
-        elif type == 2:
-            resp = self._agent._simulator.map.query_lane(
-                xy=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                radius=radius_,
-                lane_type=2
-            )
-        else:
-            resp = self._agent._simulator.map.query_lane(
-                xy=(self._agent.motion['position']['xy_position']['x'], self._agent.motion['position']['xy_position']['y']),
-                radius=radius_,
-                lane_type=1
-            )
-        if only_id:
-            ids = []
-            for ele in resp:
-                ids.append(ele[0]['id'])
-            return ids
-        return resp
-    
-    # * StreetView Related
-    def PerceiveStreetView(
-            self, 
-            heading:str="front", 
-            save:bool=False, 
-            save_dir:str=None
-        ):
-        """
-        街景图像感知
-        Sence streetview
-
-        Args:
-        - engine: 需要使用的街景获取引擎. streetview engine, default: 'baidumap'
-        - heading (str): 朝向，默认正前方; 同时支持back, left, right. sence towards, defualt 'front', support ['front', 'back', 'left', 'right']
-        - save (bool): 是否存储. save or not
-        - save_dir (str): 存储文件夹. save directory
-
-        Returns:
-        - PIL.Image.Image
-        """
-        coords = [(self._agent.motion['position']['longlat_position']['longitude'], self._agent.motion['position']['longlat_position']['latitude'])]
-        """
-        模拟人眼视角
-        水平FOV: 160
-        垂直角暂时不支持
-        """
-        if heading == "front":
-            heading_direction = self._agent.motion['direction']
-        elif heading == "back":
-            heading_direction += 180
-        elif heading == "left":
-            heading_direction += -90
-        elif heading == "right":
-            heading_direction += 90
-        else:
-            print("Wrong HEADING, Use FRONT")
-        if self._streetview_engine == "baidumap":
-            points = wgs842bd09mc(coords, self._streetviewAK)
-            sv = BaiduStreetView.search(points[0][0], points[0][1])
-            eq = Equirectangular(sv)
-            persp = eq.get_perspective(120, heading_direction, 20, 256, 512)
-            if save:
-                date_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-                sv.panorama.save("{}/{}_{}_panorama.jpg".format(save_dir, self._agent.name, date_time))
-                persp.save("{}/{}_{}_persp.jpg".format(save_dir, self._agent.name, date_time))
-            return persp
-        elif self._streetview_engine == "googlemap":
-            sv = GoogleStreetView.search(
-                    points[0][0],
-                    points[0][1],
-                    proxies=self._streetviewProxy,
-                    cache_dir=save_dir
-                )
-            eq = Equirectangular(sv)
-            persp = eq.get_perspective(120, heading_direction, 20, 256, 512)
-            if save:
-                sv.panorama.save("{}/{}_{}_panorama.jpg".format(save_dir, self._agent.name, datetime.now().strftime("%Y-%m-%d %H:%M:%S")))
-                persp.save("{}/{}_{}_persp.jpg".format(save_dir, self._agent.name, datetime.now().strftime("%Y-%m-%d %H:%M:%S")))
-            return persp
-        else:
-            print("Error StreetView Engine")
-            return None
-    
-    # * Person Related
-    def PerceivePersonCircule(self, raduis=30):
-        """Person环形感知"""
-        print("Not Implemented")
-        pass
-
-    async def PerceivePersonInLanes(self, lane_ids:list[int], only_id:bool=False):
-        """
-        感知指定lane集合上的person
-        Sence persons in target lane collection
-
-        Args:
-        - lane_ids: 指定的lane id列表. list of lane id
-        - only_id: 仅需要对应person id即可 - 否则返回person motion. whether only need person_id, default: False
-
-        Returns:
-        - Union[list[int], list[https://cityproto.sim.fiblab.net/#city.person.v1.PersonMotion]]
-            - if only_id, return a list of person id
-            - if not only_id, return a list of PersonMotion
-        """
-        req = {'lane_ids': lane_ids, 'exclude_person': False}
-        resp = await self._agent._client.lane_service.GetLane(req)
-        persons = []
-        for lane in resp['states']:
-            if only_id:
-                if len(lane['persons']) > 0:
-                    for pson in lane['persons']:
-                        persons.append(pson['id'])
-            else:
-                if len(lane['persons']) > 0:
-                    persons += lane['persons']
-        return persons
-    
-    async def PerceiveMessageFromPerson(self):
-        """
-        接受对话消息
-        Receive Conve Message
-
-        Returns:
-        - list[Message https://cityproto.sim.fiblab.net/#city.social.v1.Message]
-        """
-        messages = await self._agent._client.social_service.Receive({'id': self._agent._id})
-        return messages['messages']
-    
-    def PerceiveUserMessage(self) -> list[UserMessage]:
-        """
-        从AppHub获取消息
-        Get user messages from AppHub
-
-        Returns:
-        - list[UserMessage]
-        """
-        return self._agent._hub_connector.GetMessageFromHub()
-    
-    @property
-    def Buffer(self):
-        return self.sence_buffer

pycityagent/cc/__init__.py

@@ -1,5 +0,0 @@
-'''Commond Control - 根据Brain组织的信息, 发起指令'''
-
-from .cc import *
-
-__all__ = [CommondController, Commond]

pycityagent/cc/cc.py

@@ -1,102 +0,0 @@
-from typing import Any
-from .idle import *
-from .shop import *
-from .trip import *
-from .conve import *
-from .user import *
-
-class Commond:
-    """
-    BrainCommond: 即脑部发出的指令; The commond from Agent's Brain
-
-    Args:
-    - target (str): 即指令目标(状态转移指令). The commond target(state transformer)
-    - user_func (func):
-        - 自定义函数, 返回结果为bool类型, 如果返回True, 则表示执行target指令. Self-defined function, the return type is bool, if this function returns 'True', then forward the target commond.
-    """
-    def __init__(self, target:str, user_func) -> None:
-        self.target = target
-        self.user_func = user_func
-
-class CommondController:
-    """
-    Commond控制器模组: 连接Brain以及StateTranformer
-    Commond Controller module: Used to connect the Brain module and StateTransformer module
-    """
-    def __init__(self, agent, config=None) -> None:
-        '''默认初始化'''
-        # TODO: config配置
-        self._agent = agent
-        self._brain = agent._brain
-        self.commond_control = {}
-        """
-        控制序列: 与state关联的BrainCommond集合
-        Control Hub: connect the state with a BrainCommond collection
-        Type: dict[str, list[BrainCommond]]
-        Default:
-            - idle: [whetherUserControl, whetherGoTrip, whetherGoShop, whetherGoConverse]
-            - trip: [whetherUserControl, whetherRouteFailed, whetherTripArrived]
-            - shop: [whetherUserControl, whetherShopFinished]
-            - conve: [whetherUserControl, whetherStopConverse]
-            - controled: [whetherEndControl]
-        """
-        if config != None:
-            pass
-        else:
-            self.commond_control['idle'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('gotrip', whetherGoTrip),
-                Commond('goshop', whetherGoShop),
-                Commond('goconverse', whetherGoConverse)
-            ]
-            self.commond_control['trip'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('routefailed', whetherRouteFailed),
-                Commond('arrived', whetherTripArrived)
-            ]
-            self.commond_control['shop'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('shopdone', whetherShopFinished)
-            ]
-            self.commond_control['conve'] = [
-                Commond('gousercontrol', whetherUserControl),
-                Commond('convedone', whetherStopConverse)
-            ]
-            self.commond_control['controled'] = [
-                Commond('controlback', whetherEndControl)
-            ]
-
-    def insertCommond(self, target_state:list[str], commond:Commond):
-        """
-        插入指令
-        Insert Commond: This function will insert the commond to those control sequences show in target_state
-
-        Args:
-        - target_state (list[str]): the list of state names
-        - commond (Comond): the commond to be inserted
-        """
-        for target in target_state:
-            if target in self.commond_control.keys():
-                self.commond_control.append(commond)
-            else:
-                self.commond_control[target] = [commond]
-
-    async def Run(self):
-        """
-        AC主执行函数
-        The main function of AC
-        Note: By now, AC do not support priority invoke. You can manipulate the sequnce of Commond to create fake priority
-
-        Basic Logic: 
-            - Based on the current state of Agent, AC invoke those functions in sequence
-            - If there is a 'True' of function, returns the target commond
-            - Else, return 'nothing' commond
-        """
-        if self._agent.state not in self.commond_control.keys():
-            print(f"No commond control line match with current state: {self._agent.state}")
-        control_line = self.commond_control[self._agent.state]  # 获取agent状态对应的控制链
-        for control in control_line:
-            result = await control.user_func(self._agent.Brain.Memory.Working)
-            if result:
-                return control.target
-        return 'nothing'

pycityagent/cc/conve.py

@@ -1,6 +0,0 @@
-async def whetherStopConverse(wk):
-    '''是否结束对话'''
-    reason = wk.Reason
-    if reason['endConve']:
-        return True
-    return False

pycityagent/cc/idle.py

@@ -1,20 +0,0 @@
-async def whetherGoTrip(wk):
-    '''判断是否可以开始出行'''
-    reason = wk.Reason
-    if reason['startTrip']:
-        return True
-    return False
-
-async def whetherGoShop(wk):
-    '''判断是否可以开始购物'''
-    reason = wk.Reason
-    if reason['startShop']:
-        return True
-    return False
-
-async def whetherGoConverse(wk):
-    '''判断是否开始对话'''
-    reason = wk.Reason
-    if reason['startConve']:
-        return True
-    return False

pycityagent/cc/shop.py

@@ -1,6 +0,0 @@
-async def whetherShopFinished(wk):
-    '''是否结束购物'''
-    reason = wk.Reason
-    if reason['endShop']:
-        return True
-    return False

pycityagent/cc/trip.py

@@ -1,13 +0,0 @@
-async def whetherTripArrived(wk):
-    '''是否到达目的地'''
-    reason = wk.Reason
-    if reason['tripArrived']:
-        return True
-    return False
-
-async def whetherRouteFailed(wk):
-    '''是否到达目的地'''
-    reason = wk.Reason
-    if reason['routeFailed']:
-        return True
-    return False

pycityagent/cc/user.py

@@ -1,13 +0,0 @@
-async def whetherUserControl(wk):
-    reason = wk.Reason
-    if reason['hasUserControl']:
-        return True
-    else:
-        return False
-    
-async def whetherEndControl(wk):
-    reason = wk.Reason
-    if reason['endUserControl']:
-        return True
-    else:
-        return False

pycityagent/hubconnector/__init__.py

@@ -1,3 +0,0 @@
-from .hubconnector import *
-
-__all__ = [HubConnector]

pycityagent/hubconnector/hubconnector.py

@@ -1,137 +0,0 @@
-from typing import Optional
-import geojson
-from pycitysim.apphub import AppHubClient, AgentMessage, UserMessage
-import PIL.Image as Image
-import traceback
-
-class HubConnector:
-    """
-    AppHub连接组件
-    AppHub connection module
-    """
-    def __init__(self, hub_url:str=None, app_id:int=None, app_secret:str=None, agent=None, profile_img:str=None) -> None:
-        if hub_url == None:
-            self._client = None
-        else:
-            self._client = AppHubClient(
-                            app_hub_url=hub_url,
-                            app_id=app_id,
-                            app_secret=app_secret
-                        )
-        if agent == None:
-            self._agent = None
-            self._agent_id = None
-        else:
-            self._agent = agent
-            try:
-                self._agent_id = self._client.bind_person(
-                    self._agent.base['id'], 
-                    self._agent.agent_name, 
-                    Image.open(profile_img)
-                )
-            except Exception as e:
-                traceback.print_exc()
-                print(e)
-                self._agent_id = 7
-        self.messageBuffer:list[AgentMessage] = []
-        """
-        用于存储历史前端交互信息
-        Used to store the history message in frontend
-        """
-
-    def ConnectToHub(self, hub_url:str, app_id:int, app_secret:str):
-        """
-        连接AppHub
-        Connect with AppHub
-
-        Args:
-        - hub_url (str): the url of AppHub
-        - app_id (int): the allocated app_id
-        - app_secret (str): the allocated app_secret
-        """
-        self._client = AppHubClient(
-            app_hub_url=hub_url,
-            app_id=app_id,
-            app_secret=app_secret
-        )
-
-    def BindAgent(self, agent, profile_img:str):
-        """
-        绑定Agent
-        Bind an Agent through AppHub
-
-        Args:
-        - agent (Agent): the Agent needs to be bind with
-        - profile_img (str) : the path of profile_img, which will be shown in frontend and dashboard
-        """
-        if self._client == None:
-            print("Not Connect To AppHub Yet")
-            return
-        self._agent = agent
-        self._agent_id = self._client.bind_person(
-            self._agent.base['id'], 
-            self._agent.agent_name, 
-            Image.open(profile_img)
-        )
-
-    def Update(self, messages:Optional[list[AgentMessage]]=None, streetview:Image=None, longlat:list[float]=None, pop:str=None):
-        """
-        交互更新
-        FrontEnd Related Update
-        Note: This function is used by the lib developer. Normally, the user has no need to use this function
-
-        Default Action: no message, no streetview, locate based on the Agent's position, Agent's name as pop
-
-        Args:
-        - messages (Optional[list[AgentMessage]]): 
-            - 需要传递到前端侧边栏的消息. Messsages that will be shown in the message bar in frontend
-            - 默认为None(即当前无需传递消息). Default: None(i.e. No new messages need to be shown in frontend)
-        - streetview (PIL.Image.Image): 
-            - 街景图片. Streetview Image
-            - 默认为None(即本次更新不展示街景). Default: None(i.e. No streetview in this update)
-        - longlat (list(float)): 
-            - 经纬度坐标, 用于前端定位, 默认为None(即根据Agent当前位置进行设置). The longitude and latitude, which helps locate the Agent, default: None(i.e. locate the Agent by the current position of agent)
-            - 只有在有特殊展示需求的情况下才设置该参数. Only when you have special display requirements, you will set the attribute
-        - pop (str):
-            - 气泡信息. The pop message
-            - 默认为None(即没有气泡信息). Default: None(i.e. No pop message)
-        """
-        if self._client == None:
-            print("AppHub: Not Bind Agent Yet")
-            return
-        else:
-            pop_ = self._agent.agent_name
-            if pop != None:
-                pop_ = self._agent.agent_name + ": " + pop
-            longlat_ = [self._agent.motion['position']['longlat_position']['longitude'], self._agent.motion['position']['longlat_position']['latitude']]
-            if longlat != None:
-                longlat_ = longlat
-            
-            self._client.update_agent_map(
-                agent_id = self._agent_id, 
-                lnglat = longlat_,
-                street_view=streetview,
-                popup=pop_
-            )
-            if messages != None:
-                self.messageBuffer += messages
-                self._client.update_agent_messages(
-                    agent_id=self._agent_id,
-                    messages=self.messageBuffer
-                )
-
-    def GetMessageFromHub(self) -> list[UserMessage]:
-        """
-        获取前端messages
-        Get User messages from AppHub
-
-        Returns:
-        - list[UserMessage]
-        """
-        resp = self._client.fetch_user_messages(self._agent_id)
-        if len(resp) > 0:
-            u2a = []
-            for re in resp:
-                u2a.append(AgentMessage(re.id, re.timestamp, re.content, None, None))
-            self.messageBuffer += u2a
-        return resp