This commit is contained in:
2026-05-13 22:28:56 +03:30
parent 46fe62fa04
commit 45fee1dfd3
26 changed files with 2329 additions and 878 deletions
-74
View File
@@ -1,74 +0,0 @@
# Plant Names API
این API فقط لیست نام گیاه‌ها را به همراه آیکون و مراحل رشد برمی‌گرداند.
## Endpoint
- `GET /api/plants/names/`
## کاربرد
- گرفتن لیست سبک برای dropdown یا selector فرانت
- نمایش نام گیاه
- نمایش `icon`
- نمایش مراحل رشد هر گیاه
## رفتار API
- فقط فیلدهای `name`، `icon` و `growth_stages` را برمی‌گرداند
- اگر `growth_stage` برای یک گیاه خالی باشد، API به صورت خودکار این مراحل پیش‌فرض را اضافه و در دیتابیس ذخیره می‌کند:
- `initial`
- `vegetative`
- `flowering`
- `fruiting`
- `maturity`
- اگر `icon` خالی باشد، مقدار پیش‌فرض `leaf` ذخیره و برگردانده می‌شود
- اگر در `growth_profile.stage_thresholds` مرحله‌ای وجود داشته باشد، آن مرحله هم در خروجی `growth_stages` لحاظ می‌شود
## نمونه درخواست
```bash
curl -X GET http://localhost:8000/api/plants/names/
```
## نمونه پاسخ
```json
{
"code": 200,
"msg": "success",
"data": [
{
"name": "Tomato",
"icon": "leaf",
"growth_stages": [
"vegetative",
"flowering",
"fruiting"
]
},
{
"name": "Pepper",
"icon": "leaf",
"growth_stages": [
"initial",
"vegetative",
"flowering",
"fruiting",
"maturity"
]
}
]
}
```
## فیلدهای خروجی
- `name`: نام گیاه
- `icon`: آیکون گیاه برای فرانت
- `growth_stages`: آرایه‌ای از مراحل رشد گیاه
## نکته برای فرانت
- این endpoint برای لیست سبک طراحی شده و مناسب صفحه‌های انتخاب گیاه است
- اگر جزئیات کامل گیاه لازم دارید، از `GET /api/plants/` یا `GET /api/plants/{id}/` استفاده کنید
+7 -4
View File
@@ -85,24 +85,27 @@ class PlantConfig(AppConfig):
return self.growth_stage_aliases.get(normalized, value)
def resolve_plant_name(self, plant_name: str | None) -> str | None:
from .models import Plant
from farm_data.models import PlantCatalogSnapshot
value = (plant_name or "").strip()
if not value:
return value
plant = Plant.objects.filter(name=value).first() or Plant.objects.filter(name__iexact=value).first()
plant = (
PlantCatalogSnapshot.objects.filter(name=value).first()
or PlantCatalogSnapshot.objects.filter(name__iexact=value).first()
)
if plant is not None:
return plant.name
normalized = self._normalize_lookup_value(value)
alias_target = self.plant_aliases.get(normalized)
if alias_target:
aliased_plant = Plant.objects.filter(name=alias_target).first()
aliased_plant = PlantCatalogSnapshot.objects.filter(name=alias_target).first()
if aliased_plant is not None:
return aliased_plant.name
for plant in Plant.objects.only("name").iterator():
for plant in PlantCatalogSnapshot.objects.only("name").iterator():
if self._normalize_lookup_value(plant.name) == normalized:
return plant.name
-109
View File
@@ -1,109 +0,0 @@
"""
Management command to seed initial plant data.
Run: python manage.py seed_plants
"""
from django.core.management.base import BaseCommand
from plant.models import Plant
INITIAL_PLANTS = [
{
"name": "گوجه‌فرنگی",
"light": "آفتاب کامل (۶-۸ ساعت)",
"watering": "منظم، هفته‌ای ۲-۳ بار",
"soil": "لومی، غنی از مواد آلی، pH بین ۶-۶.۸",
"temperature": "۲۰-۳۰ درجه سانتی‌گراد",
"planting_season": "بهار",
"harvest_time": "۷۰-۹۰ روز پس از کاشت",
"spacing": "۴۵-۶۰ سانتی‌متر",
"fertilizer": "کود NPK متعادل، کمپوست",
},
{
"name": "خیار",
"light": "آفتاب کامل",
"watering": "روزانه در فصل گرم",
"soil": "لومی شنی، غنی از هوموس",
"temperature": "۱۸-۳۰ درجه سانتی‌گراد",
"planting_season": "بهار تا اوایل تابستان",
"harvest_time": "۵۰-۷۰ روز پس از کاشت",
"spacing": "۳۰-۴۵ سانتی‌متر",
"fertilizer": "کود ازته، کمپوست",
},
{
"name": "فلفل دلمه‌ای",
"light": "آفتاب کامل (۶-۸ ساعت)",
"watering": "منظم، هفته‌ای ۲-۳ بار",
"soil": "لومی، زهکشی مناسب",
"temperature": "۲۰-۳۰ درجه سانتی‌گراد",
"planting_season": "بهار",
"harvest_time": "۶۰-۹۰ روز پس از کاشت",
"spacing": "۴۰-۵۰ سانتی‌متر",
"fertilizer": "کود فسفره و پتاسه",
},
{
"name": "هویج",
"light": "آفتاب کامل تا نیمه‌سایه",
"watering": "منظم، خاک مرطوب",
"soil": "شنی لومی، عمیق، بدون سنگ",
"temperature": "۱۵-۲۵ درجه سانتی‌گراد",
"planting_season": "اوایل بهار یا پاییز",
"harvest_time": "۷۰-۸۰ روز پس از کاشت",
"spacing": "۵-۸ سانتی‌متر",
"fertilizer": "کود پتاسه، کمپوست پوسیده",
},
{
"name": "کاهو",
"light": "نیمه‌سایه تا آفتاب کامل",
"watering": "منظم، خاک مرطوب",
"soil": "لومی، غنی از مواد آلی",
"temperature": "۱۰-۲۰ درجه سانتی‌گراد",
"planting_season": "بهار و پاییز",
"harvest_time": "۴۵-۶۰ روز پس از کاشت",
"spacing": "۲۰-۳۰ سانتی‌متر",
"fertilizer": "کود ازته، کمپوست",
},
{
"name": "سیب‌زمینی",
"light": "آفتاب کامل",
"watering": "منظم، هفته‌ای ۲ بار",
"soil": "لومی شنی، اسیدی ملایم، pH بین ۵-۶",
"temperature": "۱۵-۲۲ درجه سانتی‌گراد",
"planting_season": "اواخر زمستان تا اوایل بهار",
"harvest_time": "۹۰-۱۲۰ روز پس از کاشت",
"spacing": "۳۰-۴۰ سانتی‌متر",
"fertilizer": "کود NPK، کمپوست",
},
{
"name": "پیاز",
"light": "آفتاب کامل",
"watering": "منظم، خاک مرطوب ولی نه غرقابی",
"soil": "لومی، زهکشی خوب",
"temperature": "۱۲-۲۴ درجه سانتی‌گراد",
"planting_season": "پاییز یا اوایل بهار",
"harvest_time": "۹۰-۱۵۰ روز پس از کاشت",
"spacing": "۱۰-۱۵ سانتی‌متر",
"fertilizer": "کود فسفره، سولفات پتاسیم",
},
]
class Command(BaseCommand):
help = "Seed initial plant data (7 common vegetables)"
def handle(self, *args, **options):
created_count = 0
for plant_data in INITIAL_PLANTS:
_, created = Plant.objects.get_or_create(
name=plant_data["name"],
defaults=plant_data,
)
if created:
created_count += 1
self.stdout.write(
self.style.SUCCESS(f" Created: {plant_data['name']}")
)
self.stdout.write(
self.style.SUCCESS(f"\nDone. Created {created_count} new plants.")
)
-64
View File
@@ -1,64 +0,0 @@
from rest_framework import serializers
from .models import Plant
DEFAULT_PLANT_GROWTH_STAGES = [
"initial",
"vegetative",
"flowering",
"fruiting",
"maturity",
]
def normalize_growth_stage_values(plant: Plant) -> list[str]:
stages: list[str] = []
raw_stage = (plant.growth_stage or "").replace("،", ",")
for part in raw_stage.split(","):
value = part.strip()
if value and value not in stages:
stages.append(value)
stage_thresholds = plant.growth_profile.get("stage_thresholds", {})
if isinstance(stage_thresholds, dict):
for stage_name in stage_thresholds.keys():
value = str(stage_name).strip()
if value and value not in stages:
stages.append(value)
if not stages:
stages = list(DEFAULT_PLANT_GROWTH_STAGES)
return stages
class PlantSerializer(serializers.ModelSerializer):
"""سریالایزر خروجی / ورودی برای Plant."""
class Meta:
model = Plant
fields = [
"id",
"name",
"icon",
"light",
"watering",
"soil",
"temperature",
"growth_stage",
"planting_season",
"harvest_time",
"spacing",
"fertilizer",
"created_at",
"updated_at",
]
read_only_fields = ["id", "created_at", "updated_at"]
class PlantNameStageSerializer(serializers.Serializer):
name = serializers.CharField()
icon = serializers.CharField()
growth_stages = serializers.ListField(child=serializers.CharField())
-34
View File
@@ -1,34 +0,0 @@
"""
سرویس‌های گیاه — دریافت مشخصات گیاه از API خارجی بر اساس نام.
"""
import logging
logger = logging.getLogger(__name__)
def fetch_plant_info_from_api(plant_name: str) -> dict | None:
"""
اتصال به API خارجی و دریافت مشخصات گیاه بر اساس نام.
TODO: پیاده‌سازی اتصال واقعی به API.
در حال حاضر این تابع خالی است و None برمی‌گرداند.
پارامترها:
plant_name: نام گیاه
خروجی مورد انتظار (وقتی پیاده‌سازی شود):
{
"name": "گوجه‌فرنگی",
"light": "آفتاب کامل",
"watering": "منظم، هفته‌ای ۲-۳ بار",
"soil": "لومی، غنی از مواد آلی",
"temperature": "۲۰-۳۰ درجه سانتی‌گراد",
"planting_season": "بهار",
"harvest_time": "۷۰-۹۰ روز پس از کاشت",
"spacing": "۴۵-۶۰ سانتی‌متر",
"fertilizer": "کود NPK متعادل",
}
"""
# TODO: اتصال واقعی به API
return None
-15
View File
@@ -1,15 +0,0 @@
from django.urls import path
from .views import (
PlantDetailView,
PlantFetchInfoView,
PlantListCreateView,
PlantNameStageListView,
)
urlpatterns = [
path("", PlantListCreateView.as_view(), name="plant-list-create"),
path("names/", PlantNameStageListView.as_view(), name="plant-name-stage-list"),
path("<int:pk>/", PlantDetailView.as_view(), name="plant-detail"),
path("fetch-info/", PlantFetchInfoView.as_view(), name="plant-fetch-info"),
]
-364
View File
@@ -1,364 +0,0 @@
from drf_spectacular.utils import (
OpenApiExample,
OpenApiResponse,
extend_schema,
inline_serializer,
)
from rest_framework import serializers as drf_serializers
from rest_framework import status
from rest_framework.response import Response
from rest_framework.views import APIView
from config.openapi import build_envelope_serializer, build_response
from .models import Plant
from .serializers import (
PlantNameStageSerializer,
PlantSerializer,
normalize_growth_stage_values,
)
from .services import fetch_plant_info_from_api
PlantListResponseSerializer = build_envelope_serializer(
"PlantListResponseSerializer",
PlantSerializer,
many=True,
)
PlantDetailResponseSerializer = build_envelope_serializer(
"PlantDetailResponseSerializer",
PlantSerializer,
)
PlantValidationErrorSerializer = build_envelope_serializer(
"PlantValidationErrorSerializer",
data_required=False,
allow_null=True,
)
PlantFetchInfoResponseSerializer = build_envelope_serializer(
"PlantFetchInfoResponseSerializer",
PlantSerializer,
)
PlantNameStageListResponseSerializer = build_envelope_serializer(
"PlantNameStageListResponseSerializer",
PlantNameStageSerializer,
many=True,
)
class PlantListCreateView(APIView):
"""لیست تمام گیاهان و ایجاد گیاه جدید."""
@extend_schema(
tags=["Plant"],
summary="لیست گیاهان",
description="لیست تمام گیاهان ذخیره‌شده را برمی‌گرداند.",
responses={
200: build_response(
PlantListResponseSerializer,
"لیست گیاهان ذخیره‌شده.",
),
},
)
def get(self, request):
plants = Plant.objects.all()
serializer = PlantSerializer(plants, many=True)
return Response(
{"code": 200, "msg": "success", "data": serializer.data},
status=status.HTTP_200_OK,
)
@extend_schema(
tags=["Plant"],
summary="ایجاد گیاه جدید",
description="یک گیاه جدید با مشخصات داده‌شده ایجاد می‌کند.",
request=PlantSerializer,
responses={
201: build_response(
PlantDetailResponseSerializer,
"گیاه جدید با موفقیت ایجاد شد.",
),
400: build_response(
PlantValidationErrorSerializer,
"داده ورودی نامعتبر است.",
),
},
examples=[
OpenApiExample(
"نمونه درخواست",
value={
"name": "گوجه‌فرنگی",
"light": "آفتاب کامل",
"watering": "منظم، هفته‌ای ۲-۳ بار",
"soil": "لومی، غنی از مواد آلی",
"temperature": "۲۰-۳۰ درجه سانتی‌گراد",
"growth_stage": "رشد رویشی",
"planting_season": "بهار",
"harvest_time": "۷۰-۹۰ روز پس از کاشت",
"spacing": "۴۵-۶۰ سانتی‌متر",
"fertilizer": "کود NPK متعادل",
},
request_only=True,
),
],
)
def post(self, request):
serializer = PlantSerializer(data=request.data)
if not serializer.is_valid():
return Response(
{"code": 400, "msg": "داده نامعتبر.", "data": serializer.errors},
status=status.HTTP_400_BAD_REQUEST,
)
serializer.save()
return Response(
{"code": 201, "msg": "success", "data": serializer.data},
status=status.HTTP_201_CREATED,
)
class PlantNameStageListView(APIView):
"""لیست سبک از نام گیاه، آیکون و مراحل رشد."""
@extend_schema(
tags=["Plant"],
summary="لیست نام گیاهان با مراحل رشد",
description=(
"فقط نام گیاه، آیکون و مراحل رشد را برمی‌گرداند. "
"اگر برای گیاهی مرحله رشد ثبت نشده باشد، مراحل پیش‌فرض به آن اضافه و ذخیره می‌شود."
),
responses={
200: build_response(
PlantNameStageListResponseSerializer,
"لیست نام گیاهان به همراه مراحل رشد و آیکون.",
),
},
)
def get(self, request):
payload = []
for plant in Plant.objects.all():
growth_stages = normalize_growth_stage_values(plant)
serialized_stages = ", ".join(growth_stages)
update_fields: list[str] = []
if plant.growth_stage != serialized_stages:
plant.growth_stage = serialized_stages
update_fields.append("growth_stage")
if not plant.icon:
plant.icon = "leaf"
update_fields.append("icon")
if update_fields:
update_fields.append("updated_at")
plant.save(update_fields=update_fields)
payload.append(
{
"name": plant.name,
"icon": plant.icon,
"growth_stages": growth_stages,
}
)
serializer = PlantNameStageSerializer(payload, many=True)
return Response(
{"code": 200, "msg": "success", "data": serializer.data},
status=status.HTTP_200_OK,
)
class PlantDetailView(APIView):
"""دریافت، ویرایش و حذف یک گیاه."""
def _get_plant(self, pk):
return Plant.objects.filter(pk=pk).first()
@extend_schema(
tags=["Plant"],
summary="جزئیات گیاه",
description="مشخصات یک گیاه را بر اساس شناسه برمی‌گرداند.",
responses={
200: build_response(
PlantDetailResponseSerializer,
"جزئیات گیاه.",
),
404: build_response(
PlantValidationErrorSerializer,
"گیاه یافت نشد.",
),
},
)
def get(self, request, pk):
plant = self._get_plant(pk)
if not plant:
return Response(
{"code": 404, "msg": "گیاه یافت نشد.", "data": None},
status=status.HTTP_404_NOT_FOUND,
)
serializer = PlantSerializer(plant)
return Response(
{"code": 200, "msg": "success", "data": serializer.data},
status=status.HTTP_200_OK,
)
@extend_schema(
tags=["Plant"],
summary="ویرایش کامل گیاه",
description="تمام فیلدهای یک گیاه را آپدیت می‌کند.",
request=PlantSerializer,
responses={
200: build_response(
PlantDetailResponseSerializer,
"گیاه با موفقیت به‌روزرسانی شد.",
),
400: build_response(
PlantValidationErrorSerializer,
"داده ورودی نامعتبر است.",
),
404: build_response(
PlantValidationErrorSerializer,
"گیاه یافت نشد.",
),
},
)
def put(self, request, pk):
plant = self._get_plant(pk)
if not plant:
return Response(
{"code": 404, "msg": "گیاه یافت نشد.", "data": None},
status=status.HTTP_404_NOT_FOUND,
)
serializer = PlantSerializer(plant, data=request.data)
if not serializer.is_valid():
return Response(
{"code": 400, "msg": "داده نامعتبر.", "data": serializer.errors},
status=status.HTTP_400_BAD_REQUEST,
)
serializer.save()
return Response(
{"code": 200, "msg": "success", "data": serializer.data},
status=status.HTTP_200_OK,
)
@extend_schema(
tags=["Plant"],
summary="ویرایش جزئی گیاه",
description="فقط فیلدهای ارسال‌شده آپدیت می‌شوند.",
request=PlantSerializer,
responses={
200: build_response(
PlantDetailResponseSerializer,
"گیاه با موفقیت به‌روزرسانی شد.",
),
400: build_response(
PlantValidationErrorSerializer,
"داده ورودی نامعتبر است.",
),
404: build_response(
PlantValidationErrorSerializer,
"گیاه یافت نشد.",
),
},
)
def patch(self, request, pk):
plant = self._get_plant(pk)
if not plant:
return Response(
{"code": 404, "msg": "گیاه یافت نشد.", "data": None},
status=status.HTTP_404_NOT_FOUND,
)
serializer = PlantSerializer(plant, data=request.data, partial=True)
if not serializer.is_valid():
return Response(
{"code": 400, "msg": "داده نامعتبر.", "data": serializer.errors},
status=status.HTTP_400_BAD_REQUEST,
)
serializer.save()
return Response(
{"code": 200, "msg": "success", "data": serializer.data},
status=status.HTTP_200_OK,
)
@extend_schema(
tags=["Plant"],
summary="حذف گیاه",
description="یک گیاه را حذف می‌کند.",
responses={
200: build_response(
PlantValidationErrorSerializer,
"گیاه با موفقیت حذف شد.",
),
404: build_response(
PlantValidationErrorSerializer,
"گیاه یافت نشد.",
),
},
)
def delete(self, request, pk):
plant = self._get_plant(pk)
if not plant:
return Response(
{"code": 404, "msg": "گیاه یافت نشد.", "data": None},
status=status.HTTP_404_NOT_FOUND,
)
plant.delete()
return Response(
{"code": 200, "msg": "گیاه با موفقیت حذف شد.", "data": None},
status=status.HTTP_200_OK,
)
class PlantFetchInfoView(APIView):
"""دریافت مشخصات گیاه از API خارجی بر اساس نام."""
@extend_schema(
tags=["Plant"],
summary="دریافت مشخصات گیاه از API خارجی",
description="بر اساس نام گیاه، مشخصات آن را از API خارجی دریافت می‌کند. (فعلاً خالی)",
request=inline_serializer(
name="PlantFetchInfoRequest",
fields={
"name": drf_serializers.CharField(help_text="نام گیاه"),
},
),
responses={
200: build_response(
PlantFetchInfoResponseSerializer,
"اطلاعات گیاه از سرویس خارجی دریافت شد.",
),
400: build_response(
PlantValidationErrorSerializer,
"نام گیاه ارسال نشده است.",
),
503: build_response(
PlantValidationErrorSerializer,
"سرویس خارجی در دسترس نیست.",
),
},
examples=[
OpenApiExample(
"نمونه درخواست",
value={"name": "گوجه‌فرنگی"},
request_only=True,
),
],
)
def post(self, request):
plant_name = request.data.get("name")
if not plant_name:
return Response(
{"code": 400, "msg": "نام گیاه الزامی است.", "data": None},
status=status.HTTP_400_BAD_REQUEST,
)
result = fetch_plant_info_from_api(plant_name)
if result is None:
return Response(
{
"code": 503,
"msg": "سرویس API هنوز پیاده‌سازی نشده است.",
"data": None,
},
status=status.HTTP_503_SERVICE_UNAVAILABLE,
)
return Response(
{"code": 200, "msg": "success", "data": result},
status=status.HTTP_200_OK,
)