pycityagent 2.0.0a65__cp311-cp311-macosx_11_0_arm64.whl → 2.0.0a67__cp311-cp311-macosx_11_0_arm64.whl

pycityagent/environment/__init__.py

@@ -1,13 +1,10 @@
 """Environment"""
 
-from .sence.static import LEVEL_ONE_PRE, POI_TYPE_DICT
 from .sim import AoiService, PersonService
 from .simulator import Simulator
 
 __all__ = [
     "Simulator",
-    "POI_TYPE_DICT",
-    "LEVEL_ONE_PRE",
     "PersonService",
     "AoiService",
 ]

pycityagent/environment/sim/__init__.py

@@ -7,7 +7,6 @@ from .person_service import PersonService
 from .aoi_service import AoiService
 from .client import CityClient
 from .clock_service import ClockService
-from .economy_services import EconomyOrgService, EconomyPersonService
 from .lane_service import LaneService
 from .road_service import RoadService
 from .social_service import SocialService
@@ -22,8 +21,6 @@ __all__ = [
     "LaneService",
     "RoadService",
     "SocialService",
-    "EconomyPersonService",
-    "EconomyOrgService",
     "LightService",
     "ControlSimEnv",
 ]

pycityagent/environment/sim/aoi_service.py

@@ -27,10 +27,10 @@ class AoiService:
         获取AOI信息
         get AOI information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.GetAoiRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.GetAoiResponse
         """
         if type(req) != aoi_service.GetAoiRequest:

pycityagent/environment/sim/client.py

@@ -1,14 +1,12 @@
 import warnings
 import grpc
 
-from ..sidecar import OnlyClientSidecar
 from .clock_service import ClockService
 from .person_service import PersonService
 from .aoi_service import AoiService
 from .lane_service import LaneService
 from .road_service import RoadService
 from .social_service import SocialService
-from .economy_services import EconomyPersonService, EconomyOrgService
 from .light_service import LightService
 from .pause_service import PauseService
 from ..utils.grpc import create_aio_channel
@@ -30,9 +28,9 @@ class CityClient:
         secure: bool = False,
     ):
         """
-        Args:
-        - url (str): 模拟器server的地址。The address of the emulator server.
-        - secure (bool, optional): 是否使用安全连接. Defaults to False. Whether to use a secure connection. Defaults to False.
+        - **Args**:
+            - `url` (`str`): 模拟器server的地址。The address of the emulator server.
+            - `secure` (`bool`, `optional`): 是否使用安全连接. Defaults to False. Whether to use a secure connection. Defaults to False.
         """
         aio_channel = create_aio_channel(url, secure)
         self._clock_service = ClockService(aio_channel)
@@ -41,19 +39,9 @@ class CityClient:
         self._aoi_service = AoiService(aio_channel)
         self._road_service = RoadService(aio_channel)
         self._social_service = SocialService(aio_channel)
-        self._economy_person_service = EconomyPersonService(aio_channel)
-        self._economy_org_service = EconomyOrgService(aio_channel)
         self._light_service = LightService(aio_channel)
         self._pause_service = PauseService(aio_channel)
 
-    @staticmethod
-    def from_sidecar(sidecar: OnlyClientSidecar, name: str = NAME):
-        """
-        从sidecar中创建CityClient
-        Create CityClient from sidecar
-        """
-        return CityClient(sidecar.wait_url(name))
-
     @property
     def clock_service(self):
         """
@@ -110,22 +98,6 @@ class CityClient:
         """
         return self._social_service
 
-    @property
-    def economy_person_service(self):
-        """
-        模拟器经济服务（个人）子模块
-        Simulator economic service (personal) submodule
-        """
-        return self._economy_person_service
-
-    @property
-    def economy_org_service(self):
-        """
-        模拟器经济服务（组织）子模块
-        Simulator economic service (organizational) submodule
-        """
-        return self._economy_org_service
-
     @property
     def light_service(self):
         """

pycityagent/environment/sim/clock_service.py

@@ -29,10 +29,10 @@ class ClockService:
         获取当前的模拟时间请求
         Getting current simulation clock
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.readthedocs.io/en/latest/docs.html#nowrequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.readthedocs.io/en/latest/docs.html#nowresponse
         """
         if type(req) != clock_service.NowRequest:

pycityagent/environment/sim/lane_service.py

@@ -27,10 +27,10 @@ class LaneService:
         获取Lane的信息
         Get Lane's information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.GetLaneRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.GetLaneResponse
         """
         if type(req) != lane_service.GetLaneRequest:
