Add statements Data #171
Merged
Add statements Data #171
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR removes support for older Python versions, upgrades dependencies and CI tooling, refactors client code with modern type hints and style, and introduces a new StatementClient (with related constants, models and tests) while adjusting the ASX market client and dozens of VCR cassettes to align with revamped endpoints and response formats. ER diagram for new NYSEUrl.statement endpointerDiagram
NYSEUrl ||--o{ StatementClient : uses
StatementClient ||--o{ Statement : fetches
Statement {
date date
quarter int
year int
}
NYSEUrl {
statement str
}
Class diagram for the new StatementClient and related modelsclassDiagram
class StatementClient {
+async list(request: StatementRequest) List[Statement]
}
class StatementRequest {
+str symbol
+date start_date
}
class Data {
+str data_code
+float value
}
class StatementData {
+List[Data] balance_sheet
+List[Data] income_statement
+List[Data] cash_flow
+List[Data] overview
}
class Statement {
+date date
+int quarter
+int year
+StatementData statement_data
}
StatementClient --|> BaseClient
StatementClient ..> StatementRequest
StatementClient ..> Statement
StatementData o-- Data
Statement o-- StatementData
Class diagram for StakeClient with StatementClient integrationclassDiagram
class StakeClient {
+equities
+fundings
+market
+orders
+products
+ratings
+trades
+transactions
+statements
+set_exchange(exchange)
+async get(url, payload)
+async post(url, payload)
+async delete(url, payload)
}
class StatementClient
StakeClient --> StatementClient : statements
Class diagram for updated ASX MarketClient and Status modelsclassDiagram
class MarketClient {
+async get() MarketStatus
+async is_open() bool
}
class MarketStatus {
+Optional[datetime] last_trading_date
+Status status
}
class Status {
+str current
}
MarketClient --|> BaseClient
MarketClient ..> MarketStatus
MarketStatus o-- Status
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @stabacco - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `stake/asx/market.py:27` </location>
<code_context>
async def get(self) -> MarketStatus:
data = await self._client.get(self._client.exchange.market_status)
- return MarketStatus(**data)
+ return MarketStatus(
+ last_trading_date=data[0]["lastTradedTimestamp"],
+ status=Status(current=data[0]["marketStatus"]),
</code_context>
<issue_to_address>
Directly indexing data[0] assumes a non-empty list response.
This could raise an IndexError if the list is empty. Please add a check to handle empty responses.
</issue_to_address>
### Comment 2
<location> `stake/statement.py:40` </location>
<code_context>
+ model_config = pydantic.ConfigDict(alias_generator=camelcase, populate_by_name=True)
+
+
+class StatementClient(BaseClient):
+ """This client is in charge listing the experts' statements for symbols."""
+
+ async def list(self, request: StatementRequest) -> List[Statement]:
+ """Lists all the statements for the symbols specified in the request.
+
+ Returns:
+ List[Statement]: The list of statements.
+ """
+ data = await self._client.get(
+ self._client.exchange.statement.format(
+ symbol=request.symbol,
+ date=request.start_date,
+ )
+ )
+
+ if data == {"message": "No data returned"}:
+ return []
+ return [Statement(**d) for d in data]
</code_context>
<issue_to_address>
No error handling for unexpected API response structure in StatementClient.list.
Catch pydantic ValidationError when parsing the API response to handle unexpected structures and provide clearer error messages or fallback behavior.
Suggested implementation:
```python
from pydantic import ValidationError
class Statement(pydantic.BaseModel):
date: date
quarter: int
year: int
statement_data: StatementData
model_config = pydantic.ConfigDict(alias_generator=camelcase, populate_by_name=True)
```
```python
if data == {"message": "No data returned"}:
return []
try:
return [Statement(**d) for d in data]
except ValidationError as e:
# You can customize this behavior as needed (e.g., log, return [], etc.)
raise RuntimeError(f"Failed to parse statement data: {e}") from e
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| async def get(self) -> MarketStatus: | ||
| data = await self._client.get(self._client.exchange.market_status) | ||
| return MarketStatus(**data) | ||
| return MarketStatus( |
There was a problem hiding this comment.
issue (bug_risk): Directly indexing data[0] assumes a non-empty list response.
This could raise an IndexError if the list is empty. Please add a check to handle empty responses.
Comment on lines
+40
to
+49
| class StatementClient(BaseClient): | ||
| """This client is in charge listing the experts' statements for symbols.""" | ||
|
|
||
| async def list(self, request: StatementRequest) -> List[Statement]: | ||
| """Lists all the statements for the symbols specified in the request. | ||
| Returns: | ||
| List[Statement]: The list of statements. | ||
| """ | ||
| data = await self._client.get( |
There was a problem hiding this comment.
suggestion (bug_risk): No error handling for unexpected API response structure in StatementClient.list.
Catch pydantic ValidationError when parsing the API response to handle unexpected structures and provide clearer error messages or fallback behavior.
Suggested implementation:
from pydantic import ValidationError
class Statement(pydantic.BaseModel):
date: date
quarter: int
year: int
statement_data: StatementData
model_config = pydantic.ConfigDict(alias_generator=camelcase, populate_by_name=True) if data == {"message": "No data returned"}:
return []
try:
return [Statement(**d) for d in data]
except ValidationError as e:
# You can customize this behavior as needed (e.g., log, return [], etc.)
raise RuntimeError(f"Failed to parse statement data: {e}") from e| self.trades: Union[ | ||
| asx.trade.TradesClient, trade.TradesClient | ||
| ] = asx.trade.TradesClient(self) | ||
| self.equities: Union[asx.equity.EquitiesClient, equity.EquitiesClient] = ( |
There was a problem hiding this comment.
issue (code-quality): Extract code out into method [×2] (extract-method)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Add support for retrieving financial statements and modernize project to Python 3.10+
New Features:
Enhancements:
Build:
CI:
Deployment:
Tests: