شرح قالب .gitignore لـ Python
يشرح سبب تجاهل Python.gitignore لـ __pycache__ والبيئات الافتراضية ومخرجات التحزيم وذاكرات الاختبار وفحص الأنواع والإعدادات السرية، مع ملاحظات حول lib/ وملفات القفل.
Python.gitignore قالب كبير صُمم ليناسب مشاريع Python الخالصة وتطبيقات الويب بـ Django وFlask وعلوم البيانات ونشر الحزم على حد سواء. يجمع في مكان واحد ذاكرة الشيفرة البايتية، والبيئات الافتراضية، ومجلدات التحزيم التي ينشئها setup.py أو واجهة البناء الخلفية، وذاكرات أدوات مثل pytest وmypy وruff.
لكثرة قواعده، قد تُطابَق مسارات لم تقصدها. فهو يتجاهل على وجه الخصوص مجلدات ذات أسماء شائعة مثل lib/ وbuild/ وdist/ وtarget/ أيًّا كان عمقها، لذا يُستحسن اختبار النتيجة مرة في المستودعات التي تمتزج فيها لغات أخرى.
شرح القواعد
| النمط | ما الذي يتجاهله ولماذا |
|---|---|
__pycache__/*.py[codz]*$py.class*.so | الشيفرة البايتية ووحدات الامتدادذاكرة .pyc التي ينشئها المفسّر عند الاستيراد (import)، والمكتبات المشتركة الناتجة عن بناء امتدادات C. النمط *.py[codz] نمط أقواس يلتقط .pyc و.pyo و.pyd و.pyz دفعة واحدة. وكلها يُعاد إنشاؤها من الشيفرة المصدرية. |
build/dist/*.egg-info/*.eggwheels/sdist/MANIFEST | مخرجات التحزيمملفات التوزيع والبيانات الوصفية التي ينشئها python -m build أو setuptools. نتائج النشر تُرفع إلى مستودعات مثل PyPI، وليست مما يوضع في مستودع الشيفرة المصدرية. |
.venvvenv/env/ENV/__pypackages__/ | البيئات الافتراضيةتتضمن مسار المفسّر مثبّتًا فيها، فلا تعمل إذا نُقلت إلى حاسوب آخر، كما أن حجمها كبير. تُشارَك الاعتماديات عبر requirements.txt أو pyproject.toml مع ملف القفل. |
.pytest_cache/.tox/.nox/.coveragehtmlcov/coverage.xml.hypothesis/ | ذاكرات الاختبار والتغطيةنتائج وذاكرات مؤقتة تتركها أدوات تشغيل الاختبارات والتغطية. تتغير مع كل تشغيل، فتُعامل على أنها مخرجات CI فقط. |
.mypy_cache/.pyre/.pytype/.ruff_cache/ | ذاكرات فحص الأنواع وأدوات الفحصذاكرات محلية لتسريع التحليل الساكن، وإذا حُذفت أُعيد إنشاؤها في التشغيل التالي. |
local_settings.pydb.sqlite3instance/.webassets-cachecelerybeat-schedule* | البيانات المحلية للأطرالإعدادات المحلية لـ Django وقاعدة بيانات SQLite للتطوير، ومجلد instance/ في Flask، وملف جدولة Celery beat. يختلف محتواها من مطور لآخر، ومن السهل أن تتسلل إليها قيم سرية. |
.env.envrc.pypirc.streamlit/secrets.toml | المعلومات السريةملفات متغيرات البيئة، وإعدادات direnv، والملف .pypirc الذي يحوي رمز الرفع إلى PyPI، والإعدادات السرية لـ Streamlit. متى أُودعت مرة بقيت في السجل التاريخي، لذا تُستبعد من البداية. |
.ipynb_checkpointsprofile_default/ipython_config.py/sitedocs/_build/ | دفاتر الملاحظات وأدوات أخرىنقاط الحفظ في Jupyter، وملفات تعريف IPython، ونتائج بناء mkdocs (/site) وSphinx (docs/_build/). يسبق /site شرطة /، فيشير فقط إلى site في جذر المستودع. |
ملاحظات عملية
- تتجاهل قاعدتا
lib/وlib64/مجلداتlibعلى أي عمق. إن كانت شيفرة الواجهة الأمامية فيsrc/lib/فغيّر القاعدة إلى/lib/أو أضف!src/lib/. - يذكر القالب
poetry.lockوuv.lockوpdm.lockوPipfile.lockفي التعليقات فقط ولا يتجاهلها. في التطبيقات، الشائع إيداعها لضمان تثبيت قابل لإعادة الإنتاج. - تذكّر أن
.venvلا ينتهي بـ/، فيُتجاهَل أيضًا أي ملف بالاسم نفسه (مثل ملف إعدادات أداة يدوّن مسار البيئة الافتراضية). - لا يمكن منع نتائج تنفيذ دفاتر Jupyter (خلايا المخرجات) عبر gitignore. لإيداعها بعد مسح المخرجات استخدم أداة مثل nbstripout.
القالب الأصلي
# Byte-compiled / optimized / DLL files__pycache__/*.py[codz]*$py.class# C extensions*.so# Distribution / packaging.Pythonbuild/develop-eggs/dist/downloads/eggs/.eggs/lib/lib64/parts/sdist/var/wheels/share/python-wheels/*.egg-info/.installed.cfg*.eggMANIFEST# PyInstaller# Usually these files are written by a python script from a template# before PyInstaller builds the exe, so as to inject date/other infos into it.*.manifest*.spec# Installer logspip-log.txtpip-delete-this-directory.txt# Unit test / coverage reportshtmlcov/.tox/.nox/.coverage.coverage.*.cachenosetests.xmlcoverage.xml*.cover*.py.cover*.lcov.hypothesis/.pytest_cache/cover/# Translations*.mo*.pot# Django stuff:*.loglocal_settings.pydb.sqlite3db.sqlite3-journal# Flask stuff:instance/.webassets-cache# Scrapy stuff:.scrapy# Sphinx documentationdocs/_build/# PyBuilder.pybuilder/target/# Jupyter Notebook.ipynb_checkpoints# IPythonprofile_default/ipython_config.py# pyenv# For a library or package, you might want to ignore these files since the code is# intended to run in multiple environments; otherwise, check them in:# .python-version# pipenv# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.# However, in case of collaboration, if having platform-specific dependencies or dependencies# having no cross-platform support, pipenv may install dependencies that don't work, or not# install all needed dependencies.# Pipfile.lock# UV# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.# This is especially recommended for binary packages to ensure reproducibility, and is more# commonly ignored for libraries.# uv.lock# poetry# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.# This is especially recommended for binary packages to ensure reproducibility, and is more# commonly ignored for libraries.# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control# poetry.lock# poetry.toml# pdm# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.# https://pdm-project.org/en/latest/usage/project/#working-with-version-control# pdm.lock# pdm.toml.pdm-python.pdm-build/# pixi# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.# pixi.lock# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one# in the .venv directory. It is recommended not to include this directory in version control..pixi/*!.pixi/config.toml# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm__pypackages__/# Celery stuffcelerybeat-schedule*celerybeat.pid# Redis*.rdb*.aof*.pid# RabbitMQmnesia/rabbitmq/rabbitmq-data/# ActiveMQactivemq-data/# SageMath parsed files*.sage.py# Environments.env.envrc.venvenv/venv/ENV/env.bak/venv.bak/# Spyder project settings.spyderproject.spyproject# Rope project settings.ropeproject# mkdocs documentation/site# mypy.mypy_cache/.dmypy.jsondmypy.json# Pyre type checker.pyre/# pytype static type analyzer.pytype/# Cython debug symbolscython_debug/# PyCharm# JetBrains specific template is maintained in a separate JetBrains.gitignore that can# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore# and can be added to the global gitignore or merged into this file. For a more nuclear# option (not recommended) you can uncomment the following to ignore the entire idea folder.# .idea/# Abstra# Abstra is an AI-powered process automation framework.# Ignore directories containing user credentials, local state, and settings.# Learn more at https://abstra.io/docs.abstra/# Visual Studio Code# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore# and can be added to the global gitignore or merged into this file. However, if you prefer, you# could uncomment the following to ignore the entire vscode folder# .vscode/# Temporary file for partial code executiontempCodeRunnerFile.py# Ruff stuff:.ruff_cache/# PyPI configuration file.pypirc# Marimomarimo/_static/marimo/_lsp/__marimo__/# Streamlit.streamlit/secrets.toml
مصدر القوالب: github/gitignore/Python.gitignore @356fd7b (2026-09-11) · CC0-1.0