@@ -47,10 +47,10 @@ class LaneService:
         设置Lane的最大速度（限速）
         Set the maximum speed of Lane (speed limit)
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.SetLaneMaxVRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.SetLaneMaxVResponse
         """
         if type(req) != lane_service.SetLaneMaxVRequest:
@@ -71,10 +71,10 @@ class LaneService:
         设置Lane的限制
         Set the restriction of Lane
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.SetLaneRestrictionRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.SetLaneRestrictionResponse
         """
         if type(req) != lane_service.SetLaneRestrictionRequest:
@@ -96,10 +96,10 @@ class LaneService:
         获取特定区域内的Lane的信息
         Get lane information in a specific region
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.GetLaneByLongLatBBoxRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.GetLaneByLongLatBBoxResponse
         """
         if type(req) != lane_service.GetLaneByLongLatBBoxRequest:

pycityagent/environment/sim/light_service.py

@@ -32,10 +32,10 @@ class LightService:
         获取路口的红绿灯信息
         Get traffic light information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.traffic.v1.GetTrafficLightRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.traffic.v1.GetTrafficLightResponse
         """
         if type(req) != light_service.GetTrafficLightRequest:
@@ -57,10 +57,10 @@ class LightService:
         设置路口的红绿灯信息
         Set traffic light information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightResponse
         """
         if type(req) != light_service.SetTrafficLightRequest:
@@ -82,10 +82,10 @@ class LightService:
         设置路口的红绿灯相位
         Set traffic light phase
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightPhaseRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightPhaseResponse
         """
         if type(req) != light_service.SetTrafficLightPhaseRequest:
@@ -107,10 +107,10 @@ class LightService:
         设置路口的红绿灯状态
         Set traffic light status
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightStatusRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.traffic.v1.SetTrafficLightStatusResponse
         """
         if type(req) != light_service.SetTrafficLightStatusRequest:

pycityagent/environment/sim/pause_service.py

@@ -1,8 +1,7 @@
 from collections.abc import Awaitable, Coroutine
-from typing import Any, Dict, Union, cast
+from typing import Any, Union, cast
 
 import grpc
-from google.protobuf.json_format import ParseDict
 from pycityproto.city.pause.v1 import pause_service_pb2 as pause_service
 from pycityproto.city.pause.v1 import pause_service_pb2_grpc as pause_grpc
 
@@ -22,15 +21,15 @@ class PauseService:
 
     async def pause(
         self,
-    ) -> Coroutine[Any, Any, Union[Dict[str, Any], pause_service.PauseResponse]]:
+    ) -> Awaitable[Union[dict[str, Any], pause_service.PauseResponse]]:
         """
         暂停模拟
         Pause the simulation
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.readthedocs.io/en/latest/docs.html#pauserequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.readthedocs.io/en/latest/docs.html#pauseresponse
         """
         req = pause_service.PauseRequest()
@@ -38,19 +37,19 @@ class PauseService:
             Awaitable[pause_service.PauseResponse],
             self._aio_stub.Pause(req),
         )
-        return
+        return res
     
     async def resume(
         self,
-    ) -> Coroutine[Any, Any, Union[Dict[str, Any], pause_service.ResumeResponse]]:
+    ) -> Awaitable[Union[dict[str, Any], pause_service.ResumeResponse]]:
         """
         恢复模拟
         Resume the simulation
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.readthedocs.io/en/latest/docs.html#resumerequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.readthedocs.io/en/latest/docs.html#resumeresponse
         """
         req = pause_service.ResumeRequest()
@@ -58,4 +57,4 @@ class PauseService:
             Awaitable[pause_service.ResumeResponse],
             self._aio_stub.Resume(req),
         )
-        return
+        return res

pycityagent/environment/sim/person_service.py

@@ -57,10 +57,10 @@ class PersonService:
         获取person信息
         Get person information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonResponse
         """
         if type(req) != person_service.GetPersonRequest:
@@ -79,10 +79,10 @@ class PersonService:
         新增person
         Add a new person
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.AddPersonRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.AddPersonResponse
         """
         if type(req) != person_service.AddPersonRequest:
@@ -101,10 +101,10 @@ class PersonService:
         修改person的schedule
         set person's schedule
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.SetScheduleRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.SetScheduleResponse
         """
         if type(req) != person_service.SetScheduleRequest:
@@ -124,10 +124,10 @@ class PersonService:
         获取多个person信息
         Get information of multiple persons
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonsRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonsResponse
         """
         if type(req) != person_service.GetPersonsRequest:
@@ -149,10 +149,10 @@ class PersonService:
         获取特定区域内的person
         Get persons in a specific region
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonByLongLatBBoxRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.GetPersonByLongLatBBoxResponse
         """
         if type(req) != person_service.GetPersonByLongLatBBoxRequest:
