-
Notifications
You must be signed in to change notification settings - Fork 7
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
feat(api): use geojson-pydantic
as request model
#824
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,13 @@ | ||
import json | ||
from typing import Dict | ||
|
||
import geojson | ||
from geojson import FeatureCollection | ||
from geojson_pydantic import Feature, FeatureCollection, MultiPolygon, Polygon | ||
from pydantic import BaseModel, ConfigDict, Field, field_validator | ||
|
||
from ohsome_quality_api.attributes.definitions import AttributeEnum | ||
from ohsome_quality_api.topics.definitions import TopicEnum | ||
from ohsome_quality_api.topics.models import TopicData | ||
from ohsome_quality_api.utils.helper import snake_to_lower_camel | ||
from ohsome_quality_api.utils.validators import validate_geojson | ||
|
||
|
||
class BaseConfig(BaseModel): | ||
|
@@ -20,8 +19,11 @@ class BaseConfig(BaseModel): | |
) | ||
|
||
|
||
FeatureCollection_ = FeatureCollection[Feature[Polygon | MultiPolygon, Dict]] | ||
|
||
|
||
class BaseBpolys(BaseConfig): | ||
bpolys: dict = Field( | ||
bpolys: FeatureCollection_ = Field( | ||
{ | ||
"type": "FeatureCollection", | ||
"features": [ | ||
|
@@ -46,12 +48,11 @@ class BaseBpolys(BaseConfig): | |
|
||
@field_validator("bpolys") | ||
@classmethod | ||
def validate_bpolys(cls, value) -> FeatureCollection: | ||
obj = geojson.loads(json.dumps(value)) | ||
if not isinstance(obj, FeatureCollection): | ||
raise ValueError("must be of type FeatureCollection") | ||
validate_geojson(obj) # Check if exceptions are raised | ||
return obj | ||
def transform(cls, value) -> geojson.FeatureCollection: | ||
# NOTE: `geojson_pydantic` library is used only for validation and openAPI-spec | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good explanation ;) |
||
# generation. To avoid refactoring all code the FeatureCollection object of | ||
# the `geojson` library is still used every else. | ||
return geojson.loads(value.model_dump_json()) | ||
|
||
|
||
class IndicatorRequest(BaseBpolys): | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume the underscore postfix is for avoiding name collisions?