pre-commit-ci-lite[bot]
4 months ago
committed by
GitHub
GitHub
41 changed files with 59 additions and 1516 deletions
@ -1,261 +0,0 @@ |
|||
# ترقی - تعاون |
|||
|
|||
پہلے، آپ [FastAPI کی مدد کریں اور مدد حاصل کریں](help-fastapi.md) کے بنیادی طریقے دیکھنا چاہیں گے۔ |
|||
|
|||
## ترقی |
|||
|
|||
اگر آپ نے پہلے ہی [fastapi repository](https://github.com/fastapi/fastapi) clone کر لیا ہے اور code میں گہرائی سے جانا چاہتے ہیں، تو یہاں آپ کا ماحول ترتیب دینے کی کچھ ہدایات ہیں۔ |
|||
|
|||
### ضروریات install کریں |
|||
|
|||
Virtual environment بنائیں اور [`uv`](https://github.com/astral-sh/uv) کے ساتھ درکار packages install کریں: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uv sync --extra all |
|||
|
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
یہ تمام dependencies اور آپ کا مقامی FastAPI آپ کے مقامی ماحول میں install کر دے گا۔ |
|||
|
|||
### اپنا مقامی FastAPI استعمال کریں |
|||
|
|||
اگر آپ ایک Python فائل بناتے ہیں جو FastAPI import اور استعمال کرتی ہے، اور اسے اپنے مقامی ماحول کے Python سے چلاتے ہیں، تو یہ آپ کا clone شدہ مقامی FastAPI source code استعمال کرے گا۔ |
|||
|
|||
اور اگر آپ اس مقامی FastAPI source code کو اپڈیٹ کرتے ہیں تو جب آپ وہ Python فائل دوبارہ چلائیں گے، یہ FastAPI کا وہ تازہ ورژن استعمال کرے گا جو آپ نے ابھی ترمیم کیا ہے۔ |
|||
|
|||
اس طرح، ہر تبدیلی ٹیسٹ کرنے کے لیے آپ کو اپنا مقامی ورژن "install" نہیں کرنا پڑتا۔ |
|||
|
|||
/// note | تکنیکی تفصیلات |
|||
|
|||
یہ صرف تب ہوتا ہے جب آپ `pip install fastapi` براہ راست چلانے کی بجائے `uv sync --extra all` استعمال کرکے install کرتے ہیں۔ |
|||
|
|||
اس کی وجہ یہ ہے کہ `uv sync --extra all` بطور default FastAPI کا مقامی ورژن "editable" mode میں install کرتا ہے۔ |
|||
|
|||
/// |
|||
|
|||
### Code فارمیٹ کریں |
|||
|
|||
ایک script ہے جسے آپ چلا سکتے ہیں جو آپ کا سارا code فارمیٹ اور صاف کر دے گی: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ bash scripts/format.sh |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
یہ آپ کے تمام imports کو بھی خودکار طریقے سے ترتیب دے گی۔ |
|||
|
|||
## Tests |
|||
|
|||
ایک script ہے جسے آپ مقامی طور پر تمام code ٹیسٹ کرنے اور HTML میں coverage reports بنانے کے لیے چلا سکتے ہیں: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ bash scripts/test-cov-html.sh |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
یہ command `./htmlcov/` directory بناتی ہے، اگر آپ `./htmlcov/index.html` فائل اپنے browser میں کھولیں، تو آپ انٹرایکٹو طریقے سے دیکھ سکتے ہیں کہ code کے کون سے حصے tests سے cover ہیں، اور کوئی حصہ رہ تو نہیں گیا۔ |
|||
|
|||
## Docs |
|||
|
|||
پہلے، یقینی بنائیں کہ آپ نے اوپر بیان کردہ طریقے سے اپنا ماحول ترتیب دیا ہے، جو تمام ضروریات install کر دے گا۔ |
|||
|
|||
### Docs لائیو |
|||
|
|||
مقامی ترقی کے دوران، ایک script ہے جو سائٹ بناتی ہے اور کسی بھی تبدیلی کو چیک کرتی ہے، لائیو ری لوڈنگ کے ساتھ: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ python ./scripts/docs.py live |
|||
|
|||
<span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008 |
|||
<span style="color: green;">[INFO]</span> Start watching changes |
|||
<span style="color: green;">[INFO]</span> Start detecting changes |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
یہ documentation کو `http://127.0.0.1:8008` پر serve کرے گا۔ |
|||
|
|||
اس طرح، آپ documentation/source فائلوں میں ترمیم کر سکتے ہیں اور تبدیلیاں لائیو دیکھ سکتے ہیں۔ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
متبادل طور پر، آپ وہی اقدامات خود دستی طور پر کر سکتے ہیں جو script کرتی ہے۔ |
|||
|
|||
زبان کی directory میں جائیں، بنیادی docs کے لیے انگریزی میں یہ `docs/en/` پر ہے: |
|||
|
|||
```console |
|||
$ cd docs/en/ |
|||
``` |
|||
|
|||
پھر اس directory میں `mkdocs` چلائیں: |
|||
|
|||
```console |
|||
$ mkdocs serve --dev-addr 127.0.0.1:8008 |
|||
``` |
|||
|
|||
/// |
|||
|
|||
#### Typer CLI (اختیاری) |
|||
|
|||
یہاں ہدایات آپ کو دکھاتی ہیں کہ `./scripts/docs.py` script کو `python` program کے ساتھ براہ راست کیسے استعمال کریں۔ |
|||
|
|||
لیکن آپ [Typer CLI](https://typer.tiangolo.com/typer-cli/) بھی استعمال کر سکتے ہیں، اور completion install کرنے کے بعد آپ کو اپنے terminal میں commands کے لیے autocompletion ملے گی۔ |
|||
|
|||
اگر آپ Typer CLI install کرتے ہیں، تو آپ اس کے ساتھ completion install کر سکتے ہیں: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ typer --install-completion |
|||
|
|||
zsh completion installed in /home/user/.bashrc. |
|||
Completion will take effect once you restart the terminal. |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
### Docs کی ساخت |
|||
|
|||
Documentation [MkDocs](https://www.mkdocs.org/) استعمال کرتی ہے۔ |
|||
|
|||
اور `./scripts/docs.py` میں تراجم کو سنبھالنے کے لیے اضافی tools/scripts موجود ہیں۔ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
آپ کو `./scripts/docs.py` کا code دیکھنے کی ضرورت نہیں، آپ بس اسے command line میں استعمال کرتے ہیں۔ |
|||
|
|||
/// |
|||
|
|||
تمام documentation `./docs/en/` directory میں Markdown فارمیٹ میں ہے۔ |
|||
|
|||
بہت سے tutorials میں code blocks ہوتے ہیں۔ |
|||
|
|||
زیادہ تر معاملات میں، یہ code blocks مکمل applications ہیں جو جیسے ہیں ویسے چلائی جا سکتی ہیں۔ |
|||
|
|||
درحقیقت، وہ code blocks Markdown کے اندر نہیں لکھے جاتے، بلکہ `./docs_src/` directory میں Python فائلیں ہیں۔ |
|||
|
|||
اور وہ Python فائلیں سائٹ generate کرتے وقت documentation میں شامل/inject کی جاتی ہیں۔ |
|||
|
|||
### Tests کے لیے Docs |
|||
|
|||
زیادہ تر tests دراصل documentation میں موجود مثالی source فائلوں کے خلاف چلتے ہیں۔ |
|||
|
|||
اس سے یہ یقینی بنانے میں مدد ملتی ہے کہ: |
|||
|
|||
* Documentation تازہ ترین ہے۔ |
|||
* Documentation کی مثالیں جیسی ہیں ویسی چلائی جا سکتی ہیں۔ |
|||
* زیادہ تر features documentation سے cover ہیں، test coverage سے یقینی بنائی گئی ہیں۔ |
|||
|
|||
#### Apps اور docs بیک وقت |
|||
|
|||
اگر آپ مثالیں چلاتے ہیں، جیسے: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ fastapi dev tutorial001.py |
|||
|
|||
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
چونکہ Uvicorn بطور default port `8000` استعمال کرتا ہے، port `8008` پر documentation اس سے نہیں ٹکرائے گی۔ |
|||
|
|||
### تراجم |
|||
|
|||
تراجم میں مدد بہت زیادہ قدر کی جاتی ہے! اور یہ کمیونٹی کی مدد کے بغیر نہیں ہو سکتا۔ 🌎 🚀 |
|||
|
|||
ترجمے کی pull requests FastAPI ٹیم کی طرف سے ڈیزائن کردہ prompts سے رہنمائی حاصل کرنے والے LLMs اور ہر supported زبان کے لیے مقامی بولنے والوں کی کمیونٹی کے ساتھ مل کر بنائی جاتی ہیں۔ |
|||
|
|||
#### فی زبان LLM Prompt |
|||
|
|||
ہر زبان کی ایک directory ہے: [https://github.com/fastapi/fastapi/tree/master/docs](https://github.com/fastapi/fastapi/tree/master/docs)، اس میں آپ `llm-prompt.md` فائل دیکھ سکتے ہیں جس میں اس زبان کے لیے مخصوص prompt ہے۔ |
|||
|
|||
مثال کے طور پر، ہسپانوی کے لیے prompt یہاں ہے: [`docs/es/llm-prompt.md`](https://github.com/fastapi/fastapi/blob/master/docs/es/llm-prompt.md)۔ |
|||
|
|||
اگر آپ کو اپنی زبان میں غلطیاں نظر آئیں، تو آپ اپنی زبان کی فائل میں prompt کے لیے تجاویز دے سکتے ہیں، اور تبدیلیوں کے بعد ان مخصوص pages کی دوبارہ تخلیق کی درخواست کر سکتے ہیں۔ |
|||
|
|||
#### ترجمے کی PRs کا Review |
|||
|
|||
آپ اپنی زبان کے لیے موجودہ [pull requests](https://github.com/fastapi/fastapi/pulls) بھی چیک کر سکتے ہیں۔ آپ اپنی زبان کے label کے ساتھ pull requests فلٹر کر سکتے ہیں۔ مثال کے طور پر، ہسپانوی کے لیے label [`lang-es`](https://github.com/fastapi/fastapi/pulls?q=is%3Aopen+sort%3Aupdated-desc+label%3Alang-es+label%3Aawaiting-review) ہے۔ |
|||
|
|||
Pull request کا review کرتے وقت، بہتر ہے کہ اسی pull request میں تبدیلیاں تجویز نہ کریں، کیونکہ یہ LLM سے generate کیا گیا ہے، اور یہ یقینی بنانا ممکن نہیں ہوگا کہ چھوٹی انفرادی تبدیلیاں دوسرے ملتے جلتے حصوں میں نقل ہوں، یا وہی مواد دوبارہ ترجمہ کرتے وقت محفوظ رہیں۔ |
|||
|
|||
ترجمے کی PR میں تجاویز شامل کرنے کی بجائے، اس زبان کی LLM prompt فائل میں تجاویز دیں، ایک نئی PR میں۔ مثال کے طور پر، ہسپانوی کی LLM prompt فائل یہاں ہے: [`docs/es/llm-prompt.md`](https://github.com/fastapi/fastapi/blob/master/docs/es/llm-prompt.md)۔ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
[Pull request review شامل کرنے](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews) کے بارے میں docs چیک کریں تاکہ اسے منظور یا تبدیلیوں کی درخواست کر سکیں۔ |
|||
|
|||
/// |
|||
|
|||
#### اپنی زبان کے لیے Notifications سبسکرائب کریں |
|||
|
|||
چیک کریں کہ آیا آپ کی زبان کے تراجم کی coordination کے لیے [GitHub Discussion](https://github.com/fastapi/fastapi/discussions/categories/translations) ہے۔ آپ اسے سبسکرائب کر سکتے ہیں، اور جب review کے لیے نئی pull request ہوگی، discussion میں خودکار تبصرہ شامل کیا جائے گا۔ |
|||
|
|||
آپ جس زبان کا ترجمہ کرنا چاہتے ہیں اس کا 2 حرفی code جاننے کے لیے [List of ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) کا جدول استعمال کر سکتے ہیں۔ |
|||
|
|||
#### نئی زبان کی درخواست |
|||
|
|||
فرض کریں کہ آپ ایسی زبان کے تراجم کی درخواست کرنا چاہتے ہیں جس کا ابھی تک ترجمہ نہیں ہوا، کوئی page بھی نہیں۔ مثال کے طور پر، لاطینی۔ |
|||
|
|||
* پہلا قدم یہ ہوگا کہ آپ 2 اور لوگ تلاش کریں جو آپ کے ساتھ اس زبان کے لیے ترجمے کی PRs کا review کرنے کو تیار ہوں۔ |
|||
* جب کم از کم 3 لوگ اس زبان کی دیکھ بھال میں مدد کا عہد کرنے کو تیار ہوں، تو آپ اگلے اقدامات جاری رکھ سکتے ہیں۔ |
|||
* Template کے مطابق نئی discussion بنائیں۔ |
|||
* اپنے ساتھ مدد کرنے والے 2 دوسرے لوگوں کو tag کریں، اور ان سے وہاں تصدیق کرنے کو کہیں کہ وہ مدد کریں گے۔ |
|||
|
|||
جب discussion میں کئی لوگ ہوں، FastAPI ٹیم اس کا جائزہ لے سکتی ہے اور اسے سرکاری ترجمہ بنا سکتی ہے۔ |
|||
|
|||
پھر docs خودکار طور پر LLMs کے ذریعے ترجمہ ہوں گے، اور مقامی بولنے والوں کی ٹیم ترجمے کا review کر سکتی ہے، اور LLM prompts کو بہتر بنانے میں مدد کر سکتی ہے۔ |
|||
|
|||
جب نیا ترجمہ ہوگا، مثال کے طور پر اگر docs اپڈیٹ ہوں یا نیا سیکشن ہو، تو اسی discussion میں review کے لیے نئے ترجمے کے link کے ساتھ تبصرہ آئے گا۔ |
|||
|
|||
## خودکار Code اور AI |
|||
|
|||
آپ کو ہر وہ tool استعمال کرنے کی ترغیب دی جاتی ہے جو آپ چاہیں تاکہ اپنا کام کریں اور جتنا ہو سکے مؤثر طریقے سے تعاون کریں، بشمول AI (LLM) tools وغیرہ۔ تاہم، تعاون میں بامعنی انسانی مداخلت، فیصلے، سیاق و سباق وغیرہ ہونا چاہیے۔ |
|||
|
|||
اگر PR میں لگائی گئی **انسانی محنت**، جیسے LLM prompts لکھنا، اس **محنت سے کم** ہے جو ہمیں اسے **review** کرنے میں لگانی ہوگی، تو براہ کرم PR **جمع نہ کریں**۔ |
|||
|
|||
اس طرح سوچیں: ہم خود LLM prompts لکھ سکتے ہیں یا خودکار tools چلا سکتے ہیں، اور یہ بیرونی PRs کا review کرنے سے تیز ہوگا۔ |
|||
|
|||
### خودکار اور AI PRs بند کرنا |
|||
|
|||
اگر ہمیں ایسی PRs نظر آئیں جو AI سے generate کی گئی یا اسی طرح خودکار لگتی ہیں، تو ہم انہیں flag کرکے بند کر دیں گے۔ |
|||
|
|||
یہی تبصروں اور تفصیلات پر بھی لاگو ہوتا ہے، براہ کرم LLM سے generate کیا گیا مواد copy paste نہ کریں۔ |
|||
|
|||
### انسانی محنت پر Denial of Service |
|||
|
|||
خودکار tools اور AI کا استعمال کرکے ایسی PRs یا تبصرے جمع کرنا جنہیں ہمیں احتیاط سے review اور سنبھالنا ہو، ہماری انسانی محنت پر [Denial-of-service attack](https://en.wikipedia.org/wiki/Denial-of-service_attack) کے مترادف ہوگا۔ |
|||
|
|||
PR جمع کرنے والے شخص کی طرف سے بہت کم محنت (ایک LLM prompt) ہماری طرف سے بڑی مقدار میں محنت (احتیاط سے code کا review) پیدا کرتی ہے۔ |
|||
|
|||
براہ کرم ایسا نہ کریں۔ |
|||
|
|||
ہمیں بار بار خودکار PRs یا تبصروں سے spam کرنے والے اکاؤنٹس کو block کرنا ہوگا۔ |
|||
|
|||
### Tools سمجھداری سے استعمال کریں |
|||
|
|||
جیسا کہ Uncle Ben نے کہا: |
|||
|
|||
<blockquote> |
|||
بڑی <strike>طاقت</strike> <strong>tools</strong> کے ساتھ بڑی ذمہ داری آتی ہے۔ |
|||
</blockquote> |
|||
|
|||
نادانستہ طور پر نقصان پہنچانے سے بچیں۔ |
|||
|
|||
آپ کے پاس حیرت انگیز tools ہیں، انہیں سمجھداری سے مؤثر طریقے سے مدد کرنے کے لیے استعمال کریں۔ |
|||
@ -1,25 +0,0 @@ |
|||
# بیرونی لنکس |
|||
|
|||
**FastAPI** کی ایک شاندار کمیونٹی ہے جو مسلسل بڑھ رہی ہے۔ |
|||
|
|||
**FastAPI** سے متعلق بہت سے مضامین، مقالات، tools، اور projects ہیں۔ |
|||
|
|||
آپ آسانی سے search engine یا video platform استعمال کرکے FastAPI سے متعلق بہت سے وسائل تلاش کر سکتے ہیں۔ |
|||
|
|||
/// info | معلومات |
|||
|
|||
پہلے، اس صفحے پر بیرونی مضامین کے لنکس درج کیے جاتے تھے۔ |
|||
|
|||
لیکن اب جب FastAPI تمام زبانوں میں سب سے زیادہ GitHub stars والا backend framework ہے، اور Python میں سب سے زیادہ starred اور استعمال ہونے والا framework ہے، تو اس کے بارے میں لکھے گئے تمام مضامین درج کرنے کی کوشش کرنا اب مناسب نہیں رہا۔ |
|||
|
|||
/// |
|||
|
|||
## GitHub Repositories |
|||
|
|||
سب سے زیادہ starred [`fastapi` topic والی GitHub repositories](https://github.com/topics/fastapi): |
|||
|
|||
{% for repo in topic_repos %} |
|||
|
|||
<a href={{repo.html_url}} target="_blank">★ {{repo.stars}} - {{repo.name}}</a> by <a href={{repo.owner_html_url}} target="_blank">@{{repo.owner_login}}</a>. |
|||
|
|||
{% endfor %} |
|||
@ -1,285 +0,0 @@ |
|||
--- |
|||
hide: |
|||
- navigation |
|||
--- |
|||
|
|||
# FastAPI کے لوگ |
|||
|
|||
FastAPI کی ایک حیرت انگیز کمیونٹی ہے جو ہر پس منظر سے لوگوں کا خیرمقدم کرتی ہے۔ |
|||
|
|||
## بانی |
|||
|
|||
ارے! 👋 |
|||
|
|||
یہ میں ہوں: |
|||
|
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.maintainers %} |
|||
|
|||
<div class="user"><a href="{{ contributors.tiangolo.url }}"><div class="avatar-wrapper"><img src="{{ contributors.tiangolo.avatarUrl }}"/></div><div class="title">@{{ contributors.tiangolo.login }}</div></a> <div class="count">Answers: {{ user.answers }}</div><div class="count">Pull Requests: {{ contributors.tiangolo.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
میں **FastAPI** کا بانی ہوں۔ آپ اس کے بارے میں مزید [FastAPI کی مدد کریں - مدد حاصل کریں - مصنف سے جڑیں](help-fastapi.md#connect-with-the-author) میں پڑھ سکتے ہیں۔ |
|||
|
|||
...لیکن یہاں میں آپ کو کمیونٹی دکھانا چاہتا ہوں۔ |
|||
|
|||
--- |
|||
|
|||
**FastAPI** کو کمیونٹی سے بہت زیادہ حمایت ملتی ہے۔ اور میں ان کے تعاون کو نمایاں کرنا چاہتا ہوں۔ |
|||
|
|||
یہ وہ لوگ ہیں جو: |
|||
|
|||
* [GitHub میں سوالات کے ساتھ دوسروں کی مدد کرتے ہیں](help-fastapi.md#help-others-with-questions-in-github)۔ |
|||
* [Pull Requests بناتے ہیں](help-fastapi.md#create-a-pull-request)۔ |
|||
* Pull Requests کا Review کرتے ہیں، [خاص طور پر تراجم کے لیے اہم](contributing.md#translations)۔ |
|||
* [Repository منظم](management-tasks.md) کرنے میں مدد کرتے ہیں (ٹیم ممبران)۔ |
|||
|
|||
یہ سب کام repository کو برقرار رکھنے میں مدد کرتے ہیں۔ |
|||
|
|||
ان کے لیے تالیاں۔ 👏 🙇 |
|||
|
|||
## ٹیم |
|||
|
|||
یہ موجودہ ٹیم ممبران کی فہرست ہے۔ 😎 |
|||
|
|||
ان کی شمولیت اور اجازتوں کی مختلف سطحیں ہیں، وہ [repository management tasks](./management-tasks.md) انجام دے سکتے ہیں اور مل کر ہم [FastAPI repository کو منظم کرتے ہیں](./management.md)۔ |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in members["members"] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatar_url }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
حالانکہ ٹیم ممبران کے پاس خصوصی کام انجام دینے کی اجازتیں ہیں، [FastAPI کو برقرار رکھنے میں دوسروں کی ہر مدد](./help-fastapi.md#help-maintain-fastapi) کی بہت قدر کی جاتی ہے! 🙇♂️ |
|||
|
|||
## FastAPI Experts |
|||
|
|||
یہ وہ صارفین ہیں جو [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کرتے رہے ہیں۔ 🙇 |
|||
|
|||
انہوں نے بہت سے دوسروں کی مدد کرکے ثابت کیا ہے کہ وہ **FastAPI Experts** ہیں۔ ✨ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
آپ بھی سرکاری FastAPI Expert بن سکتے ہیں! |
|||
|
|||
بس [GitHub میں سوالات کے ساتھ دوسروں کی مدد کریں](help-fastapi.md#help-others-with-questions-in-github)۔ 🤓 |
|||
|
|||
/// |
|||
|
|||
آپ **FastAPI Experts** یہاں دیکھ سکتے ہیں: |
|||
|
|||
* [پچھلا مہینہ](#fastapi-experts-last-month) 🤓 |
|||
* [3 مہینے](#fastapi-experts-3-months) 😎 |
|||
* [6 مہینے](#fastapi-experts-6-months) 🧐 |
|||
* [1 سال](#fastapi-experts-1-year) 🧑🔬 |
|||
* [**ہمیشہ**](#fastapi-experts-all-time) 🧙 |
|||
|
|||
### FastAPI Experts - پچھلا مہینہ |
|||
|
|||
یہ وہ صارفین ہیں جو پچھلے مہینے [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کرتے رہے ہیں۔ 🤓 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in people.last_month_experts[:10] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Questions replied: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
### FastAPI Experts - 3 مہینے |
|||
|
|||
یہ وہ صارفین ہیں جو پچھلے 3 مہینوں میں [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کرتے رہے ہیں۔ 😎 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in people.three_months_experts[:10] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Questions replied: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
### FastAPI Experts - 6 مہینے |
|||
|
|||
یہ وہ صارفین ہیں جو پچھلے 6 مہینوں میں [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کرتے رہے ہیں۔ 🧐 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in people.six_months_experts[:10] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Questions replied: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
### FastAPI Experts - 1 سال |
|||
|
|||
یہ وہ صارفین ہیں جو پچھلے سال [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کرتے رہے ہیں۔ 🧑🔬 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in people.one_year_experts[:20] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Questions replied: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
### FastAPI Experts - ہمیشہ |
|||
|
|||
یہ ہیں ہمیشہ کے **FastAPI Experts**۔ 🤓🤯 |
|||
|
|||
یہ وہ صارفین ہیں جنہوں نے *ہمیشہ سے* [GitHub میں سوالات کے ساتھ سب سے زیادہ دوسروں کی مدد](help-fastapi.md#help-others-with-questions-in-github) کی ہے۔ 🧙 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in people.experts[:50] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Questions replied: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
## اعلیٰ شراکت دار |
|||
|
|||
یہ ہیں **اعلیٰ شراکت دار**۔ 👷 |
|||
|
|||
ان صارفین نے سب سے زیادہ [Pull Requests بنائی ہیں](help-fastapi.md#create-a-pull-request) جو *merge* ہو چکی ہیں۔ |
|||
|
|||
انہوں نے source code، documentation وغیرہ میں تعاون کیا ہے۔ 📦 |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in (contributors.values() | list)[:50] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><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> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
سینکڑوں دوسرے شراکت دار بھی ہیں، آپ انہیں [FastAPI GitHub Contributors page](https://github.com/fastapi/fastapi/graphs/contributors) پر دیکھ سکتے ہیں۔ 👷 |
|||
|
|||
## اعلیٰ ترجمہ جائزہ کار |
|||
|
|||
یہ صارفین **اعلیٰ ترجمہ جائزہ کار** ہیں۔ 🕵️ |
|||
|
|||
ترجمہ جائزہ کاروں کے پاس documentation کے [**تراجم کی منظوری**](contributing.md#translations) دینے کا اختیار ہے۔ ان کے بغیر، کئی دوسری زبانوں میں documentation نہ ہوتی۔ |
|||
|
|||
<div class="user-list user-list-center"> |
|||
{% for user in (translation_reviewers.values() | list)[:50] %} |
|||
|
|||
{% if user.login not in skip_users %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Reviews: {{ user.count }}</div></div> |
|||
|
|||
{% endif %} |
|||
|
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
## سرپرست |
|||
|
|||
یہ ہیں **سرپرست**۔ 😎 |
|||
|
|||
وہ **FastAPI** (اور دوسرے) کے ساتھ میرے کام کی حمایت کر رہے ہیں، بنیادی طور پر [GitHub Sponsors](https://github.com/sponsors/tiangolo) کے ذریعے۔ |
|||
|
|||
{% if sponsors %} |
|||
|
|||
{% if sponsors.gold %} |
|||
|
|||
### گولڈ سرپرست |
|||
|
|||
{% for sponsor in sponsors.gold -%} |
|||
<a href="{{ sponsor.url }}" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.silver %} |
|||
|
|||
### سلور سرپرست |
|||
|
|||
{% for sponsor in sponsors.silver -%} |
|||
<a href="{{ sponsor.url }}" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.bronze %} |
|||
|
|||
### برانز سرپرست |
|||
|
|||
{% for sponsor in sponsors.bronze -%} |
|||
<a href="{{ sponsor.url }}" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% endif %} |
|||
|
|||
### انفرادی سرپرست |
|||
|
|||
{% 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 }}"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
|
|||
{% endif %} |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
## ڈیٹا کے بارے میں - تکنیکی تفصیلات |
|||
|
|||
اس صفحے کا بنیادی مقصد کمیونٹی کی دوسروں کی مدد کرنے کی کوششوں کو نمایاں کرنا ہے۔ |
|||
|
|||
خاص طور پر ایسی کوششوں کو شامل کرتے ہوئے جو عام طور پر کم نظر آتی ہیں، اور بہت سے معاملات میں زیادہ محنت طلب ہوتی ہیں، جیسے سوالات میں دوسروں کی مدد کرنا اور تراجم کے ساتھ Pull Requests کا review کرنا۔ |
|||
|
|||
ڈیٹا ہر مہینے حساب کیا جاتا ہے، آپ [source code یہاں](https://github.com/fastapi/fastapi/blob/master/scripts/) پڑھ سکتے ہیں۔ |
|||
|
|||
یہاں میں سرپرستوں کے تعاون کو بھی نمایاں کر رہا ہوں۔ |
|||
|
|||
میں algorithm، سیکشنز، thresholds وغیرہ کو اپڈیٹ کرنے کا حق بھی محفوظ رکھتا ہوں (احتیاطاً 🤷)۔ |
|||
@ -1,157 +0,0 @@ |
|||
# Repository Management Tasks |
|||
|
|||
یہ وہ کام ہیں جو FastAPI repository کو manage کرنے کے لیے [ٹیم ممبران](./fastapi-people.md#team) انجام دے سکتے ہیں۔ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
یہ سیکشن صرف مٹھی بھر لوگوں کے لیے مفید ہے، وہ ٹیم ممبران جن کے پاس repository manage کرنے کی اجازتیں ہیں۔ آپ شاید اسے چھوڑ سکتے ہیں۔ 😉 |
|||
|
|||
/// |
|||
|
|||
...تو آپ [FastAPI کی ٹیم کے ممبر](./fastapi-people.md#team) ہیں؟ واہ، آپ بہت زبردست ہیں! 😎 |
|||
|
|||
آپ [FastAPI کی مدد کریں - مدد حاصل کریں](./help-fastapi.md) میں سب کچھ بیرونی شراکت داروں کی طرح مدد کر سکتے ہیں۔ لیکن اس کے علاوہ، کچھ کام ایسے ہیں جو صرف آپ (ٹیم کے حصے کے طور پر) انجام دے سکتے ہیں۔ |
|||
|
|||
یہاں ان کاموں کی عمومی ہدایات ہیں جو آپ انجام دے سکتے ہیں۔ |
|||
|
|||
آپ کی مدد کے لیے بہت شکریہ۔ 🙇 |
|||
|
|||
## مہربان رہیں |
|||
|
|||
سب سے پہلے، مہربان رہیں۔ 😊 |
|||
|
|||
اگر آپ ٹیم میں شامل کیے گئے تو شاید آپ بہت مہربان ہیں، لیکن یہ ذکر کرنا ضروری ہے۔ 🤓 |
|||
|
|||
### جب چیزیں مشکل ہوں |
|||
|
|||
جب چیزیں اچھی ہوں تو سب کچھ آسان ہوتا ہے، تو اس کے لیے زیادہ ہدایات کی ضرورت نہیں۔ لیکن جب چیزیں مشکل ہوں، یہاں کچھ رہنمائی ہے۔ |
|||
|
|||
اچھی بات تلاش کرنے کی کوشش کریں۔ عام طور پر، اگر لوگ غیر دوستانہ نہیں ہو رہے، تو ان کی محنت اور دلچسپی کا شکریہ ادا کرنے کی کوشش کریں، چاہے آپ بنیادی موضوع (بحث، PR) سے متفق نہ ہوں، بس project میں دلچسپی لینے، یا کچھ کرنے کی کوشش میں وقت لگانے کا شکریہ ادا کریں۔ |
|||
|
|||
متن میں جذبات ظاہر کرنا مشکل ہوتا ہے، مدد کے لیے emojis استعمال کریں۔ 😅 |
|||
|
|||
Discussions اور PRs میں، بہت سے معاملات میں لوگ اپنی پریشانی لاتے ہیں اور بغیر فلٹر کے دکھاتے ہیں، بہت سے معاملات میں مبالغہ آرائی، شکایت، حق جتانا وغیرہ۔ یہ واقعی اچھا نہیں ہے، اور جب ایسا ہوتا ہے تو ان کے مسائل حل کرنے کی ہماری ترجیح کم ہو جاتی ہے۔ لیکن پھر بھی، سانس لینے کی کوشش کریں، اور اپنے جوابات میں نرم رہیں۔ |
|||
|
|||
تلخ طنز یا ممکنہ طور پر passive-aggressive تبصروں سے بچنے کی کوشش کریں۔ اگر کچھ غلط ہے، تو طنزیہ ہونے سے بہتر ہے کہ براہ راست (نرمی سے) بات کریں۔ |
|||
|
|||
جتنا ہو سکے مخصوص اور معروضی ہونے کی کوشش کریں، عمومی باتوں سے بچیں۔ |
|||
|
|||
ان گفتگو کے لیے جو زیادہ مشکل ہوں، مثلاً PR مسترد کرنا، آپ مجھ سے (@tiangolo) براہ راست سنبھالنے کو کہہ سکتے ہیں۔ |
|||
|
|||
## PR Titles ترمیم کریں |
|||
|
|||
* PR title ترمیم کریں تاکہ یہ [gitmoji](https://gitmoji.dev/) سے emoji کے ساتھ شروع ہو۔ |
|||
* Emoji character استعمال کریں، GitHub code نہیں۔ تو `🐛` استعمال کریں `:bug:` کی بجائے۔ تاکہ GitHub سے باہر بھی صحیح دکھائی دے، مثلاً release notes میں۔ |
|||
* تراجم کے لیے `🌐` emoji ("globe with meridians") استعمال کریں۔ |
|||
* Title فعل سے شروع کریں۔ مثلاً `Add`، `Refactor`، `Fix` وغیرہ۔ اس طرح title بتائے گا کہ PR کیا کرتا ہے۔ جیسے `Add support for teleporting`، بجائے `Teleporting wasn't working, so this PR fixes it`۔ |
|||
* PR title کا متن "امری" انداز میں ترمیم کریں، جیسے حکم دے رہے ہوں۔ تو `Adding support for teleporting` کی بجائے `Add support for teleporting` استعمال کریں۔ |
|||
* Title وضاحتی ہو کہ یہ کیا حاصل کرتا ہے۔ اگر feature ہے تو اسے بیان کرنے کی کوشش کریں، مثلاً `Add support for teleporting` بجائے `Create TeleportAdapter class`۔ |
|||
* Title نقطے (`.`) سے ختم نہ کریں۔ |
|||
* جب PR ترجمے کے لیے ہو، `🌐` سے شروع کریں اور پھر `Add {language} translation for` اور پھر ترجمہ شدہ فائل کا path۔ مثال کے طور پر: |
|||
|
|||
```Markdown |
|||
🌐 Add Spanish translation for `docs/es/docs/teleporting.md` |
|||
``` |
|||
|
|||
PR merge ہونے کے بعد، ایک GitHub Action ([latest-changes](https://github.com/tiangolo/latest-changes)) خودکار طور پر تازہ ترین تبدیلیاں اپڈیٹ کرنے کے لیے PR title استعمال کرے گی۔ |
|||
|
|||
تو اچھا PR title ہونا نہ صرف GitHub میں اچھا دکھائے گا، بلکہ release notes میں بھی۔ 📝 |
|||
|
|||
## PRs میں Labels شامل کریں |
|||
|
|||
وہی GitHub Action [latest-changes](https://github.com/tiangolo/latest-changes) release notes میں اس PR کو کس سیکشن میں رکھنا ہے یہ فیصلہ کرنے کے لیے PR میں ایک label استعمال کرتی ہے۔ |
|||
|
|||
یقینی بنائیں کہ آپ [latest-changes labels کی فہرست](https://github.com/tiangolo/latest-changes#using-labels) سے supported label استعمال کریں: |
|||
|
|||
* `breaking`: Breaking Changes |
|||
* موجودہ code ٹوٹ جائے گا اگر وہ اپنا code تبدیل کیے بغیر ورژن اپڈیٹ کریں۔ یہ شاذ و نادر ہوتا ہے، تو یہ label کم استعمال ہوتا ہے۔ |
|||
* `security`: Security Fixes |
|||
* یہ security fixes کے لیے ہے، جیسے vulnerabilities۔ یہ تقریباً کبھی استعمال نہیں ہوگا۔ |
|||
* `feature`: Features |
|||
* نئی features، ایسی چیزوں کی سہولت شامل کرنا جو پہلے موجود نہیں تھیں۔ |
|||
* `bug`: Fixes |
|||
* کوئی چیز جو supported تھی وہ کام نہیں کر رہی تھی، اور یہ اسے ٹھیک کرتا ہے۔ |
|||
* `refactor`: Refactors |
|||
* یہ عام طور پر اندرونی code میں تبدیلیوں کے لیے ہے جو رویے کو نہیں بدلتیں۔ |
|||
* `upgrade`: Upgrades |
|||
* یہ project سے براہ راست dependencies کے upgrades کے لیے ہے۔ |
|||
* `docs`: Docs |
|||
* Docs میں تبدیلیاں۔ اس میں تراجم کی تبدیلیاں شامل نہیں ہیں۔ |
|||
* `lang-all`: Translations |
|||
* تراجم کے لیے استعمال کریں۔ |
|||
* `internal`: Internal |
|||
* ایسی تبدیلیوں کے لیے استعمال کریں جو صرف repo management کو متاثر کرتی ہیں۔ |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
Dependabot جیسے tools کچھ labels شامل کریں گے، جیسے `dependencies`، لیکن یاد رکھیں کہ یہ label `latest-changes` GitHub Action استعمال نہیں کرتی، تو release notes میں استعمال نہیں ہوگا۔ براہ کرم یقینی بنائیں کہ اوپر والے labels میں سے ایک شامل ہو۔ |
|||
|
|||
/// |
|||
|
|||
## ترجمے کی PRs میں Labels شامل کریں |
|||
|
|||
جب ترجمے کی PR ہو، `lang-all` label کے علاوہ، زبان کے لیے بھی label شامل کریں۔ |
|||
|
|||
ہر زبان کے لیے زبان code کا استعمال کرتے ہوئے ایک label ہوگا، جیسے `lang-{lang code}`، مثلاً ہسپانوی کے لیے `lang-es`، فرانسیسی کے لیے `lang-fr` وغیرہ۔ |
|||
|
|||
* مخصوص زبان کا label شامل کریں۔ |
|||
* `awaiting-review` label شامل کریں۔ |
|||
|
|||
`awaiting-review` label خاص ہے، صرف تراجم کے لیے۔ ایک GitHub Action اسے detect کرے گا، پھر زبان کا label پڑھے گا، اور اس زبان کے تراجم manage کرنے والی GitHub Discussions کو اپڈیٹ کرے گا تاکہ لوگوں کو بتایا جائے کہ review کے لیے نیا ترجمہ ہے۔ |
|||
|
|||
جب کوئی مقامی بولنے والا آئے، PR کا review کرے، اور اسے منظور کرے، GitHub Action آ کر `awaiting-review` label ہٹائے گا، اور `approved-1` label شامل کرے گا۔ |
|||
|
|||
اس طرح، ہم نوٹ کر سکتے ہیں جب نئے تراجم تیار ہوں، کیونکہ ان کے پاس `approved-1` label ہوتا ہے۔ |
|||
|
|||
## ترجمے کی PRs Merge کریں |
|||
|
|||
تراجم LLMs اور scripts سے خودکار طور پر generate کیے جاتے ہیں۔ |
|||
|
|||
ایک GitHub Action ہے جو کسی زبان کے تراجم شامل یا اپڈیٹ کرنے کے لیے دستی طور پر چلایا جا سکتا ہے: [`translate.yml`](https://github.com/fastapi/fastapi/actions/workflows/translate.yml)۔ |
|||
|
|||
ان زبان کے ترجمے کی PRs کے لیے، تصدیق کریں کہ: |
|||
|
|||
* PR خودکار تھا (@tiangolo کی طرف سے)، کسی اور صارف نے نہیں بنایا۔ |
|||
* اس میں `lang-all` اور `lang-{lang code}` labels ہیں۔ |
|||
* اگر PR کم از کم ایک مقامی بولنے والے نے منظور کیا ہو، آپ اسے merge کر سکتے ہیں۔ |
|||
|
|||
## PRs کا Review کریں |
|||
|
|||
* اگر PR نہیں بتاتی کہ یہ کیا کرتی ہے یا کیوں، اگر ایسا لگے کہ مفید ہو سکتی ہے، مزید معلومات مانگیں۔ ورنہ، آزادانہ طور پر اسے بند کر دیں۔ |
|||
|
|||
* اگر PR spam لگے، بے معنی لگے، صرف اعداد و شمار تبدیل کرنے کے لیے ("contributor" ظاہر ہونے کے لیے) یا اسی طرح، آپ اسے `invalid` نشان زد کر سکتے ہیں، اور یہ خودکار طور پر بند ہو جائے گی۔ |
|||
|
|||
* اگر PR AI سے generate شدہ لگتی ہے، اور ایسا لگے کہ اس کا review کرنا prompt لکھنے سے زیادہ وقت لے گا، اسے `maybe-ai` نشان زد کریں، اور یہ خودکار طور پر بند ہو جائے گی۔ |
|||
|
|||
* PR کا کوئی مخصوص use case ہونا چاہیے جو یہ حل کر رہی ہو۔ |
|||
|
|||
* اگر PR feature کے لیے ہے تو اس میں docs ہونے چاہئیں۔ |
|||
* جب تک یہ ایسی feature نہ ہو جسے ہم حوصلہ شکنی کرنا چاہتے ہیں۔ |
|||
* Docs میں source مثالی فائل شامل ہونی چاہیے، براہ راست Markdown میں Python نہیں لکھنا چاہیے۔ |
|||
* اگر source مثال فائل(فائلوں) کے مختلف Python ورژنز کے لیے مختلف syntax ہو سکتے ہیں، تو فائل کے مختلف ورژنز ہونے چاہئیں، اور docs میں tabs میں دکھائے جانے چاہئیں۔ |
|||
* Source مثال ٹیسٹ کرنے والے tests ہونے چاہئیں۔ |
|||
* PR لاگو کرنے سے پہلے، نئے tests fail ہونے چاہئیں۔ |
|||
* PR لاگو کرنے کے بعد، نئے tests pass ہونے چاہئیں۔ |
|||
* Coverage 100% رہنا چاہیے۔ |
|||
* اگر آپ دیکھیں کہ PR درست ہے، یا ہم نے بحث کی اور فیصلہ کیا کہ اسے قبول کیا جائے، آپ PR کے اوپر commits شامل کر سکتے ہیں اسے بہتر بنانے، docs شامل کرنے، tests، فارمیٹ کرنے، refactor کرنے، اضافی فائلیں ہٹانے وغیرہ کے لیے۔ |
|||
* PR میں تبصرہ کرنے کے لیے آزاد محسوس کریں مزید معلومات مانگنے، تبدیلیاں تجویز کرنے وغیرہ کے لیے۔ |
|||
* جب آپ سمجھیں کہ PR تیار ہے، اسے اندرونی GitHub project میں میرے review کے لیے منتقل کریں۔ |
|||
|
|||
## FastAPI People PRs |
|||
|
|||
ہر مہینے، ایک GitHub Action FastAPI People data اپڈیٹ کرتی ہے۔ وہ PRs اس طرح نظر آتی ہیں: [👥 Update FastAPI People](https://github.com/fastapi/fastapi/pull/11669)۔ |
|||
|
|||
اگر tests pass ہو رہے ہوں، آپ اسے فوراً merge کر سکتے ہیں۔ |
|||
|
|||
## Dependabot PRs |
|||
|
|||
Dependabot مختلف چیزوں کے لیے dependencies اپڈیٹ کرنے کی PRs بنائے گا، اور وہ PRs ملتی جلتی نظر آتی ہیں، لیکن کچھ دوسروں سے بہت زیادہ نازک ہوتی ہیں۔ |
|||
|
|||
* اگر PR براہ راست dependency کے لیے ہو، تو Dependabot بنیادی dependencies میں `pyproject.toml` تبدیل کر رہا ہے، **اسے merge نہ کریں**۔ 😱 مجھے پہلے چیک کرنے دیں۔ |
|||
* اگر PR اندرونی dependencies میں سے کسی کو اپڈیٹ کرتی ہے، مثلاً `pyproject.toml` میں `dev` group، یا GitHub Action ورژنز، اگر tests pass ہو رہے ہیں، release notes (PR میں خلاصے میں دکھائی جاتی ہیں) میں کوئی واضح ممکنہ breaking change نظر نہیں آتی، آپ اسے merge کر سکتے ہیں۔ 😎 |
|||
|
|||
## GitHub Discussions جوابات نشان زد کریں |
|||
|
|||
جب GitHub Discussions میں کسی سوال کا جواب دیا گیا ہو، "Mark as answer" پر کلک کرکے جواب نشان زد کریں۔ |
|||
|
|||
آپ discussions کو [`Questions` جو `Unanswered` ہیں](https://github.com/tiangolo/fastapi/discussions/categories/questions?discussions_q=category:Questions+is:open+is:unanswered) سے فلٹر کر سکتے ہیں۔ |
|||
@ -1,39 +0,0 @@ |
|||
# Repository Management |
|||
|
|||
یہاں FastAPI repository کی انتظامیہ اور دیکھ بھال کی مختصر تفصیل ہے۔ |
|||
|
|||
## مالک |
|||
|
|||
میں، [@tiangolo](https://github.com/tiangolo)، FastAPI repository کا بانی اور مالک ہوں۔ 🤓 |
|||
|
|||
میں عام طور پر ہر PR کو merge کرنے سے پہلے حتمی review دیتا ہوں۔ میں project کے حتمی فیصلے کرتا ہوں، میں [<abbr title="Benevolent Dictator For Life">BDFL</abbr>](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life) ہوں۔ 😅 |
|||
|
|||
## ٹیم |
|||
|
|||
لوگوں کی ایک ٹیم ہے جو project کو manage اور برقرار رکھنے میں مدد کرتی ہے۔ 😎 |
|||
|
|||
ان کی اجازتوں اور [مخصوص ہدایات](./management-tasks.md) کی مختلف سطحیں ہیں۔ |
|||
|
|||
وہ جو کام انجام دے سکتے ہیں ان میں سے کچھ یہ ہیں: |
|||
|
|||
* PRs میں labels شامل کرنا۔ |
|||
* PR titles ترمیم کرنا۔ |
|||
* PRs کے اوپر commits شامل کرنا تاکہ انہیں بہتر بنایا جا سکے۔ |
|||
* GitHub Discussions سوالات میں جوابات نشان زد کرنا، وغیرہ۔ |
|||
* PRs کی مخصوص اقسام merge کرنا۔ |
|||
|
|||
آپ موجودہ ٹیم ممبران [FastAPI کے لوگ - ٹیم](./fastapi-people.md#team) میں دیکھ سکتے ہیں۔ |
|||
|
|||
ٹیم میں شمولیت صرف دعوت نامے سے ہے، اور میں اجازتیں، ہدایات، یا رکنیت اپڈیٹ یا ہٹا سکتا ہوں۔ |
|||
|
|||
## FastAPI Experts |
|||
|
|||
وہ لوگ جو GitHub Discussions میں سب سے زیادہ دوسروں کی مدد کرتے ہیں [**FastAPI Experts**](./fastapi-people.md#fastapi-experts) بن سکتے ہیں۔ |
|||
|
|||
یہ عام طور پر project میں تعاون کا بہترین طریقہ ہے۔ |
|||
|
|||
## بیرونی تعاون |
|||
|
|||
بیرونی تعاون کا بہت خیرمقدم ہے اور اس کی قدر کی جاتی ہے، بشمول سوالات کے جوابات دینا، PRs جمع کرنا وغیرہ۔ 🙇♂️ |
|||
|
|||
[FastAPI کو برقرار رکھنے میں مدد](./help-fastapi.md#help-maintain-fastapi) کرنے کے بہت سے طریقے ہیں۔ |
|||
@ -1,5 +0,0 @@ |
|||
# FastAPI اور دوستوں کا 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: 800px;"></iframe> |
|||
|
|||
<script type="text/javascript" src="https://app.mailjet.com/pas-nc-embedded-v1.js"></script> |
|||
@ -1,24 +0,0 @@ |
|||
# `APIRouter` class |
|||
|
|||
یہاں `APIRouter` class کی حوالہ جاتی معلومات ہیں، اس کے تمام parameters، attributes اور methods کے ساتھ۔ |
|||
|
|||
آپ `APIRouter` class کو براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```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 @@ |
|||
# Background Tasks - `BackgroundTasks` |
|||
|
|||
آپ *path operation function* یا dependency function میں `BackgroundTasks` type کا parameter declare کر سکتے ہیں، اور پھر اسے response بھیجنے کے بعد background tasks کے عمل کو schedule کرنے کے لیے استعمال کر سکتے ہیں۔ |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import BackgroundTasks |
|||
``` |
|||
|
|||
::: fastapi.BackgroundTasks |
|||
@ -1,29 +0,0 @@ |
|||
# Dependencies - `Depends()` اور `Security()` |
|||
|
|||
## `Depends()` |
|||
|
|||
Dependencies کو بنیادی طور پر خاص function `Depends()` کے ذریعے سنبھالا جاتا ہے جو ایک callable لیتا ہے۔ |
|||
|
|||
یہاں اس کی اور اس کے parameters کی حوالہ جاتی معلومات ہیں۔ |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import Depends |
|||
``` |
|||
|
|||
::: fastapi.Depends |
|||
|
|||
## `Security()` |
|||
|
|||
بہت سے منظرناموں میں، آپ `Depends()` استعمال کر کے dependencies کے ذریعے security (authorization، authentication، وغیرہ) کو سنبھال سکتے ہیں۔ |
|||
|
|||
لیکن جب آپ OAuth2 scopes بھی declare کرنا چاہیں، تو آپ `Depends()` کی بجائے `Security()` استعمال کر سکتے ہیں۔ |
|||
|
|||
آپ `Security()` کو براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import Security |
|||
``` |
|||
|
|||
::: fastapi.Security |
|||
@ -1,3 +0,0 @@ |
|||
# Encoders - `jsonable_encoder` |
|||
|
|||
::: fastapi.encoders.jsonable_encoder |
|||
@ -1,20 +0,0 @@ |
|||
# Exceptions - `HTTPException` اور `WebSocketException` |
|||
|
|||
یہ وہ exceptions ہیں جو آپ client کو غلطیاں دکھانے کے لیے raise کر سکتے ہیں۔ |
|||
|
|||
جب آپ کوئی exception raise کرتے ہیں، جیسا کہ عام Python میں ہوتا ہے، باقی کا عمل روک دیا جاتا ہے۔ اس طرح آپ code میں کہیں سے بھی یہ exceptions raise کر کے request کو روک سکتے ہیں اور client کو غلطی دکھا سکتے ہیں۔ |
|||
|
|||
آپ یہ استعمال کر سکتے ہیں: |
|||
|
|||
* `HTTPException` |
|||
* `WebSocketException` |
|||
|
|||
یہ exceptions براہ راست `fastapi` سے import کی جا سکتی ہیں: |
|||
|
|||
```python |
|||
from fastapi import HTTPException, WebSocketException |
|||
``` |
|||
|
|||
::: fastapi.HTTPException |
|||
|
|||
::: fastapi.WebSocketException |
|||
@ -1,31 +0,0 @@ |
|||
# `FastAPI` class |
|||
|
|||
یہاں `FastAPI` class کی حوالہ جاتی معلومات ہیں، اس کے تمام parameters، attributes اور methods کے ساتھ۔ |
|||
|
|||
آپ `FastAPI` class کو براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```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` class |
|||
|
|||
جب آپ ایسی dependencies define کرنا چاہیں جو HTTP اور WebSockets دونوں کے ساتھ مطابقت رکھتی ہوں، تو آپ `Request` یا `WebSocket` کی بجائے `HTTPConnection` لینے والا parameter define کر سکتے ہیں۔ |
|||
|
|||
آپ اسے `fastapi.requests` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.requests import HTTPConnection |
|||
``` |
|||
|
|||
::: fastapi.requests.HTTPConnection |
|||
@ -1,6 +0,0 @@ |
|||
# حوالہ جات |
|||
|
|||
یہاں حوالہ جات یا code API موجود ہے، جس میں classes، functions، parameters، attributes، اور FastAPI کے تمام وہ حصے شامل ہیں جو آپ اپنی applications میں استعمال کر سکتے ہیں۔ |
|||
|
|||
اگر آپ **FastAPI سیکھنا** چاہتے ہیں تو آپ کے لیے |
|||
[FastAPI ٹیوٹوریل](https://fastapi.tiangolo.com/tutorial/) پڑھنا زیادہ بہتر ہوگا۔ |
|||
@ -1,37 +0,0 @@ |
|||
# Middleware |
|||
|
|||
Starlette کی طرف سے براہ راست فراہم کردہ کئی middlewares دستیاب ہیں۔ |
|||
|
|||
ان کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Middleware](https://fastapi.tiangolo.com/advanced/middleware/)۔ |
|||
|
|||
::: fastapi.middleware.cors.CORSMiddleware |
|||
|
|||
اسے `fastapi` سے import کیا جا سکتا ہے: |
|||
|
|||
```python |
|||
from fastapi.middleware.cors import CORSMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.gzip.GZipMiddleware |
|||
|
|||
اسے `fastapi` سے import کیا جا سکتا ہے: |
|||
|
|||
```python |
|||
from fastapi.middleware.gzip import GZipMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.httpsredirect.HTTPSRedirectMiddleware |
|||
|
|||
اسے `fastapi` سے import کیا جا سکتا ہے: |
|||
|
|||
```python |
|||
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.trustedhost.TrustedHostMiddleware |
|||
|
|||
اسے `fastapi` سے import کیا جا سکتا ہے: |
|||
|
|||
```python |
|||
from fastapi.middleware.trustedhost import TrustedHostMiddleware |
|||
``` |
|||
@ -1,11 +0,0 @@ |
|||
# OpenAPI `docs` |
|||
|
|||
OpenAPI خودکار UI دستاویزات کو سنبھالنے کے لیے utilities، بشمول Swagger UI (بطور ڈیفالٹ `/docs` پر) اور ReDoc (بطور ڈیفالٹ `/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 |
|||
|
|||
OpenAPI کو سنبھالنے کے لیے کئی utilities دستیاب ہیں۔ |
|||
|
|||
عام طور پر آپ کو انہیں استعمال کرنے کی ضرورت نہیں ہوتی جب تک کہ آپ کے پاس کوئی مخصوص جدید استعمال کا معاملہ نہ ہو جس کے لیے ان کی ضرورت ہو۔ |
|||
@ -1,5 +0,0 @@ |
|||
# OpenAPI `models` |
|||
|
|||
OpenAPI Pydantic models جو تیار کردہ OpenAPI کو generate اور validate کرنے کے لیے استعمال ہوتے ہیں۔ |
|||
|
|||
::: fastapi.openapi.models |
|||
@ -1,35 +0,0 @@ |
|||
# Request Parameters |
|||
|
|||
یہاں request parameters کی حوالہ جاتی معلومات ہیں۔ |
|||
|
|||
یہ وہ خاص functions ہیں جو آپ *path operation function* کے parameters یا dependency functions میں `Annotated` کے ساتھ استعمال کر کے request سے ڈیٹا حاصل کر سکتے ہیں۔ |
|||
|
|||
اس میں شامل ہیں: |
|||
|
|||
* `Query()` |
|||
* `Path()` |
|||
* `Body()` |
|||
* `Cookie()` |
|||
* `Header()` |
|||
* `Form()` |
|||
* `File()` |
|||
|
|||
آپ ان سب کو براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```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,19 +0,0 @@ |
|||
# `Request` class |
|||
|
|||
آپ *path operation function* یا dependency میں `Request` type کا parameter declare کر سکتے ہیں اور پھر بغیر کسی validation وغیرہ کے خام request object تک براہ راست رسائی حاصل کر سکتے ہیں۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Request کو براہ راست استعمال کرنا](https://fastapi.tiangolo.com/advanced/using-request-directly/) |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import Request |
|||
``` |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
جب آپ ایسی dependencies define کرنا چاہیں جو HTTP اور WebSockets دونوں کے ساتھ مطابقت رکھتی ہوں، تو آپ `Request` یا `WebSocket` کی بجائے `HTTPConnection` لینے والا parameter define کر سکتے ہیں۔ |
|||
|
|||
/// |
|||
|
|||
::: fastapi.Request |
|||
@ -1,15 +0,0 @@ |
|||
# `Response` class |
|||
|
|||
آپ *path operation function* یا dependency میں `Response` type کا parameter declare کر سکتے ہیں اور پھر response کے لیے ڈیٹا جیسے headers یا cookies سیٹ کر سکتے ہیں۔ |
|||
|
|||
آپ اسے براہ راست ایک instance بنانے اور اپنی *path operations* سے واپس کرنے کے لیے بھی استعمال کر سکتے ہیں۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں حسب ضرورت Response واپس کرنا](https://fastapi.tiangolo.com/advanced/response-directly/#returning-a-custom-response) |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import Response |
|||
``` |
|||
|
|||
::: fastapi.Response |
|||
@ -1,172 +0,0 @@ |
|||
# حسب ضرورت Response Classes - File، HTML، Redirect، Streaming، وغیرہ |
|||
|
|||
کئی حسب ضرورت response classes دستیاب ہیں جنہیں آپ ایک instance بنا کر اپنی *path operations* سے براہ راست واپس کر سکتے ہیں۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں حسب ضرورت Response - HTML، Stream، File، اور دیگر](https://fastapi.tiangolo.com/advanced/custom-response/)۔ |
|||
|
|||
آپ انہیں براہ راست `fastapi.responses` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.responses import ( |
|||
FileResponse, |
|||
HTMLResponse, |
|||
JSONResponse, |
|||
ORJSONResponse, |
|||
PlainTextResponse, |
|||
RedirectResponse, |
|||
Response, |
|||
StreamingResponse, |
|||
UJSONResponse, |
|||
) |
|||
``` |
|||
|
|||
## FastAPI Responses |
|||
|
|||
کچھ حسب ضرورت FastAPI response classes تھیں جو JSON کی کارکردگی کو بہتر بنانے کے لیے بنائی گئی تھیں۔ |
|||
|
|||
تاہم، اب یہ deprecated ہو چکی ہیں کیونکہ اب آپ [Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/) استعمال کر کے بہتر کارکردگی حاصل کر سکتے ہیں۔ |
|||
|
|||
اس طرح، Pydantic ڈیٹا کو Rust کی طرف JSON bytes میں serialize کرے گا، جو ان حسب ضرورت JSON responses سے بہتر کارکردگی فراہم کرے گا۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [حسب ضرورت Response - HTML، Stream، File، اور دیگر - `orjson` یا Response Model](https://fastapi.tiangolo.com/advanced/custom-response/#orjson-or-response-model)۔ |
|||
|
|||
::: 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 دستاویزات میں حسب ضرورت Response](https://fastapi.tiangolo.com/advanced/custom-response/) اور [Starlette دستاویزات میں Responses](https://starlette.dev/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,75 +0,0 @@ |
|||
# Security ٹولز |
|||
|
|||
جب آپ کو OAuth2 scopes کے ساتھ dependencies declare کرنی ہوں تو آپ `Security()` استعمال کرتے ہیں۔ |
|||
|
|||
لیکن آپ کو پھر بھی یہ define کرنا ہوگا کہ dependable کیا ہے، یعنی وہ callable جو آپ `Depends()` یا `Security()` کو parameter کے طور پر دیتے ہیں۔ |
|||
|
|||
ایسے dependables بنانے کے لیے کئی ٹولز دستیاب ہیں، اور یہ OpenAPI میں ضم ہو جاتے ہیں تاکہ یہ خودکار docs UI میں دکھائے جائیں، خودکار طور پر بنائے گئے clients اور SDKs کے ذریعے استعمال ہو سکیں، وغیرہ۔ |
|||
|
|||
آپ انہیں `fastapi.security` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.security import ( |
|||
APIKeyCookie, |
|||
APIKeyHeader, |
|||
APIKeyQuery, |
|||
HTTPAuthorizationCredentials, |
|||
HTTPBasic, |
|||
HTTPBasicCredentials, |
|||
HTTPBearer, |
|||
HTTPDigest, |
|||
OAuth2, |
|||
OAuth2AuthorizationCodeBearer, |
|||
OAuth2PasswordBearer, |
|||
OAuth2PasswordRequestForm, |
|||
OAuth2PasswordRequestFormStrict, |
|||
OpenIdConnect, |
|||
SecurityScopes, |
|||
) |
|||
``` |
|||
|
|||
ان کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Security](https://fastapi.tiangolo.com/tutorial/security/)۔ |
|||
|
|||
## API Key Security Schemes |
|||
|
|||
::: fastapi.security.APIKeyCookie |
|||
|
|||
::: fastapi.security.APIKeyHeader |
|||
|
|||
::: fastapi.security.APIKeyQuery |
|||
|
|||
## HTTP Authentication Schemes |
|||
|
|||
::: fastapi.security.HTTPBasic |
|||
|
|||
::: fastapi.security.HTTPBearer |
|||
|
|||
::: fastapi.security.HTTPDigest |
|||
|
|||
## HTTP Credentials |
|||
|
|||
::: fastapi.security.HTTPAuthorizationCredentials |
|||
|
|||
::: fastapi.security.HTTPBasicCredentials |
|||
|
|||
## OAuth2 Authentication |
|||
|
|||
::: fastapi.security.OAuth2 |
|||
|
|||
::: fastapi.security.OAuth2AuthorizationCodeBearer |
|||
|
|||
::: fastapi.security.OAuth2PasswordBearer |
|||
|
|||
## OAuth2 Password Form |
|||
|
|||
::: fastapi.security.OAuth2PasswordRequestForm |
|||
|
|||
::: fastapi.security.OAuth2PasswordRequestFormStrict |
|||
|
|||
## OAuth2 Security Scopes میں Dependencies |
|||
|
|||
::: fastapi.security.SecurityScopes |
|||
|
|||
## OpenID Connect |
|||
|
|||
::: fastapi.security.OpenIdConnect |
|||
@ -1,13 +0,0 @@ |
|||
# Static Files - `StaticFiles` |
|||
|
|||
آپ `StaticFiles` class کو static files فراہم کرنے کے لیے استعمال کر سکتے ہیں، جیسے JavaScript، CSS، تصاویر، وغیرہ۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Static Files](https://fastapi.tiangolo.com/tutorial/static-files/)۔ |
|||
|
|||
آپ اسے براہ راست `fastapi.staticfiles` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.staticfiles import StaticFiles |
|||
``` |
|||
|
|||
::: fastapi.staticfiles.StaticFiles |
|||
@ -1,36 +0,0 @@ |
|||
# Status Codes |
|||
|
|||
آپ `status` module کو `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import status |
|||
``` |
|||
|
|||
`status` براہ راست Starlette کی طرف سے فراہم کیا گیا ہے۔ |
|||
|
|||
اس میں نامزد constants (variables) کا ایک گروپ ہے جن کی قدریں integer status codes ہیں۔ |
|||
|
|||
مثال کے طور پر: |
|||
|
|||
* 200: `status.HTTP_200_OK` |
|||
* 403: `status.HTTP_403_FORBIDDEN` |
|||
* وغیرہ۔ |
|||
|
|||
یہ آپ کی app میں HTTP (اور WebSocket) status codes تک فوری رسائی کے لیے آسان ہو سکتا ہے، نام کے لیے autocompletion استعمال کرتے ہوئے بغیر integer status codes یاد رکھنے کی ضرورت کے۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/)۔ |
|||
|
|||
## مثال |
|||
|
|||
```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` |
|||
|
|||
آپ `Jinja2Templates` class کو Jinja templates render کرنے کے لیے استعمال کر سکتے ہیں۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Templates](https://fastapi.tiangolo.com/advanced/templates/)۔ |
|||
|
|||
آپ اسے براہ راست `fastapi.templating` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.templating import Jinja2Templates |
|||
``` |
|||
|
|||
::: fastapi.templating.Jinja2Templates |
|||
@ -1,13 +0,0 @@ |
|||
# Test Client - `TestClient` |
|||
|
|||
آپ `TestClient` class کو FastAPI applications کی جانچ کرنے کے لیے استعمال کر سکتے ہیں بغیر کوئی حقیقی HTTP اور socket connection بنائے، بس FastAPI code کے ساتھ براہ راست بات چیت کر کے۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں Testing](https://fastapi.tiangolo.com/tutorial/testing/)۔ |
|||
|
|||
آپ اسے براہ راست `fastapi.testclient` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.testclient import TestClient |
|||
``` |
|||
|
|||
::: fastapi.testclient.TestClient |
|||
@ -1,22 +0,0 @@ |
|||
# `UploadFile` class |
|||
|
|||
آپ *path operation function* کے parameters کو `UploadFile` type کا define کر سکتے ہیں تاکہ request سے files وصول کی جا سکیں۔ |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import UploadFile |
|||
``` |
|||
|
|||
::: fastapi.UploadFile |
|||
options: |
|||
members: |
|||
- file |
|||
- filename |
|||
- size |
|||
- headers |
|||
- content_type |
|||
- read |
|||
- write |
|||
- seek |
|||
- close |
|||
@ -1,73 +0,0 @@ |
|||
# WebSockets |
|||
|
|||
WebSockets define کرتے وقت، آپ عام طور پر `WebSocket` type کا parameter declare کرتے ہیں اور اس کے ذریعے client سے ڈیٹا پڑھ سکتے ہیں اور اسے ڈیٹا بھیج سکتے ہیں۔ |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں WebSockets](https://fastapi.tiangolo.com/advanced/websockets/) |
|||
|
|||
یہ Starlette کی طرف سے براہ راست فراہم کیا گیا ہے، لیکن آپ اسے `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import WebSocket |
|||
``` |
|||
|
|||
/// tip | مشورہ |
|||
|
|||
جب آپ ایسی dependencies define کرنا چاہیں جو HTTP اور WebSockets دونوں کے ساتھ مطابقت رکھتی ہوں، تو آپ `Request` یا `WebSocket` کی بجائے `HTTPConnection` لینے والا parameter define کر سکتے ہیں۔ |
|||
|
|||
/// |
|||
|
|||
::: fastapi.WebSocket |
|||
options: |
|||
members: |
|||
- scope |
|||
- app |
|||
- url |
|||
- base_url |
|||
- headers |
|||
- query_params |
|||
- path_params |
|||
- cookies |
|||
- client |
|||
- state |
|||
- url_for |
|||
- client_state |
|||
- application_state |
|||
- receive |
|||
- send |
|||
- accept |
|||
- receive_text |
|||
- receive_bytes |
|||
- receive_json |
|||
- iter_text |
|||
- iter_bytes |
|||
- iter_json |
|||
- send_text |
|||
- send_bytes |
|||
- send_json |
|||
- close |
|||
|
|||
## WebSockets - اضافی classes |
|||
|
|||
WebSockets کو سنبھالنے کے لیے اضافی classes۔ |
|||
|
|||
Starlette کی طرف سے براہ راست فراہم کی گئی ہیں، لیکن آپ انہیں `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi.websockets import WebSocketDisconnect, WebSocketState |
|||
``` |
|||
|
|||
::: fastapi.websockets.WebSocketDisconnect |
|||
|
|||
جب کوئی client منقطع ہوتا ہے تو `WebSocketDisconnect` exception raise ہوتا ہے، آپ اسے catch کر سکتے ہیں۔ |
|||
|
|||
آپ اسے براہ راست `fastapi` سے import کر سکتے ہیں: |
|||
|
|||
```python |
|||
from fastapi import WebSocketDisconnect |
|||
``` |
|||
|
|||
اس کے بارے میں مزید پڑھیں [FastAPI دستاویزات میں WebSockets](https://fastapi.tiangolo.com/advanced/websockets/#handling-disconnections-and-multiple-clients) |
|||
|
|||
::: fastapi.websockets.WebSocketState |
|||
|
|||
`WebSocketState` ایک enumeration ہے جو WebSocket connection کی ممکنہ حالتوں کو ظاہر کرتا ہے۔ |
|||
@ -1,6 +0,0 @@ |
|||
--- |
|||
hide: |
|||
- navigation |
|||
--- |
|||
|
|||
# ریلیز نوٹس |
|||
Loading…
Reference in new issue