@@ -174,10 +174,10 @@ class PersonService:
         获取所有车辆
         Get all vehicles
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.GetAllVehiclesRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.GetAllVehiclesResponse
         """
         if type(req) != person_service.GetAllVehiclesRequest:
@@ -199,10 +199,10 @@ class PersonService:
         重置人的位置（将停止当前正在进行的出行，转为sleep状态）
         Reset person's position (stop the current trip and switch to sleep status)
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.ResetPersonPositionRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.ResetPersonPositionResponse
         """
         if type(req) != person_service.ResetPersonPositionRequest:
@@ -226,10 +226,10 @@ class PersonService:
         设置由外部控制行为的vehicle
         Set controlled vehicle ID
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.SetControlledVehicleIDsRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.SetControlledVehicleIDsResponse
         """
         if type(req) != person_service.SetControlledVehicleIDsRequest:
@@ -253,10 +253,10 @@ class PersonService:
         获取由外部控制行为的vehicle的环境信息
         Fetch controlled vehicle environment information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.FetchControlledVehicleEnvsRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.FetchControlledVehicleEnvsResponse
         """
         if type(req) != person_service.FetchControlledVehicleEnvsRequest:
@@ -280,10 +280,10 @@ class PersonService:
         设置由外部控制行为的vehicle的行为
         Set controlled vehicle actions
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.person.v2.SetControlledVehicleActionsRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.person.v2.SetControlledVehicleActionsResponse
         """
         if type(req) != person_service.SetControlledVehicleActionsRequest:

pycityagent/environment/sim/road_service.py

@@ -27,10 +27,10 @@ class RoadService:
         查询道路信息
         Query road information
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.map.v2.GetRoadRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.map.v2.GetRoadResponse
         """
         if type(req) != road_service.GetRoadRequest:

pycityagent/environment/sim/sim_env.py

@@ -3,7 +3,7 @@ import logging
 import os
 import time
 import warnings
-from subprocess import DEVNULL, Popen
+from subprocess import Popen
 from typing import Optional
 
 from pycitydata.map import Map
@@ -46,7 +46,6 @@ class ControlSimEnv:
         self,
         task_name: str,
         map_file: str,
-        # person_file,
         start_step: int,
         total_step: int,
         log_dir: str,
@@ -54,9 +53,15 @@ class ControlSimEnv:
         timeout: int = 5,
         sim_addr: Optional[str] = None,
     ):
+        """
+        A control environment for managing a pycityagent-sim process.
+
+        - **Description**:
+            - This class sets up and manages a simulation environment using the specified parameters.
+            - It can start a new simulation process or connect to an existing one.
+        """
         self._task_name = task_name
         self._map_file = map_file
-        # self._person_file = person_file
         self._start_step = start_step
         self._total_step = total_step
         self._log_dir = log_dir
@@ -80,8 +85,16 @@ class ControlSimEnv:
         sim_addr: Optional[str] = None,
     ):
         """
-        Args:
-        - sim_addr: str, pycityagent-sim的地址。如果为None，则启动一个新的pycityagent-sim
+        Reset the simulation environment by either starting a new simulation process or connecting to an existing one.
+
+        - **Args**:
+            - `sim_addr` (`Optional[str]`): Address of an existing simulation to connect to. If `None`, a new simulation is started.
+
+        - **Returns**:
+            - `str`: The address of the simulation server.
+
+        - **Raises**:
+            - `AssertionError`: If trying to start a new simulation when one is already running.
         """
         if sim_addr is None:
             # 启动pycityagent-sim
@@ -123,6 +136,9 @@ class ControlSimEnv:
         return sim_addr
 
     def close(self):
+        """
+        Terminate the simulation process if it's running.
+        """
         if self._sim_proc is not None:
             self._sim_proc.terminate()
             sim_code = self._sim_proc.wait()

pycityagent/environment/sim/social_service.py

@@ -27,10 +27,10 @@ class SocialService:
         发送消息
         Send message
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.social.v1.SendRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.social.v1.SendResponse
         """
         if type(req) != social_service.SendRequest:
@@ -45,10 +45,10 @@ class SocialService:
         接收消息
         Receive message
 
-        Args:
+        - **Args**:
         - req (dict): https://cityproto.sim.fiblab.net/#city.social.v1.ReceiveRequest
 
-        Returns:
+        - **Returns**:
         - https://cityproto.sim.fiblab.net/#city.social.v1.ReceiveResponse
         """
         if type(req) != social_service.ReceiveRequest: