Merge pull request #60 from agentic-labs/identifiers

Add find_identifier method and related models to Lsproxy

Author: maks-ivanov

lsproxy/__init__.py

@@ -11,7 +11,7 @@
     GetReferencesRequest,
 )
 
-__version__ = "0.1.6"
+__version__ = "0.2.0"
 
 __all__ = [
     "Lsproxy",

lsproxy/client.py

@@ -15,6 +15,8 @@
     GetDefinitionRequest,
     GetReferencesRequest,
     Symbol,
+    FindIdentifierRequest,
+    IdentifierResponse,
 )
 
 from .auth import create_jwt
@@ -87,6 +89,25 @@ def find_references(self, request: GetReferencesRequest) -> ReferencesResponse:
         references = ReferencesResponse.model_validate_json(response.text)
         return references
 
+    def find_identifier(self, request: FindIdentifierRequest) -> IdentifierResponse:
+        """Find all occurrences of an identifier by name in a file.
+
+        Args:
+            request: The request containing the identifier name, file path, and optional position.
+                    If position is provided, returns exact match or closest matches.
+
+        Returns:
+            Response containing the found identifiers.
+        """
+        if not isinstance(request, FindIdentifierRequest):
+            raise TypeError(
+                f"Expected FindIdentifierRequest, got {type(request).__name__}. Please use FindIdentifierRequest model to construct the request."
+            )
+        response = self._request(
+            "POST", "/symbol/find-identifier", json=request.model_dump()
+        )
+        return IdentifierResponse.model_validate_json(response.text)
+
     def list_files(self) -> List[str]:
         """Get a list of all files in the workspace."""
         response = self._request("GET", "/workspace/list-files")
@@ -111,7 +132,7 @@ def initialize_with_modal(
         git_token: Optional[str] = None,
         sha: Optional[str] = None,
         timeout: Optional[int] = None,
-        version: str = "latest",
+        version: str = "0.3",
     ) -> "Lsproxy":
         """
         Initialize lsproxy by starting a Modal sandbox with the server and connecting to it.

lsproxy/models.py

@@ -151,12 +151,43 @@ def __hash__(self) -> int:
         return hash((self.kind, self.name, self.identifier_position, self.range))
 
 
+class Identifier(BaseModel):
+    """Representation of an identifier in code."""
+
+    name: str = Field(..., description="The name of the identifier.")
+    range: FileRange = Field(
+        ..., description="The range of the identifier in the file."
+    )
+
+
+class FindIdentifierRequest(BaseModel):
+    """Request to find all occurrences of an identifier by name in a file."""
+
+    name: str = Field(..., description="The name of the identifier to search for.")
+    path: str = Field(
+        ..., description="The path to the file to search for identifiers."
+    )
+    position: Optional[Position] = Field(
+        None,
+        description="The position hint to search for identifiers. If provided, returns exact match or closest matches.",
+    )
+
+
+class IdentifierResponse(BaseModel):
+    """Response containing found identifiers."""
+
+    identifiers: List[Identifier] = Field(..., description="List of found identifiers.")
+
+
 class DefinitionResponse(BaseModel):
     """Response containing definition locations of a symbol."""
 
     definitions: List[FilePosition] = Field(
         ..., description="List of definition locations for the symbol."
     )
+    selected_identifier: Optional[Identifier] = Field(
+        None, description='The identifier that was "clicked-on" to get the definition.'
+    )
     raw_response: Optional[Union[dict, list]] = Field(
         None,
         description=(
@@ -192,6 +223,9 @@ class ReferencesResponse(BaseModel):
     references: List[FilePosition] = Field(
         ..., description="List of reference locations for the symbol."
     )
+    selected_identifier: Optional[Identifier] = Field(
+        None, description='The identifier that was "clicked-on" to get the references.'
+    )
     context: Optional[List[CodeContext]] = Field(
         None, description="Source code contexts around the references."
     )

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lsproxy-sdk"
-version = "0.1.6"
+version = "0.2.0"
 description = "SDK for interacting with lsproxy container"
 readme = "README.md"
 requires-python = ">=3.10"