Sofie Van Landeghem
11 months ago
committed by
GitHub
GitHub
959 changed files with 47479 additions and 25753 deletions
@ -1,9 +0,0 @@ |
|||||
FROM python:3.10 |
|
||||
|
|
||||
COPY ./requirements.txt /app/requirements.txt |
|
||||
|
|
||||
RUN pip install -r /app/requirements.txt |
|
||||
|
|
||||
COPY ./app /app |
|
||||
|
|
||||
CMD ["python", "/app/main.py"] |
|
||||
@ -1,13 +0,0 @@ |
|||||
name: Comment Docs Preview in PR |
|
||||
description: Comment with the docs URL preview in the PR |
|
||||
author: Sebastián Ramírez <tiangolo@gmail.com> |
|
||||
inputs: |
|
||||
token: |
|
||||
description: Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }} |
|
||||
required: true |
|
||||
deploy_url: |
|
||||
description: The deployment URL to comment in the PR |
|
||||
required: true |
|
||||
runs: |
|
||||
using: docker |
|
||||
image: Dockerfile |
|
||||
@ -1,69 +0,0 @@ |
|||||
import logging |
|
||||
import sys |
|
||||
from pathlib import Path |
|
||||
from typing import Union |
|
||||
|
|
||||
import httpx |
|
||||
from github import Github |
|
||||
from github.PullRequest import PullRequest |
|
||||
from pydantic import BaseModel, SecretStr, ValidationError |
|
||||
from pydantic_settings import BaseSettings |
|
||||
|
|
||||
github_api = "https://api.github.com" |
|
||||
|
|
||||
|
|
||||
class Settings(BaseSettings): |
|
||||
github_repository: str |
|
||||
github_event_path: Path |
|
||||
github_event_name: Union[str, None] = None |
|
||||
input_token: SecretStr |
|
||||
input_deploy_url: str |
|
||||
|
|
||||
|
|
||||
class PartialGithubEventHeadCommit(BaseModel): |
|
||||
id: str |
|
||||
|
|
||||
|
|
||||
class PartialGithubEventWorkflowRun(BaseModel): |
|
||||
head_commit: PartialGithubEventHeadCommit |
|
||||
|
|
||||
|
|
||||
class PartialGithubEvent(BaseModel): |
|
||||
workflow_run: PartialGithubEventWorkflowRun |
|
||||
|
|
||||
|
|
||||
if __name__ == "__main__": |
|
||||
logging.basicConfig(level=logging.INFO) |
|
||||
settings = Settings() |
|
||||
logging.info(f"Using config: {settings.json()}") |
|
||||
g = Github(settings.input_token.get_secret_value()) |
|
||||
repo = g.get_repo(settings.github_repository) |
|
||||
try: |
|
||||
event = PartialGithubEvent.parse_file(settings.github_event_path) |
|
||||
except ValidationError as e: |
|
||||
logging.error(f"Error parsing event file: {e.errors()}") |
|
||||
sys.exit(0) |
|
||||
use_pr: Union[PullRequest, None] = None |
|
||||
for pr in repo.get_pulls(): |
|
||||
if pr.head.sha == event.workflow_run.head_commit.id: |
|
||||
use_pr = pr |
|
||||
break |
|
||||
if not use_pr: |
|
||||
logging.error(f"No PR found for hash: {event.workflow_run.head_commit.id}") |
|
||||
sys.exit(0) |
|
||||
github_headers = { |
|
||||
"Authorization": f"token {settings.input_token.get_secret_value()}" |
|
||||
} |
|
||||
url = f"{github_api}/repos/{settings.github_repository}/issues/{use_pr.number}/comments" |
|
||||
logging.info(f"Using comments URL: {url}") |
|
||||
response = httpx.post( |
|
||||
url, |
|
||||
headers=github_headers, |
|
||||
json={ |
|
||||
"body": f"📝 Docs preview for commit {use_pr.head.sha} at: {settings.input_deploy_url}" |
|
||||
}, |
|
||||
) |
|
||||
if not (200 <= response.status_code <= 300): |
|
||||
logging.error(f"Error posting comment: {response.text}") |
|
||||
sys.exit(1) |
|
||||
logging.info("Finished") |
|
||||
@ -0,0 +1,34 @@ |
|||||
|
docs: |
||||
|
- all: |
||||
|
- changed-files: |
||||
|
- any-glob-to-any-file: |
||||
|
- docs/en/docs/** |
||||
|
- docs_src/** |
||||
|
- all-globs-to-all-files: |
||||
|
- '!fastapi/**' |
||||
|
- '!pyproject.toml' |
||||
|
|
||||
|
lang-all: |
||||
|
- all: |
||||
|
- changed-files: |
||||
|
- any-glob-to-any-file: |
||||
|
- docs/*/docs/** |
||||
|
- all-globs-to-all-files: |
||||
|
- '!docs/en/docs/**' |
||||
|
- '!fastapi/**' |
||||
|
- '!pyproject.toml' |
||||
|
|
||||
|
internal: |
||||
|
- all: |
||||
|
- changed-files: |
||||
|
- any-glob-to-any-file: |
||||
|
- .github/** |
||||
|
- scripts/** |
||||
|
- .gitignore |
||||
|
- .pre-commit-config.yaml |
||||
|
- pdm_build.py |
||||
|
- requirements*.txt |
||||
|
- all-globs-to-all-files: |
||||
|
- '!docs/*/docs/**' |
||||
|
- '!fastapi/**' |
||||
|
- '!pyproject.toml' |
||||
@ -0,0 +1,18 @@ |
|||||
|
name: Add to Project |
||||
|
|
||||
|
on: |
||||
|
pull_request_target: |
||||
|
issues: |
||||
|
types: |
||||
|
- opened |
||||
|
- reopened |
||||
|
|
||||
|
jobs: |
||||
|
add-to-project: |
||||
|
name: Add to project |
||||
|
runs-on: ubuntu-latest |
||||
|
steps: |
||||
|
- uses: actions/add-to-project@v1.0.2 |
||||
|
with: |
||||
|
project-url: https://github.com/orgs/fastapi/projects/2 |
||||
|
github-token: ${{ secrets.PROJECTS_TOKEN }} |
||||
@ -0,0 +1,31 @@ |
|||||
|
name: Labels |
||||
|
on: |
||||
|
pull_request_target: |
||||
|
types: |
||||
|
- opened |
||||
|
- synchronize |
||||
|
- reopened |
||||
|
# For label-checker |
||||
|
- labeled |
||||
|
- unlabeled |
||||
|
|
||||
|
jobs: |
||||
|
labeler: |
||||
|
permissions: |
||||
|
contents: read |
||||
|
pull-requests: write |
||||
|
runs-on: ubuntu-latest |
||||
|
steps: |
||||
|
- uses: actions/labeler@v5 |
||||
|
# Run this after labeler applied labels |
||||
|
check-labels: |
||||
|
needs: |
||||
|
- labeler |
||||
|
permissions: |
||||
|
pull-requests: read |
||||
|
runs-on: ubuntu-latest |
||||
|
steps: |
||||
|
- uses: docker://agilepathway/pull-request-label-checker:latest |
||||
|
with: |
||||
|
one_of: breaking,security,feature,bug,refactor,upgrade,docs,lang-all,internal |
||||
|
repo_token: ${{ secrets.GITHUB_TOKEN }} |
||||
@ -1,185 +0,0 @@ |
|||||
--- |
|
||||
hide: |
|
||||
- navigation |
|
||||
--- |
|
||||
|
|
||||
# FastAPI İnsanlar |
|
||||
|
|
||||
FastAPI-ın bütün mənşəli insanları qəbul edən heyrətamiz icması var. |
|
||||
|
|
||||
|
|
||||
|
|
||||
## Yaradıcı - İcraçı |
|
||||
|
|
||||
Salam! 👋 |
|
||||
|
|
||||
Bu mənəm: |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.maintainers %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablar: {{ user.answers }}</div><div class="count">Pull Request-lər: {{ user.prs }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
Mən **FastAPI**-ın yaradıcısı və icraçısıyam. Əlavə məlumat almaq üçün [Yardım FastAPI - Yardım alın - Müəlliflə əlaqə qurun](help-fastapi.md#connect-with-the-author){.internal-link target=_blank} səhifəsinə baxa bilərsiniz. |
|
||||
|
|
||||
...Burada isə sizə icmanı göstərmək istəyirəm. |
|
||||
|
|
||||
--- |
|
||||
|
|
||||
**FastAPI** icmadan çoxlu dəstək alır və mən onların əməyini vurğulamaq istəyirəm. |
|
||||
|
|
||||
Bu insanlar: |
|
||||
|
|
||||
* [GitHub-da başqalarının suallarına kömək edirlər](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank}. |
|
||||
* [Pull Request-lər yaradırlar](help-fastapi.md#create-a-pull-request){.internal-link target=_blank}. |
|
||||
* Pull Request-ləri ([xüsusilə tərcümələr üçün vacib olan](contributing.md#translations){.internal-link target=_blank}.) nəzərdən keçirirlər. |
|
||||
|
|
||||
Bu insanlara təşəkkür edirəm. 👏 🙇 |
|
||||
|
|
||||
## Keçən ayın ən fəal istifadəçiləri |
|
||||
|
|
||||
Bu istifadəçilər keçən ay [GitHub-da başqalarının suallarına](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank} ən çox kömək edənlərdir. ☕ |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.last_month_experts[:10] %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablandırılmış suallar: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Mütəxəssislər |
|
||||
|
|
||||
Burada **FastAPI Mütəxəssisləri** var. 🤓 |
|
||||
|
|
||||
Bu istifadəçilər indiyə qədər [GitHub-da başqalarının suallarına](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank} ən çox kömək edənlərdir. |
|
||||
|
|
||||
Onlar bir çox insanlara kömək edərək mütəxəssis olduqlarını sübut ediblər. ✨ |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.experts[:50] %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablandırılmış suallar: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Ən yaxşı əməkdaşlar |
|
||||
|
|
||||
Burada **Ən yaxşı əməkdaşlar** var. 👷 |
|
||||
|
|
||||
Bu istifadəçilərin ən çox *birləşdirilmiş* [Pull Request-ləri var](help-fastapi.md#create-a-pull-request){.internal-link target=_blank}. |
|
||||
|
|
||||
Onlar mənbə kodu, sənədləmə, tərcümələr və s. barədə əmək göstərmişlər. 📦 |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.top_contributors[:50] %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Pull Request-lər: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
Bundan başqa bir neçə (yüzdən çox) əməkdaş var ki, onları <a href="https://github.com/tiangolo/fastapi/graphs/contributors" class="external-link" target="_blank">FastAPI GitHub Əməkdaşlar səhifəsində</a> görə bilərsiniz. 👷 |
|
||||
|
|
||||
## Ən çox rəy verənlər |
|
||||
|
|
||||
Bu istifadəçilər **ən çox rəy verənlər**dir. |
|
||||
|
|
||||
### Tərcümələr üçün rəylər |
|
||||
|
|
||||
Mən yalnız bir neçə dildə danışıram (və çox da yaxşı deyil 😅). Bu səbəbdən, rəy verənlər sənədlərin [**tərcümələrini təsdiqləmək üçün gücə malik olanlar**](contributing.md#translations){.internal-link target=_blank}dır. Onlar olmadan, bir çox dilə tərcümə olunmuş sənədlər olmazdı. |
|
||||
|
|
||||
--- |
|
||||
|
|
||||
Başqalarının Pull Request-lərinə **Ən çox rəy verənlər** 🕵️ kodun, sənədlərin və xüsusilə də **tərcümələrin** keyfiyyətini təmin edirlər. |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.top_translations_reviewers[:50] %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Rəylər: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Sponsorlar |
|
||||
|
|
||||
Bunlar **Sponsorlar**dır. 😎 |
|
||||
|
|
||||
Onlar mənim **FastAPI** (və digər) işlərimi əsasən <a href="hhttps://github.com/sponsors/tiangolo" class="external-link" target="_blank">GitHub Sponsorlar</a> vasitəsilə dəstəkləyirlər. |
|
||||
|
|
||||
{% if sponsors %} |
|
||||
|
|
||||
{% if sponsors.gold %} |
|
||||
|
|
||||
### Qızıl Sponsorlar |
|
||||
|
|
||||
{% for sponsor in sponsors.gold -%} |
|
||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
{% if sponsors.silver %} |
|
||||
|
|
||||
### Gümüş Sponsorlar |
|
||||
|
|
||||
{% for sponsor in sponsors.silver -%} |
|
||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
{% if sponsors.bronze %} |
|
||||
|
|
||||
### Bürünc Sponsorlar |
|
||||
|
|
||||
{% for sponsor in sponsors.bronze -%} |
|
||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
{% endif %} |
|
||||
|
|
||||
### Fərdi Sponsorlar |
|
||||
|
|
||||
{% if github_sponsors %} |
|
||||
{% for group in github_sponsors.sponsors %} |
|
||||
|
|
||||
<div class="user-list user-list-center"> |
|
||||
|
|
||||
{% for user in group %} |
|
||||
{% if user.login not in sponsors_badge.logins %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|
||||
|
|
||||
{% endif %} |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
|
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
## Məlumatlar haqqında - texniki detallar |
|
||||
|
|
||||
Bu səhifənin əsas məqsədi, icmanın başqalarına kömək etmək üçün göstərdiyi əməyi vurğulamaqdır. |
|
||||
|
|
||||
Xüsusilə də normalda daha az görünən və bir çox hallarda daha çətin olan, başqalarının suallarına kömək etmək və tərcümələrlə bağlı Pull Request-lərə rəy vermək kimi səy göstərmək. |
|
||||
|
|
||||
Bu səhifənin məlumatları hər ay hesablanır və siz <a href="https://github.com/tiangolo/fastapi/blob/master/.github/actions/people/app/main.py" class="external-link" target="_blank">buradan mənbə kodunu</a> oxuya bilərsiniz. |
|
||||
|
|
||||
Burada sponsorların əməyini də vurğulamaq istəyirəm. |
|
||||
|
|
||||
Mən həmçinin alqoritmi, bölmələri, eşikləri və s. yeniləmək hüququnu da qoruyuram (hər ehtimala qarşı 🤷). |
|
||||
@ -0,0 +1,596 @@ |
|||||
|
# পাইথন এর <abbr title="একটি ভেরিয়েবল কি ধরনের ডেটা ধারণ করতে পারে।">টাইপ্স</abbr> পরিচিতি |
||||
|
|
||||
|
Python-এ ঐচ্ছিক "টাইপ হিন্ট" (যা "টাইপ অ্যানোটেশন" নামেও পরিচিত) এর জন্য সাপোর্ট রয়েছে। |
||||
|
|
||||
|
এই **"টাইপ হিন্ট"** বা অ্যানোটেশনগুলি এক ধরণের বিশেষ <abbr title="সিনট্যাক্স হল প্রোগ্রামিং ভাষায় কোড লেখার নিয়ম ও গঠন।">সিনট্যাক্স</abbr> যা একটি ভেরিয়েবলের <abbr title="যেমন: str, int, float, bool">টাইপ</abbr> ঘোষণা করতে দেয়। |
||||
|
|
||||
|
ভেরিয়েবলগুলির জন্য টাইপ ঘোষণা করলে, এডিটর এবং টুলগুলি আপনাকে আরও ভালো সাপোর্ট দিতে পারে। |
||||
|
|
||||
|
এটি পাইথন টাইপ হিন্ট সম্পর্কে একটি দ্রুত **টিউটোরিয়াল / রিফ্রেশার** মাত্র। এটি **FastAPI** এর সাথে ব্যবহার করার জন্য শুধুমাত্র ন্যূনতম প্রয়োজনীয়তা কভার করে... যা আসলে খুব একটা বেশি না। |
||||
|
|
||||
|
**FastAPI** এই টাইপ হিন্টগুলির উপর ভিত্তি করে নির্মিত, যা এটিকে অনেক সুবিধা এবং লাভ প্রদান করে। |
||||
|
|
||||
|
তবে, আপনি যদি কখনো **FastAPI** ব্যবহার নাও করেন, তবুও এগুলি সম্পর্কে একটু শেখা আপনার উপকারে আসবে। |
||||
|
|
||||
|
/// note |
||||
|
|
||||
|
যদি আপনি একজন Python বিশেষজ্ঞ হন, এবং টাইপ হিন্ট সম্পর্কে সবকিছু জানেন, তাহলে পরবর্তী অধ্যায়ে চলে যান। |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## প্রেরণা |
||||
|
|
||||
|
চলুন একটি সাধারণ উদাহরণ দিয়ে শুরু করি: |
||||
|
|
||||
|
```Python |
||||
|
{!../../../docs_src/python_types/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
এই প্রোগ্রামটি কল করলে আউটপুট হয়: |
||||
|
|
||||
|
``` |
||||
|
John Doe |
||||
|
``` |
||||
|
|
||||
|
ফাংশনটি নিম্নলিখিত কাজ করে: |
||||
|
|
||||
|
* `first_name` এবং `last_name` নেয়। |
||||
|
* প্রতিটির প্রথম অক্ষরকে `title()` ব্যবহার করে বড় হাতের অক্ষরে রূপান্তর করে। |
||||
|
* তাদেরকে মাঝখানে একটি স্পেস দিয়ে <abbr title="একটার পরে একটা একত্রিত করা">concatenate</abbr> করে। |
||||
|
|
||||
|
```Python hl_lines="2" |
||||
|
{!../../../docs_src/python_types/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### এটি সম্পাদনা করুন |
||||
|
|
||||
|
এটি একটি খুব সাধারণ প্রোগ্রাম। |
||||
|
|
||||
|
কিন্তু এখন কল্পনা করুন যে আপনি এটি শুরু থেকে লিখছিলেন। |
||||
|
|
||||
|
এক পর্যায়ে আপনি ফাংশনের সংজ্ঞা শুরু করেছিলেন, আপনার প্যারামিটারগুলি প্রস্তুত ছিল... |
||||
|
|
||||
|
কিন্তু তারপর আপনাকে "সেই method কল করতে হবে যা প্রথম অক্ষরকে বড় হাতের অক্ষরে রূপান্তর করে"। |
||||
|
|
||||
|
এটা কি `upper` ছিল? নাকি `uppercase`? `first_uppercase`? `capitalize`? |
||||
|
|
||||
|
তারপর, আপনি পুরোনো প্রোগ্রামারের বন্ধু, এডিটর অটোকমপ্লিশনের সাহায্যে নেওয়ার চেষ্টা করেন। |
||||
|
|
||||
|
আপনি ফাংশনের প্রথম প্যারামিটার `first_name` টাইপ করেন, তারপর একটি ডট (`.`) টাইপ করেন এবং `Ctrl+Space` চাপেন অটোকমপ্লিশন ট্রিগার করার জন্য। |
||||
|
|
||||
|
কিন্তু, দুর্ভাগ্যবশত, আপনি কিছুই উপযোগী পান না: |
||||
|
|
||||
|
<img src="/img/python-types/image01.png"> |
||||
|
|
||||
|
### টাইপ যোগ করুন |
||||
|
|
||||
|
আসুন আগের সংস্করণ থেকে একটি লাইন পরিবর্তন করি। |
||||
|
|
||||
|
আমরা ঠিক এই অংশটি পরিবর্তন করব অর্থাৎ ফাংশনের প্যারামিটারগুলি, এইগুলি: |
||||
|
|
||||
|
```Python |
||||
|
first_name, last_name |
||||
|
``` |
||||
|
|
||||
|
থেকে এইগুলি: |
||||
|
|
||||
|
```Python |
||||
|
first_name: str, last_name: str |
||||
|
``` |
||||
|
|
||||
|
ব্যাস। |
||||
|
|
||||
|
এগুলিই "টাইপ হিন্ট": |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!../../../docs_src/python_types/tutorial002.py!} |
||||
|
``` |
||||
|
|
||||
|
এটি ডিফল্ট ভ্যালু ঘোষণা করার মত নয় যেমন: |
||||
|
|
||||
|
```Python |
||||
|
first_name="john", last_name="doe" |
||||
|
``` |
||||
|
|
||||
|
এটি একটি ভিন্ন জিনিস। |
||||
|
|
||||
|
আমরা সমান (`=`) নয়, কোলন (`:`) ব্যবহার করছি। |
||||
|
|
||||
|
এবং টাইপ হিন্ট যোগ করা সাধারণত তেমন কিছু পরিবর্তন করে না যা টাইপ হিন্ট ছাড়াই ঘটত। |
||||
|
|
||||
|
কিন্তু এখন, কল্পনা করুন আপনি আবার সেই ফাংশন তৈরির মাঝখানে আছেন, কিন্তু টাইপ হিন্ট সহ। |
||||
|
|
||||
|
একই পর্যায়ে, আপনি অটোকমপ্লিট ট্রিগার করতে `Ctrl+Space` চাপেন এবং আপনি দেখতে পান: |
||||
|
|
||||
|
<img src="/img/python-types/image02.png"> |
||||
|
|
||||
|
এর সাথে, আপনি অপশনগুলি দেখে, স্ক্রল করতে পারেন, যতক্ষণ না আপনি এমন একটি অপশন খুঁজে পান যা কিছু মনে পরিয়ে দেয়: |
||||
|
|
||||
|
<img src="/img/python-types/image03.png"> |
||||
|
|
||||
|
## আরও প্রেরণা |
||||
|
|
||||
|
এই ফাংশনটি দেখুন, এটিতে ইতিমধ্যে টাইপ হিন্ট রয়েছে: |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!../../../docs_src/python_types/tutorial003.py!} |
||||
|
``` |
||||
|
|
||||
|
এডিটর ভেরিয়েবলগুলির টাইপ জানার কারণে, আপনি শুধুমাত্র অটোকমপ্লিশনই পান না, আপনি এরর চেকও পান: |
||||
|
|
||||
|
<img src="/img/python-types/image04.png"> |
||||
|
|
||||
|
এখন আপনি জানেন যে আপনাকে এটি ঠিক করতে হবে, `age`-কে একটি স্ট্রিং হিসেবে রূপান্তর করতে `str(age)` ব্যবহার করতে হবে: |
||||
|
|
||||
|
```Python hl_lines="2" |
||||
|
{!../../../docs_src/python_types/tutorial004.py!} |
||||
|
``` |
||||
|
|
||||
|
## টাইপ ঘোষণা |
||||
|
|
||||
|
আপনি এতক্ষন টাইপ হিন্ট ঘোষণা করার মূল স্থানটি দেখে ফেলেছেন-- ফাংশন প্যারামিটার হিসেবে। |
||||
|
|
||||
|
সাধারণত এটি **FastAPI** এর ক্ষেত্রেও একই। |
||||
|
|
||||
|
### সিম্পল টাইপ |
||||
|
|
||||
|
আপনি `str` ছাড়াও সমস্ত স্ট্যান্ডার্ড পাইথন টাইপ ঘোষণা করতে পারেন। |
||||
|
|
||||
|
উদাহরণস্বরূপ, আপনি এগুলো ব্যবহার করতে পারেন: |
||||
|
|
||||
|
* `int` |
||||
|
* `float` |
||||
|
* `bool` |
||||
|
* `bytes` |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!../../../docs_src/python_types/tutorial005.py!} |
||||
|
``` |
||||
|
|
||||
|
### টাইপ প্যারামিটার সহ জেনেরিক টাইপ |
||||
|
|
||||
|
কিছু ডাটা স্ট্রাকচার অন্যান্য মান ধারণ করতে পারে, যেমন `dict`, `list`, `set` এবং `tuple`। এবং অভ্যন্তরীণ মানগুলোরও নিজেদের টাইপ থাকতে পারে। |
||||
|
|
||||
|
এই ধরনের টাইপগুলিকে বলা হয় "**জেনেরিক**" টাইপ এবং এগুলিকে তাদের অভ্যন্তরীণ টাইপগুলি সহ ঘোষণা করা সম্ভব। |
||||
|
|
||||
|
এই টাইপগুলি এবং অভ্যন্তরীণ টাইপগুলি ঘোষণা করতে, আপনি Python মডিউল `typing` ব্যবহার করতে পারেন। এটি বিশেষভাবে এই টাইপ হিন্টগুলি সমর্থন করার জন্য রয়েছে। |
||||
|
|
||||
|
#### Python এর নতুন সংস্করণ |
||||
|
|
||||
|
`typing` ব্যবহার করা সিনট্যাক্সটি Python 3.6 থেকে সর্বশেষ সংস্করণগুলি পর্যন্ত, অর্থাৎ Python 3.9, Python 3.10 ইত্যাদি সহ সকল সংস্করণের সাথে **সামঞ্জস্যপূর্ণ**। |
||||
|
|
||||
|
Python যত এগিয়ে যাচ্ছে, **নতুন সংস্করণগুলি** এই টাইপ অ্যানোটেশনগুলির জন্য তত উন্নত সাপোর্ট নিয়ে আসছে এবং অনেক ক্ষেত্রে আপনাকে টাইপ অ্যানোটেশন ঘোষণা করতে `typing` মডিউল ইম্পোর্ট এবং ব্যবহার করার প্রয়োজন হবে না। |
||||
|
|
||||
|
যদি আপনি আপনার প্রজেক্টের জন্য Python-এর আরও সাম্প্রতিক সংস্করণ নির্বাচন করতে পারেন, তাহলে আপনি সেই অতিরিক্ত সরলতা থেকে সুবিধা নিতে পারবেন। |
||||
|
|
||||
|
ডক্সে রয়েছে Python-এর প্রতিটি সংস্করণের সাথে সামঞ্জস্যপূর্ণ উদাহরণগুলি (যখন পার্থক্য আছে)। |
||||
|
|
||||
|
উদাহরণস্বরূপ, "**Python 3.6+**" মানে এটি Python 3.6 বা তার উপরে সামঞ্জস্যপূর্ণ (যার মধ্যে 3.7, 3.8, 3.9, 3.10, ইত্যাদি অন্তর্ভুক্ত)। এবং "**Python 3.9+**" মানে এটি Python 3.9 বা তার উপরে সামঞ্জস্যপূর্ণ (যার মধ্যে 3.10, ইত্যাদি অন্তর্ভুক্ত)। |
||||
|
|
||||
|
যদি আপনি Python-এর **সর্বশেষ সংস্করণগুলি ব্যবহার করতে পারেন**, তাহলে সর্বশেষ সংস্করণের জন্য উদাহরণগুলি ব্যবহার করুন, সেগুলি আপনাকে **সর্বোত্তম এবং সহজতম সিনট্যাক্স** প্রদান করবে, যেমন, "**Python 3.10+**"। |
||||
|
|
||||
|
#### লিস্ট |
||||
|
|
||||
|
উদাহরণস্বরূপ, একটি ভেরিয়েবলকে `str`-এর একটি `list` হিসেবে সংজ্ঞায়িত করা যাক। |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
ভেরিয়েবলটি ঘোষণা করুন, একই কোলন (`:`) সিনট্যাক্স ব্যবহার করে। |
||||
|
|
||||
|
টাইপ হিসেবে, `list` ব্যবহার করুন। |
||||
|
|
||||
|
যেহেতু লিস্ট এমন একটি টাইপ যা অভ্যন্তরীণ টাইপগুলি ধারণ করে, আপনি তাদের স্কোয়ার ব্রাকেটের ভিতরে ব্যবহার করুন: |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial006_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
`typing` থেকে `List` (বড় হাতের `L` দিয়ে) ইমপোর্ট করুন: |
||||
|
|
||||
|
``` Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial006.py!} |
||||
|
``` |
||||
|
|
||||
|
ভেরিয়েবলটি ঘোষণা করুন, একই কোলন (`:`) সিনট্যাক্স ব্যবহার করে। |
||||
|
|
||||
|
টাইপ হিসেবে, `typing` থেকে আপনার ইম্পোর্ট করা `List` ব্যবহার করুন। |
||||
|
|
||||
|
যেহেতু লিস্ট এমন একটি টাইপ যা অভ্যন্তরীণ টাইপগুলি ধারণ করে, আপনি তাদের স্কোয়ার ব্রাকেটের ভিতরে করুন: |
||||
|
|
||||
|
```Python hl_lines="4" |
||||
|
{!> ../../../docs_src/python_types/tutorial006.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
/// info |
||||
|
|
||||
|
স্কোয়ার ব্রাকেট এর ভিতরে ব্যবহৃত এইসব অভন্তরীন টাইপগুলোকে "ইন্টারনাল টাইপ" বলে। |
||||
|
|
||||
|
এই উদাহরণে, এটি হচ্ছে `List`(অথবা পাইথন ৩.৯ বা তার উপরের সংস্করণের ক্ষেত্রে `list`) এ পাস করা টাইপ প্যারামিটার। |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
এর অর্থ হচ্ছে: "ভেরিয়েবল `items` একটি `list`, এবং এই লিস্টের প্রতিটি আইটেম একটি `str`।" |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
যদি আপনি Python 3.9 বা তার উপরে ব্যবহার করেন, আপনার `typing` থেকে `List` আমদানি করতে হবে না, আপনি সাধারণ `list` ওই টাইপের পরিবর্তে ব্যবহার করতে পারেন। |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
এর মাধ্যমে, আপনার এডিটর লিস্ট থেকে আইটেম প্রসেস করার সময় সাপোর্ট প্রদান করতে পারবে: |
||||
|
|
||||
|
<img src="/img/python-types/image05.png"> |
||||
|
|
||||
|
টাইপগুলি ছাড়া, এটি করা প্রায় অসম্ভব। |
||||
|
|
||||
|
লক্ষ্য করুন যে ভেরিয়েবল `item` হল `items` লিস্টের একটি এলিমেন্ট। |
||||
|
|
||||
|
তবুও, এডিটর জানে যে এটি একটি `str`, এবং তার জন্য সাপোর্ট প্রদান করে। |
||||
|
|
||||
|
#### টাপল এবং সেট |
||||
|
|
||||
|
আপনি `tuple` এবং `set` ঘোষণা করার জন্য একই প্রক্রিয়া অনুসরণ করবেন: |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial007_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial007.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
এর মানে হল: |
||||
|
|
||||
|
* ভেরিয়েবল `items_t` হল একটি `tuple` যা ৩টি আইটেম ধারণ করে, একটি `int`, অন্য একটি `int`, এবং একটি `str`। |
||||
|
* ভেরিয়েবল `items_s` হল একটি `set`, এবং এর প্রতিটি আইটেম হল `bytes` টাইপের। |
||||
|
|
||||
|
#### ডিক্ট |
||||
|
|
||||
|
একটি `dict` সংজ্ঞায়িত করতে, আপনি ২টি টাইপ প্যারামিটার কমা দ্বারা পৃথক করে দেবেন। |
||||
|
|
||||
|
প্রথম টাইপ প্যারামিটারটি হল `dict`-এর কীগুলির জন্য। |
||||
|
|
||||
|
দ্বিতীয় টাইপ প্যারামিটারটি হল `dict`-এর মানগুলির জন্য: |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial008_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial008.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
এর মানে হল: |
||||
|
|
||||
|
* ভেরিয়েবল `prices` হল একটি `dict`: |
||||
|
* এই `dict`-এর কীগুলি হল `str` টাইপের (ধরা যাক, প্রতিটি আইটেমের নাম)। |
||||
|
* এই `dict`-এর মানগুলি হল `float` টাইপের (ধরা যাক, প্রতিটি আইটেমের দাম)। |
||||
|
|
||||
|
#### ইউনিয়ন |
||||
|
|
||||
|
আপনি একটি ভেরিয়েবলকে এমনভাবে ঘোষণা করতে পারেন যেন তা **একাধিক টাইপের** হয়, উদাহরণস্বরূপ, একটি `int` অথবা `str`। |
||||
|
|
||||
|
Python 3.6 এবং তার উপরের সংস্করণগুলিতে (Python 3.10 অন্তর্ভুক্ত) আপনি `typing` থেকে `Union` টাইপ ব্যবহার করতে পারেন এবং স্কোয়ার ব্র্যাকেটের মধ্যে গ্রহণযোগ্য টাইপগুলি রাখতে পারেন। |
||||
|
|
||||
|
Python 3.10-এ একটি **নতুন সিনট্যাক্স** আছে যেখানে আপনি সম্ভাব্য টাইপগুলিকে একটি <abbr title="উল্লম্ব বারালকে 'বিটওয়াইজ বা অপারেটর' বলা হয়, কিন্তু সেই অর্থ এখানে প্রাসঙ্গিক নয়">ভার্টিকাল বার (`|`)</abbr> দ্বারা পৃথক করতে পারেন। |
||||
|
|
||||
|
//// tab | Python 3.10+ |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial008b_py310.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial008b.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
উভয় ক্ষেত্রেই এর মানে হল যে `item` হতে পারে একটি `int` অথবা `str`। |
||||
|
|
||||
|
#### সম্ভবত `None` |
||||
|
|
||||
|
আপনি এমনভাবে ঘোষণা করতে পারেন যে একটি মান হতে পারে এক টাইপের, যেমন `str`, আবার এটি `None`-ও হতে পারে। |
||||
|
|
||||
|
Python 3.6 এবং তার উপরের সংস্করণগুলিতে (Python 3.10 অনতর্ভুক্ত) আপনি `typing` মডিউল থেকে `Optional` ইমপোর্ট করে এটি ঘোষণা এবং ব্যবহার করতে পারেন। |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!../../../docs_src/python_types/tutorial009.py!} |
||||
|
``` |
||||
|
|
||||
|
`Optional[str]` ব্যবহার করা মানে হল শুধু `str` নয়, এটি হতে পারে `None`-ও, যা আপনার এডিটরকে সেই ত্রুটিগুলি শনাক্ত করতে সাহায্য করবে যেখানে আপনি ধরে নিচ্ছেন যে একটি মান সবসময় `str` হবে, অথচ এটি `None`-ও হতে পারেও। |
||||
|
|
||||
|
`Optional[Something]` মূলত `Union[Something, None]`-এর একটি শর্টকাট, এবং তারা সমতুল্য। |
||||
|
|
||||
|
এর মানে হল, Python 3.10-এ, আপনি টাইপগুলির ইউনিয়ন ঘোষণা করতে `Something | None` ব্যবহার করতে পারেন: |
||||
|
|
||||
|
//// tab | Python 3.10+ |
||||
|
|
||||
|
```Python hl_lines="1" |
||||
|
{!> ../../../docs_src/python_types/tutorial009_py310.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial009.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ বিকল্প |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial009b.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
#### `Union` বা `Optional` ব্যবহার |
||||
|
|
||||
|
যদি আপনি Python 3.10-এর নীচের সংস্করণ ব্যবহার করেন, তবে এখানে আমার খুবই **ব্যক্তিগত** দৃষ্টিভঙ্গি থেকে একটি টিপস: |
||||
|
|
||||
|
* 🚨 `Optional[SomeType]` ব্যবহার এড়িয়ে চলুন। |
||||
|
* এর পরিবর্তে ✨ **`Union[SomeType, None]` ব্যবহার করুন** ✨। |
||||
|
|
||||
|
উভয়ই সমতুল্য এবং মূলে একই, কিন্তু আমি `Union`-এর পক্ষে সুপারিশ করব কারণ "**অপশনাল**" শব্দটি মনে হতে পারে যে মানটি ঐচ্ছিক,অথচ এটি আসলে মানে "এটি হতে পারে `None`", এমনকি যদি এটি ঐচ্ছিক না হয়েও আবশ্যিক হয়। |
||||
|
|
||||
|
আমি মনে করি `Union[SomeType, None]` এর অর্থ আরও স্পষ্টভাবে প্রকাশ করে। |
||||
|
|
||||
|
এটি কেবল শব্দ এবং নামের ব্যাপার। কিন্তু সেই শব্দগুলি আপনি এবং আপনার সহকর্মীরা কোড সম্পর্কে কীভাবে চিন্তা করেন তা প্রভাবিত করতে পারে। |
||||
|
|
||||
|
একটি উদাহরণ হিসেবে, এই ফাংশনটি নিন: |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!../../../docs_src/python_types/tutorial009c.py!} |
||||
|
``` |
||||
|
|
||||
|
`name` প্যারামিটারটি `Optional[str]` হিসেবে সংজ্ঞায়িত হয়েছে, কিন্তু এটি **অপশনাল নয়**, আপনি প্যারামিটার ছাড়া ফাংশনটি কল করতে পারবেন না: |
||||
|
|
||||
|
```Python |
||||
|
say_hi() # ওহ না, এটি একটি ত্রুটি নিক্ষেপ করবে! 😱 |
||||
|
``` |
||||
|
|
||||
|
`name` প্যারামিটারটি **এখনও আবশ্যিক** (নন-অপশনাল) কারণ এটির কোনো ডিফল্ট মান নেই। তবুও, `name` এর মান হিসেবে `None` গ্রহণযোগ্য: |
||||
|
|
||||
|
```Python |
||||
|
say_hi(name=None) # এটি কাজ করে, None বৈধ 🎉 |
||||
|
``` |
||||
|
|
||||
|
সুখবর হল, একবার আপনি Python 3.10 ব্যবহার করা শুরু করলে, আপনাকে এগুলোর ব্যাপারে আর চিন্তা করতে হবে না, যেহুতু আপনি | ব্যবহার করেই ইউনিয়ন ঘোষণা করতে পারবেন: |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!../../../docs_src/python_types/tutorial009c_py310.py!} |
||||
|
``` |
||||
|
|
||||
|
এবং তারপর আপনাকে নামগুলি যেমন `Optional` এবং `Union` নিয়ে আর চিন্তা করতে হবে না। 😎 |
||||
|
|
||||
|
#### জেনেরিক টাইপস |
||||
|
|
||||
|
স্কোয়ার ব্র্যাকেটে টাইপ প্যারামিটার নেওয়া এই টাইপগুলিকে **জেনেরিক টাইপ** বা **জেনেরিকস** বলা হয়, যেমন: |
||||
|
|
||||
|
//// tab | Python 3.10+ |
||||
|
|
||||
|
আপনি সেই একই বিল্টইন টাইপ জেনেরিক্স হিসেবে ব্যবহার করতে পারবেন(ভিতরে টাইপ সহ স্কয়ারে ব্রাকেট দিয়ে): |
||||
|
|
||||
|
* `list` |
||||
|
* `tuple` |
||||
|
* `set` |
||||
|
* `dict` |
||||
|
|
||||
|
এবং Python 3.8 এর মতোই, `typing` মডিউল থেকে: |
||||
|
|
||||
|
* `Union` |
||||
|
* `Optional` (Python 3.8 এর মতোই) |
||||
|
* ...এবং অন্যান্য। |
||||
|
|
||||
|
Python 3.10-এ, `Union` এবং `Optional` জেনেরিকস ব্যবহার করার বিকল্প হিসেবে, আপনি টাইপগুলির ইউনিয়ন ঘোষণা করতে <abbr title="উল্লম্ব বারালকে 'বিটওয়াইজ বা অপারেটর' বলা হয়, কিন্তু সেই অর্থ এখানে প্রাসঙ্গিক নয়">ভার্টিকাল বার (`|`)</abbr> ব্যবহার করতে পারেন, যা ওদের থেকে অনেক ভালো এবং সহজ। |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
আপনি সেই একই বিল্টইন টাইপ জেনেরিক্স হিসেবে ব্যবহার করতে পারবেন(ভিতরে টাইপ সহ স্কয়ারে ব্রাকেট দিয়ে): |
||||
|
|
||||
|
* `list` |
||||
|
* `tuple` |
||||
|
* `set` |
||||
|
* `dict` |
||||
|
|
||||
|
এবং Python 3.8 এর মতোই, `typing` মডিউল থেকে: |
||||
|
|
||||
|
* `Union` |
||||
|
* `Optional` |
||||
|
* ...এবং অন্যান্য। |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
* `List` |
||||
|
* `Tuple` |
||||
|
* `Set` |
||||
|
* `Dict` |
||||
|
* `Union` |
||||
|
* `Optional` |
||||
|
* ...এবং অন্যান্য। |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
### ক্লাস হিসেবে টাইপস |
||||
|
|
||||
|
আপনি একটি ভেরিয়েবলের টাইপ হিসেবে একটি ক্লাস ঘোষণা করতে পারেন। |
||||
|
|
||||
|
ধরুন আপনার কাছে `Person` নামে একটি ক্লাস আছে, যার একটি নাম আছে: |
||||
|
|
||||
|
```Python hl_lines="1-3" |
||||
|
{!../../../docs_src/python_types/tutorial010.py!} |
||||
|
``` |
||||
|
|
||||
|
তারপর আপনি একটি ভেরিয়েবলকে `Person` টাইপের হিসেবে ঘোষণা করতে পারেন: |
||||
|
|
||||
|
```Python hl_lines="6" |
||||
|
{!../../../docs_src/python_types/tutorial010.py!} |
||||
|
``` |
||||
|
|
||||
|
এবং তারপর, আবার, আপনি এডিটর সাপোর্ট পেয়ে যাবেন: |
||||
|
|
||||
|
<img src="/img/python-types/image06.png"> |
||||
|
|
||||
|
লক্ষ্য করুন যে এর মানে হল "`one_person` হল ক্লাস `Person`-এর একটি **ইন্সট্যান্স**।" |
||||
|
|
||||
|
এর মানে এটি নয় যে "`one_person` হল **ক্লাস** যাকে বলা হয় `Person`।" |
||||
|
|
||||
|
## Pydantic মডেল |
||||
|
|
||||
|
[Pydantic](https://docs.pydantic.dev/) হল একটি Python লাইব্রেরি যা ডাটা ভ্যালিডেশন সম্পাদন করে। |
||||
|
|
||||
|
আপনি ডাটার "আকার" এট্রিবিউট সহ ক্লাস হিসেবে ঘোষণা করেন। |
||||
|
|
||||
|
এবং প্রতিটি এট্রিবিউট এর একটি টাইপ থাকে। |
||||
|
|
||||
|
তারপর আপনি যদি কিছু মান দিয়ে সেই ক্লাসের একটি ইন্সট্যান্স তৈরি করেন-- এটি মানগুলিকে ভ্যালিডেট করবে, প্রয়োজন অনুযায়ী তাদেরকে উপযুক্ত টাইপে রূপান্তর করবে এবং আপনাকে সমস্ত ডাটা সহ একটি অবজেক্ট প্রদান করবে। |
||||
|
|
||||
|
এবং আপনি সেই ফলাফল অবজেক্টের সাথে এডিটর সাপোর্ট পাবেন। |
||||
|
|
||||
|
অফিসিয়াল Pydantic ডক্স থেকে একটি উদাহরণ: |
||||
|
|
||||
|
//// tab | Python 3.10+ |
||||
|
|
||||
|
```Python |
||||
|
{!> ../../../docs_src/python_types/tutorial011_py310.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
```Python |
||||
|
{!> ../../../docs_src/python_types/tutorial011_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python |
||||
|
{!> ../../../docs_src/python_types/tutorial011.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
/// info |
||||
|
|
||||
|
[Pydantic সম্পর্কে আরও জানতে, এর ডকুমেন্টেশন দেখুন](https://docs.pydantic.dev/)। |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
**FastAPI** মূলত Pydantic-এর উপর নির্মিত। |
||||
|
|
||||
|
আপনি এই সমস্ত কিছুর অনেক বাস্তবসম্মত উদাহরণ পাবেন [টিউটোরিয়াল - ইউজার গাইডে](https://fastapi.tiangolo.com/tutorial/)। |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
যখন আপনি `Optional` বা `Union[Something, None]` ব্যবহার করেন এবং কোনো ডিফল্ট মান না থাকে, Pydantic-এর একটি বিশেষ আচরণ রয়েছে, আপনি Pydantic ডকুমেন্টেশনে [Required Optional fields](https://docs.pydantic.dev/latest/concepts/models/#required-optional-fields) সম্পর্কে আরও পড়তে পারেন। |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## মেটাডাটা অ্যানোটেশন সহ টাইপ হিন্টস |
||||
|
|
||||
|
Python-এ এমন একটি ফিচার আছে যা `Annotated` ব্যবহার করে এই টাইপ হিন্টগুলিতে **অতিরিক্ত মেটাডাটা** রাখতে দেয়। |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
Python 3.9-এ, `Annotated` স্ট্যান্ডার্ড লাইব্রেরিতে অন্তর্ভুক্ত, তাই আপনি এটি `typing` থেকে ইমপোর্ট করতে পারেন। |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial013_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
Python 3.9-এর নীচের সংস্করণগুলিতে, আপনি `Annotated`-কে `typing_extensions` থেকে ইমপোর্ট করেন। |
||||
|
|
||||
|
এটি **FastAPI** এর সাথে ইতিমদ্ধে ইনস্টল হয়ে থাকবে। |
||||
|
|
||||
|
```Python hl_lines="1 4" |
||||
|
{!> ../../../docs_src/python_types/tutorial013.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
Python নিজে এই `Annotated` দিয়ে কিছুই করে না। এবং এডিটর এবং অন্যান্য টুলগুলির জন্য, টাইপটি এখনও `str`। |
||||
|
|
||||
|
কিন্তু আপনি এই `Annotated` এর মধ্যকার জায়গাটির মধ্যে **FastAPI**-এ কীভাবে আপনার অ্যাপ্লিকেশন আচরণ করুক তা সম্পর্কে অতিরিক্ত মেটাডাটা প্রদান করার জন্য ব্যবহার করতে পারেন। |
||||
|
|
||||
|
মনে রাখার গুরুত্বপূর্ণ বিষয় হল যে **প্রথম *টাইপ প্যারামিটার*** আপনি `Annotated`-এ পাস করেন সেটি হল **আসল টাইপ**। বাকি শুধুমাত্র অন্যান্য টুলগুলির জন্য মেটাডাটা। |
||||
|
|
||||
|
এখন আপনার কেবল জানা প্রয়োজন যে `Annotated` বিদ্যমান, এবং এটি স্ট্যান্ডার্ড Python। 😎 |
||||
|
|
||||
|
পরবর্তীতে আপনি দেখবেন এটি কতটা **শক্তিশালী** হতে পারে। |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
এটি **স্ট্যান্ডার্ড Python** হওয়ার মানে হল আপনি আপনার এডিটরে, আপনি যে টুলগুলি কোড বিশ্লেষণ এবং রিফ্যাক্টর করার জন্য ব্যবহার করেন তাতে **সেরা সম্ভাব্য ডেভেলপার এক্সপেরিয়েন্স** পাবেন। ✨ |
||||
|
|
||||
|
এবং এছাড়াও আপনার কোড অন্যান্য অনেক Python টুল এবং লাইব্রেরিগুলির সাথে খুব সামঞ্জস্যপূর্ণ হবে। 🚀 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## **FastAPI**-এ টাইপ হিন্টস |
||||
|
|
||||
|
**FastAPI** এই টাইপ হিন্টগুলি ব্যবহার করে বেশ কিছু জিনিস করে। |
||||
|
|
||||
|
**FastAPI**-এ আপনি টাইপ হিন্টগুলি সহ প্যারামিটার ঘোষণা করেন এবং আপনি পান: |
||||
|
|
||||
|
* **এডিটর সাপোর্ট**। |
||||
|
* **টাইপচেক**। |
||||
|
|
||||
|
...এবং **FastAPI** একই ঘোষণাগুলি ব্যবহার করে: |
||||
|
|
||||
|
* **রিকুইরেমেন্টস সংজ্ঞায়িত করে**: রিকোয়েস্ট পাথ প্যারামিটার, কুয়েরি প্যারামিটার, হেডার, বডি, ডিপেন্ডেন্সিস, ইত্যাদি থেকে। |
||||
|
* **ডেটা রূপান্তর করে**: রিকোয়েস্ট থেকে প্রয়োজনীয় টাইপে ডেটা। |
||||
|
* **ডেটা যাচাই করে**: প্রতিটি রিকোয়েস্ট থেকে আসা ডেটা: |
||||
|
* যখন ডেটা অবৈধ হয় তখন **স্বয়ংক্রিয় ত্রুটি** গ্রাহকের কাছে ফেরত পাঠানো। |
||||
|
* **API ডকুমেন্টেশন তৈরি করে**: OpenAPI ব্যবহার করে: |
||||
|
* যা স্বয়ংক্রিয় ইন্টার্যাক্টিভ ডকুমেন্টেশন ইউজার ইন্টারফেস দ্বারা ব্যবহৃত হয়। |
||||
|
|
||||
|
এই সব কিছু আপনার কাছে অস্পষ্ট মনে হতে পারে। চিন্তা করবেন না। আপনি [টিউটোরিয়াল - ইউজার গাইড](https://fastapi.tiangolo.com/tutorial/) এ এই সব কিছু প্র্যাকটিসে দেখতে পাবেন। |
||||
|
|
||||
|
গুরুত্বপূর্ণ বিষয় হল, আপনি যদি স্ট্যান্ডার্ড Python টাইপগুলি ব্যবহার করেন, তবে আরও বেশি ক্লাস, ডেকোরেটর ইত্যাদি যোগ না করেই একই স্থানে **FastAPI** আপনার অনেক কাজ করে দিবে। |
||||
|
|
||||
|
/// info |
||||
|
|
||||
|
যদি আপনি টিউটোরিয়ালের সমস্ত বিষয় পড়ে ফেলে থাকেন এবং টাইপ সম্পর্কে আরও জানতে চান, তবে একটি ভালো রিসোর্স হল [mypy এর "cheat sheet"](https://mypy.readthedocs.io/en/latest/cheat_sheet_py3.html)। এই "cheat sheet" এ আপনি Python টাইপ হিন্ট সম্পর্কে বেসিক থেকে উন্নত লেভেলের ধারণা পেতে পারেন, যা আপনার কোডে টাইপ সেফটি এবং স্পষ্টতা বাড়াতে সাহায্য করবে। |
||||
|
|
||||
|
/// |
||||
@ -1,36 +0,0 @@ |
|||||
# Externe Links und Artikel |
|
||||
|
|
||||
**FastAPI** hat eine großartige Community, die ständig wächst. |
|
||||
|
|
||||
Es gibt viele Beiträge, Artikel, Tools und Projekte zum Thema **FastAPI**. |
|
||||
|
|
||||
Hier ist eine unvollständige Liste einiger davon. |
|
||||
|
|
||||
!!! tip "Tipp" |
|
||||
Wenn Sie einen Artikel, ein Projekt, ein Tool oder irgendetwas im Zusammenhang mit **FastAPI** haben, was hier noch nicht aufgeführt ist, erstellen Sie einen <a href="https://github.com/tiangolo/fastapi/edit/master/docs/en/data/external_links.yml" class="external-link" target="_blank">Pull Request und fügen Sie es hinzu</a>. |
|
||||
|
|
||||
!!! note "Hinweis Deutsche Übersetzung" |
|
||||
Die folgenden Überschriften und Links werden aus einer <a href="https://github.com/tiangolo/fastapi/blob/master/docs/en/data/external_links.yml" class="external-link" target="_blank">anderen Datei</a> gelesen und sind daher nicht ins Deutsche übersetzt. |
|
||||
|
|
||||
{% for section_name, section_content in external_links.items() %} |
|
||||
|
|
||||
## {{ section_name }} |
|
||||
|
|
||||
{% for lang_name, lang_content in section_content.items() %} |
|
||||
|
|
||||
### {{ lang_name }} |
|
||||
|
|
||||
{% for item in lang_content %} |
|
||||
|
|
||||
* <a href="{{ item.link }}" class="external-link" target="_blank">{{ item.title }}</a> by <a href="{{ item.author_link }}" class="external-link" target="_blank">{{ item.author }}</a>. |
|
||||
|
|
||||
{% endfor %} |
|
||||
{% endfor %} |
|
||||
{% endfor %} |
|
||||
|
|
||||
## Projekte |
|
||||
|
|
||||
Die neuesten GitHub-Projekte zum Thema `fastapi`: |
|
||||
|
|
||||
<div class="github-topic-projects"> |
|
||||
</div> |
|
||||
@ -1,176 +0,0 @@ |
|||||
--- |
|
||||
hide: |
|
||||
- navigation |
|
||||
--- |
|
||||
|
|
||||
# FastAPI Leute |
|
||||
|
|
||||
FastAPI hat eine großartige Gemeinschaft, die Menschen mit unterschiedlichstem Hintergrund willkommen heißt. |
|
||||
|
|
||||
## Erfinder - Betreuer |
|
||||
|
|
||||
Hey! 👋 |
|
||||
|
|
||||
Das bin ich: |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.maintainers %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Answers: {{ user.answers }}</div><div class="count">Pull Requests: {{ user.prs }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
Ich bin der Erfinder und Betreuer von **FastAPI**. Sie können mehr darüber in [FastAPI helfen – Hilfe erhalten – Mit dem Autor vernetzen](help-fastapi.md#mit-dem-autor-vernetzen){.internal-link target=_blank} erfahren. |
|
||||
|
|
||||
... Aber hier möchte ich Ihnen die Gemeinschaft vorstellen. |
|
||||
|
|
||||
--- |
|
||||
|
|
||||
**FastAPI** erhält eine Menge Unterstützung aus der Gemeinschaft. Und ich möchte ihre Beiträge hervorheben. |
|
||||
|
|
||||
Das sind die Menschen, die: |
|
||||
|
|
||||
* [Anderen bei Fragen auf GitHub helfen](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank}. |
|
||||
* [<abbr title='Pull Request – „Zieh-Anfrage“: Geänderten Quellcode senden, mit dem Vorschlag, ihn mit dem aktuellen Quellcode zu verschmelzen'>Pull Requests</abbr> erstellen](help-fastapi.md#einen-pull-request-erstellen){.internal-link target=_blank}. |
|
||||
* Pull Requests überprüfen (Review), [besonders wichtig für Übersetzungen](contributing.md#ubersetzungen){.internal-link target=_blank}. |
|
||||
|
|
||||
Eine Runde Applaus für sie. 👏 🙇 |
|
||||
|
|
||||
## Aktivste Benutzer im letzten Monat |
|
||||
|
|
||||
Hier die Benutzer, die im letzten Monat am meisten [anderen mit Fragen auf Github](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank} geholfen haben. ☕ |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.last_month_active %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Fragen beantwortet: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Experten |
|
||||
|
|
||||
Hier die **FastAPI-Experten**. 🤓 |
|
||||
|
|
||||
Das sind die Benutzer, die *insgesamt* [anderen am meisten mit Fragen auf GitHub geholfen haben](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank}. |
|
||||
|
|
||||
Sie haben bewiesen, dass sie Experten sind, weil sie vielen anderen geholfen haben. ✨ |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.experts %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Fragen beantwortet: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Top-Mitwirkende |
|
||||
|
|
||||
Hier sind die **Top-Mitwirkenden**. 👷 |
|
||||
|
|
||||
Diese Benutzer haben [die meisten Pull Requests erstellt](help-fastapi.md#einen-pull-request-erstellen){.internal-link target=_blank} welche *<abbr title="Mergen – Zusammenführen: Unterschiedliche Versionen eines Quellcodes zusammenführen">gemerged</abbr>* wurden. |
|
||||
|
|
||||
Sie haben Quellcode, Dokumentation, Übersetzungen, usw. beigesteuert. 📦 |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.top_contributors %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Pull Requests: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
Es gibt viele andere Mitwirkende (mehr als hundert), Sie können sie alle auf der <a href="https://github.com/tiangolo/fastapi/graphs/contributors" class="external-link" target="_blank">FastAPI GitHub Contributors-Seite</a> sehen. 👷 |
|
||||
|
|
||||
## Top-Rezensenten |
|
||||
|
|
||||
Diese Benutzer sind die **Top-Rezensenten**. 🕵️ |
|
||||
|
|
||||
### Rezensionen für Übersetzungen |
|
||||
|
|
||||
Ich spreche nur ein paar Sprachen (und nicht sehr gut 😅). Daher bestätigen Reviewer [**Übersetzungen der Dokumentation**](contributing.md#ubersetzungen){.internal-link target=_blank}. Ohne sie gäbe es keine Dokumentation in mehreren anderen Sprachen. |
|
||||
|
|
||||
--- |
|
||||
|
|
||||
Die **Top-Reviewer** 🕵️ haben die meisten Pull Requests von anderen überprüft und stellen die Qualität des Codes, der Dokumentation und insbesondere der **Übersetzungen** sicher. |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.top_reviewers %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Reviews: {{ user.count }}</div></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Sponsoren |
|
||||
|
|
||||
Dies sind die **Sponsoren**. 😎 |
|
||||
|
|
||||
Sie unterstützen meine Arbeit an **FastAPI** (und andere), hauptsächlich durch <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">GitHub-Sponsoren</a>. |
|
||||
|
|
||||
### Gold Sponsoren |
|
||||
|
|
||||
{% if sponsors %} |
|
||||
{% for sponsor in sponsors.gold -%} |
|
||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a> |
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
### Silber Sponsoren |
|
||||
|
|
||||
{% if sponsors %} |
|
||||
{% for sponsor in sponsors.silver -%} |
|
||||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a> |
|
||||
{% endfor %} |
|
||||
{% endif %} |
|
||||
|
|
||||
{% if people %} |
|
||||
{% if people.sponsors_50 %} |
|
||||
|
|
||||
### Bronze Sponsoren |
|
||||
|
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.sponsors_50 %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
|
|
||||
{% endif %} |
|
||||
{% endif %} |
|
||||
|
|
||||
### Individuelle Sponsoren |
|
||||
|
|
||||
{% if people %} |
|
||||
<div class="user-list user-list-center"> |
|
||||
{% for user in people.sponsors %} |
|
||||
|
|
||||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|
||||
{% endfor %} |
|
||||
|
|
||||
</div> |
|
||||
{% endif %} |
|
||||
|
|
||||
## Über diese Daten - technische Details |
|
||||
|
|
||||
Der Hauptzweck dieser Seite ist es zu zeigen, wie die Gemeinschaft anderen hilft. |
|
||||
|
|
||||
Das beinhaltet auch Hilfe, die normalerweise weniger sichtbar und in vielen Fällen mühsamer ist, wie, anderen bei Problemen zu helfen und Pull Requests mit Übersetzungen zu überprüfen. |
|
||||
|
|
||||
Diese Daten werden jeden Monat berechnet, Sie können den <a href="https://github.com/tiangolo/fastapi/blob/master/.github/actions/people/app/main.py" class="external-link" target="_blank">Quellcode hier lesen</a>. |
|
||||
|
|
||||
Hier weise ich auch auf Beiträge von Sponsoren hin. |
|
||||
|
|
||||
Ich behalte mir auch das Recht vor, den Algorithmus, die Abschnitte, die Schwellenwerte usw. zu aktualisieren (nur für den Fall 🤷). |
|
||||
@ -1,3 +0,0 @@ |
|||||
# Hilfe |
|
||||
|
|
||||
Helfen und Hilfe erhalten, beitragen, mitmachen. 🤝 |
|
||||
@ -1,5 +0,0 @@ |
|||||
# FastAPI und Freunde Newsletter |
|
||||
|
|
||||
<iframe data-w-type="embedded" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://xr4n4.mjt.lu/wgt/xr4n4/hj5/form?c=40a44fa4" width="100%" style="height: 0;"></iframe> |
|
||||
|
|
||||
<script type="text/javascript" src="https://app.mailjet.com/pas-nc-embedded-v1.js"></script> |
|
||||
@ -1,24 +0,0 @@ |
|||||
# `APIRouter`-Klasse |
|
||||
|
|
||||
Hier sind die Referenzinformationen für die Klasse `APIRouter` mit all ihren Parametern, Attributen und Methoden. |
|
||||
|
|
||||
Sie können die `APIRouter`-Klasse direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import APIRouter |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.APIRouter |
|
||||
options: |
|
||||
members: |
|
||||
- websocket |
|
||||
- include_router |
|
||||
- get |
|
||||
- put |
|
||||
- post |
|
||||
- delete |
|
||||
- options |
|
||||
- head |
|
||||
- patch |
|
||||
- trace |
|
||||
- on_event |
|
||||
@ -1,11 +0,0 @@ |
|||||
# Hintergrundtasks – `BackgroundTasks` |
|
||||
|
|
||||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeitsfunktion mit dem Typ `BackgroundTasks` deklarieren und diesen danach verwenden, um die Ausführung von Hintergrundtasks nach dem Senden der Response zu definieren. |
|
||||
|
|
||||
Sie können `BackgroundTasks` direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import BackgroundTasks |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.BackgroundTasks |
|
||||
@ -1,29 +0,0 @@ |
|||||
# Abhängigkeiten – `Depends()` und `Security()` |
|
||||
|
|
||||
## `Depends()` |
|
||||
|
|
||||
Abhängigkeiten werden hauptsächlich mit der speziellen Funktion `Depends()` behandelt, die ein Callable entgegennimmt. |
|
||||
|
|
||||
Hier finden Sie deren Referenz und Parameter. |
|
||||
|
|
||||
Sie können sie direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import Depends |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.Depends |
|
||||
|
|
||||
## `Security()` |
|
||||
|
|
||||
In vielen Szenarien können Sie die Sicherheit (Autorisierung, Authentifizierung usw.) mit Abhängigkeiten handhaben, indem Sie `Depends()` verwenden. |
|
||||
|
|
||||
Wenn Sie jedoch auch OAuth2-Scopes deklarieren möchten, können Sie `Security()` anstelle von `Depends()` verwenden. |
|
||||
|
|
||||
Sie können `Security()` direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import Security |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.Security |
|
||||
@ -1,3 +0,0 @@ |
|||||
# Encoder – `jsonable_encoder` |
|
||||
|
|
||||
::: fastapi.encoders.jsonable_encoder |
|
||||
@ -1,20 +0,0 @@ |
|||||
# Exceptions – `HTTPException` und `WebSocketException` |
|
||||
|
|
||||
Dies sind die <abbr title="Exception – Ausnahme, Fehler: Python-Objekt, das einen Fehler nebst Metadaten repräsentiert">Exceptions</abbr>, die Sie auslösen können, um dem Client Fehler zu berichten. |
|
||||
|
|
||||
Wenn Sie eine Exception auslösen, wird, wie es bei normalem Python der Fall wäre, der Rest der Ausführung abgebrochen. Auf diese Weise können Sie diese Exceptions von überall im Code werfen, um einen Request abzubrechen und den Fehler dem Client anzuzeigen. |
|
||||
|
|
||||
Sie können Folgendes verwenden: |
|
||||
|
|
||||
* `HTTPException` |
|
||||
* `WebSocketException` |
|
||||
|
|
||||
Diese Exceptions können direkt von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import HTTPException, WebSocketException |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.HTTPException |
|
||||
|
|
||||
::: fastapi.WebSocketException |
|
||||
@ -1,31 +0,0 @@ |
|||||
# `FastAPI`-Klasse |
|
||||
|
|
||||
Hier sind die Referenzinformationen für die Klasse `FastAPI` mit all ihren Parametern, Attributen und Methoden. |
|
||||
|
|
||||
Sie können die `FastAPI`-Klasse direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import FastAPI |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.FastAPI |
|
||||
options: |
|
||||
members: |
|
||||
- openapi_version |
|
||||
- webhooks |
|
||||
- state |
|
||||
- dependency_overrides |
|
||||
- openapi |
|
||||
- websocket |
|
||||
- include_router |
|
||||
- get |
|
||||
- put |
|
||||
- post |
|
||||
- delete |
|
||||
- options |
|
||||
- head |
|
||||
- patch |
|
||||
- trace |
|
||||
- on_event |
|
||||
- middleware |
|
||||
- exception_handler |
|
||||
@ -1,11 +0,0 @@ |
|||||
# `HTTPConnection`-Klasse |
|
||||
|
|
||||
Wenn Sie Abhängigkeiten definieren möchten, die sowohl mit HTTP als auch mit WebSockets kompatibel sein sollen, können Sie einen Parameter definieren, der eine `HTTPConnection` anstelle eines `Request` oder eines `WebSocket` akzeptiert. |
|
||||
|
|
||||
Sie können diese von `fastapi.requests` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.requests import HTTPConnection |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.requests.HTTPConnection |
|
||||
@ -1,8 +0,0 @@ |
|||||
# Referenz – Code-API |
|
||||
|
|
||||
Hier ist die Referenz oder Code-API, die Klassen, Funktionen, Parameter, Attribute und alle FastAPI-Teile, die Sie in Ihren Anwendungen verwenden können. |
|
||||
|
|
||||
Wenn Sie **FastAPI** lernen möchten, ist es viel besser, das [FastAPI-Tutorial](https://fastapi.tiangolo.com/tutorial/) zu lesen. |
|
||||
|
|
||||
!!! note "Hinweis Deutsche Übersetzung" |
|
||||
Die nachfolgende API wird aus der Quelltext-Dokumentation erstellt, daher sind nur die Einleitungen auf Deutsch. |
|
||||
@ -1,45 +0,0 @@ |
|||||
# Middleware |
|
||||
|
|
||||
Es gibt mehrere Middlewares, die direkt von Starlette bereitgestellt werden. |
|
||||
|
|
||||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation über Middleware](../advanced/middleware.md). |
|
||||
|
|
||||
::: fastapi.middleware.cors.CORSMiddleware |
|
||||
|
|
||||
Kann von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.middleware.cors import CORSMiddleware |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.middleware.gzip.GZipMiddleware |
|
||||
|
|
||||
Kann von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.middleware.gzip import GZipMiddleware |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.middleware.httpsredirect.HTTPSRedirectMiddleware |
|
||||
|
|
||||
Kann von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.middleware.trustedhost.TrustedHostMiddleware |
|
||||
|
|
||||
Kann von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.middleware.trustedhost import TrustedHostMiddleware |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.middleware.wsgi.WSGIMiddleware |
|
||||
|
|
||||
Kann von `fastapi` importiert werden: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.middleware.wsgi import WSGIMiddleware |
|
||||
``` |
|
||||
@ -1,11 +0,0 @@ |
|||||
# OpenAPI `docs` |
|
||||
|
|
||||
Werkzeuge zur Verwaltung der automatischen OpenAPI-UI-Dokumentation, einschließlich Swagger UI (standardmäßig unter `/docs`) und ReDoc (standardmäßig unter `/redoc`). |
|
||||
|
|
||||
::: fastapi.openapi.docs.get_swagger_ui_html |
|
||||
|
|
||||
::: fastapi.openapi.docs.get_redoc_html |
|
||||
|
|
||||
::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html |
|
||||
|
|
||||
::: fastapi.openapi.docs.swagger_ui_default_parameters |
|
||||
@ -1,5 +0,0 @@ |
|||||
# OpenAPI |
|
||||
|
|
||||
Es gibt mehrere Werkzeuge zur Handhabung von OpenAPI. |
|
||||
|
|
||||
Normalerweise müssen Sie diese nicht verwenden, es sei denn, Sie haben einen bestimmten fortgeschrittenen Anwendungsfall, welcher das erfordert. |
|
||||
@ -1,5 +0,0 @@ |
|||||
# OpenAPI-`models` |
|
||||
|
|
||||
OpenAPI Pydantic-Modelle, werden zum Generieren und Validieren der generierten OpenAPI verwendet. |
|
||||
|
|
||||
::: fastapi.openapi.models |
|
||||
@ -1,35 +0,0 @@ |
|||||
# Request-Parameter |
|
||||
|
|
||||
Hier die Referenzinformationen für die Request-Parameter. |
|
||||
|
|
||||
Dies sind die Sonderfunktionen, die Sie mittels `Annotated` in *Pfadoperation-Funktion*-Parameter oder Abhängigkeitsfunktionen einfügen können, um Daten aus dem Request abzurufen. |
|
||||
|
|
||||
Dies beinhaltet: |
|
||||
|
|
||||
* `Query()` |
|
||||
* `Path()` |
|
||||
* `Body()` |
|
||||
* `Cookie()` |
|
||||
* `Header()` |
|
||||
* `Form()` |
|
||||
* `File()` |
|
||||
|
|
||||
Sie können diese alle direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import Body, Cookie, File, Form, Header, Path, Query |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.Query |
|
||||
|
|
||||
::: fastapi.Path |
|
||||
|
|
||||
::: fastapi.Body |
|
||||
|
|
||||
::: fastapi.Cookie |
|
||||
|
|
||||
::: fastapi.Header |
|
||||
|
|
||||
::: fastapi.Form |
|
||||
|
|
||||
::: fastapi.File |
|
||||
@ -1,14 +0,0 @@ |
|||||
# `Request`-Klasse |
|
||||
|
|
||||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeit als vom Typ `Request` deklarieren und dann direkt auf das Requestobjekt zugreifen, ohne jegliche Validierung, usw. |
|
||||
|
|
||||
Sie können es direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import Request |
|
||||
``` |
|
||||
|
|
||||
!!! tip "Tipp" |
|
||||
Wenn Sie Abhängigkeiten definieren möchten, die sowohl mit HTTP als auch mit WebSockets kompatibel sein sollen, können Sie einen Parameter definieren, der eine `HTTPConnection` anstelle eines `Request` oder eines `WebSocket` akzeptiert. |
|
||||
|
|
||||
::: fastapi.Request |
|
||||
@ -1,13 +0,0 @@ |
|||||
# `Response`-Klasse |
|
||||
|
|
||||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeit als `Response` deklarieren und dann Daten für die Response wie Header oder Cookies festlegen. |
|
||||
|
|
||||
Diese können Sie auch direkt verwenden, um eine Instanz davon zu erstellen und diese von Ihren *Pfadoperationen* zurückzugeben. |
|
||||
|
|
||||
Sie können sie direkt von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import Response |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.Response |
|
||||
@ -1,164 +0,0 @@ |
|||||
# Benutzerdefinierte Responseklassen – File, HTML, Redirect, Streaming, usw. |
|
||||
|
|
||||
Es gibt mehrere benutzerdefinierte Responseklassen, von denen Sie eine Instanz erstellen und diese direkt von Ihren *Pfadoperationen* zurückgeben können. |
|
||||
|
|
||||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu benutzerdefinierten Responses – HTML, Stream, Datei, andere](../advanced/custom-response.md). |
|
||||
|
|
||||
Sie können diese direkt von `fastapi.responses` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.responses import ( |
|
||||
FileResponse, |
|
||||
HTMLResponse, |
|
||||
JSONResponse, |
|
||||
ORJSONResponse, |
|
||||
PlainTextResponse, |
|
||||
RedirectResponse, |
|
||||
Response, |
|
||||
StreamingResponse, |
|
||||
UJSONResponse, |
|
||||
) |
|
||||
``` |
|
||||
|
|
||||
## FastAPI-Responses |
|
||||
|
|
||||
Es gibt einige benutzerdefinierte FastAPI-Responseklassen, welche Sie verwenden können, um die JSON-Performanz zu optimieren. |
|
||||
|
|
||||
::: fastapi.responses.UJSONResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.ORJSONResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
## Starlette-Responses |
|
||||
|
|
||||
::: fastapi.responses.FileResponse |
|
||||
options: |
|
||||
members: |
|
||||
- chunk_size |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.HTMLResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.JSONResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.PlainTextResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.RedirectResponse |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.Response |
|
||||
options: |
|
||||
members: |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
|
|
||||
::: fastapi.responses.StreamingResponse |
|
||||
options: |
|
||||
members: |
|
||||
- body_iterator |
|
||||
- charset |
|
||||
- status_code |
|
||||
- media_type |
|
||||
- body |
|
||||
- background |
|
||||
- raw_headers |
|
||||
- render |
|
||||
- init_headers |
|
||||
- headers |
|
||||
- set_cookie |
|
||||
- delete_cookie |
|
||||
@ -1,73 +0,0 @@ |
|||||
# Sicherheitstools |
|
||||
|
|
||||
Wenn Sie Abhängigkeiten mit OAuth2-Scopes deklarieren müssen, verwenden Sie `Security()`. |
|
||||
|
|
||||
Aber Sie müssen immer noch definieren, was das <abbr title="Das von dem abhängt, die zu verwendende Abhängigkeit">Dependable</abbr>, das Callable ist, welches Sie als Parameter an `Depends()` oder `Security()` übergeben. |
|
||||
|
|
||||
Es gibt mehrere Tools, mit denen Sie diese Dependables erstellen können, und sie werden in OpenAPI integriert, sodass sie in der Oberfläche der automatischen Dokumentation angezeigt werden und von automatisch generierten Clients und SDKs, usw., verwendet werden können. |
|
||||
|
|
||||
Sie können sie von `fastapi.security` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.security import ( |
|
||||
APIKeyCookie, |
|
||||
APIKeyHeader, |
|
||||
APIKeyQuery, |
|
||||
HTTPAuthorizationCredentials, |
|
||||
HTTPBasic, |
|
||||
HTTPBasicCredentials, |
|
||||
HTTPBearer, |
|
||||
HTTPDigest, |
|
||||
OAuth2, |
|
||||
OAuth2AuthorizationCodeBearer, |
|
||||
OAuth2PasswordBearer, |
|
||||
OAuth2PasswordRequestForm, |
|
||||
OAuth2PasswordRequestFormStrict, |
|
||||
OpenIdConnect, |
|
||||
SecurityScopes, |
|
||||
) |
|
||||
``` |
|
||||
|
|
||||
## API-Schlüssel-Sicherheitsschemas |
|
||||
|
|
||||
::: fastapi.security.APIKeyCookie |
|
||||
|
|
||||
::: fastapi.security.APIKeyHeader |
|
||||
|
|
||||
::: fastapi.security.APIKeyQuery |
|
||||
|
|
||||
## HTTP-Authentifizierungsschemas |
|
||||
|
|
||||
::: fastapi.security.HTTPBasic |
|
||||
|
|
||||
::: fastapi.security.HTTPBearer |
|
||||
|
|
||||
::: fastapi.security.HTTPDigest |
|
||||
|
|
||||
## HTTP-Anmeldeinformationen |
|
||||
|
|
||||
::: fastapi.security.HTTPAuthorizationCredentials |
|
||||
|
|
||||
::: fastapi.security.HTTPBasicCredentials |
|
||||
|
|
||||
## OAuth2-Authentifizierung |
|
||||
|
|
||||
::: fastapi.security.OAuth2 |
|
||||
|
|
||||
::: fastapi.security.OAuth2AuthorizationCodeBearer |
|
||||
|
|
||||
::: fastapi.security.OAuth2PasswordBearer |
|
||||
|
|
||||
## OAuth2-Passwortformulare |
|
||||
|
|
||||
::: fastapi.security.OAuth2PasswordRequestForm |
|
||||
|
|
||||
::: fastapi.security.OAuth2PasswordRequestFormStrict |
|
||||
|
|
||||
## OAuth2-Sicherheitsscopes in Abhängigkeiten |
|
||||
|
|
||||
::: fastapi.security.SecurityScopes |
|
||||
|
|
||||
## OpenID Connect |
|
||||
|
|
||||
::: fastapi.security.OpenIdConnect |
|
||||
@ -1,13 +0,0 @@ |
|||||
# Statische Dateien – `StaticFiles` |
|
||||
|
|
||||
Sie können die `StaticFiles`-Klasse verwenden, um statische Dateien wie JavaScript, CSS, Bilder, usw. bereitzustellen. |
|
||||
|
|
||||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu statischen Dateien](../tutorial/static-files.md). |
|
||||
|
|
||||
Sie können sie direkt von `fastapi.staticfiles` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.staticfiles import StaticFiles |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.staticfiles.StaticFiles |
|
||||
@ -1,36 +0,0 @@ |
|||||
# Statuscodes |
|
||||
|
|
||||
Sie können das Modul `status` von `fastapi` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi import status |
|
||||
``` |
|
||||
|
|
||||
`status` wird direkt von Starlette bereitgestellt. |
|
||||
|
|
||||
Es enthält eine Gruppe benannter Konstanten (Variablen) mit ganzzahligen Statuscodes. |
|
||||
|
|
||||
Zum Beispiel: |
|
||||
|
|
||||
* 200: `status.HTTP_200_OK` |
|
||||
* 403: `status.HTTP_403_FORBIDDEN` |
|
||||
* usw. |
|
||||
|
|
||||
Es kann praktisch sein, schnell auf HTTP- (und WebSocket-)Statuscodes in Ihrer Anwendung zuzugreifen, indem Sie die automatische Vervollständigung für den Namen verwenden, ohne sich die Zahlen für die Statuscodes merken zu müssen. |
|
||||
|
|
||||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu Response-Statuscodes](../tutorial/response-status-code.md). |
|
||||
|
|
||||
## Beispiel |
|
||||
|
|
||||
```python |
|
||||
from fastapi import FastAPI, status |
|
||||
|
|
||||
app = FastAPI() |
|
||||
|
|
||||
|
|
||||
@app.get("/items/", status_code=status.HTTP_418_IM_A_TEAPOT) |
|
||||
def read_items(): |
|
||||
return [{"name": "Plumbus"}, {"name": "Portal Gun"}] |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.status |
|
||||
@ -1,13 +0,0 @@ |
|||||
# Templating – `Jinja2Templates` |
|
||||
|
|
||||
Sie können die `Jinja2Templates`-Klasse verwenden, um Jinja-Templates zu rendern. |
|
||||
|
|
||||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu Templates](../advanced/templates.md). |
|
||||
|
|
||||
Sie können die Klasse direkt von `fastapi.templating` importieren: |
|
||||
|
|
||||
```python |
|
||||
from fastapi.templating import Jinja2Templates |
|
||||
``` |
|
||||
|
|
||||
::: fastapi.templating.Jinja2Templates |
|
||||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue