python-style

作者: contentstack

用於 contentstack-python 的 Python 套件佈局、setup.py 慣例與風格。

npx skills add https://github.com/contentstack/contentstack-python --skill python-style

Python style – Contentstack CDA SDK

When to use

  • Editing any Python under contentstack/, setup.py, or requirements.txt.
  • Adding modules or changing how the public package surface is exported.

Instructions

Layout

PathRole
contentstack/stack.pyStack, ContentstackRegion
contentstack/query.py, basequery.pyQuery building
contentstack/entry.py, asset.py, contenttype.pyDomain objects
contentstack/taxonomy.py, globalfields.py, variants.pyAdvanced features
contentstack/https_connection.py, controller.pyHTTP session + request dispatch
contentstack/error_messages.py, utility.pyShared helpers
contentstack/__init__.pyPublic exports (Stack, Entry, Asset, …), __version__

Style

  • Match existing patterns (typing on Stack, unittest-style tests in tests/).
  • Prefer clear public APIs over internal churn; keep module boundaries similar to neighboring files.

Dependencies

  • requests, python-dateutil, urllib3 (Retry) — see setup.py install_requires.
  • Do not add new runtime dependencies without updating setup.py and requirements.txt.

Security

  • Do not log delivery_token, preview_token, api_key, or management_token; follow existing logging in Stack.

來自 contentstack 的更多技能

cms-assets
contentstack
為開發人員提供有關在Contentstack中組織、交付和轉換資產的建議。涵蓋資料夾結構、Image Delivery API轉換、發佈……
cms-branches-aliases
contentstack
為開發人員提供使用 Contentstack 分支進行隔離內容開發以及使用別名實現零停機內容部署的建議。涵蓋分支策略,…
cms-data-modeling-best-practices
contentstack
引導開發人員在Contentstack中使用最簡單的可重用結構來建模內容。此技能說明何時使用內容類型、引用、全域…
cms-live-preview-visual-builder-support-assistant
contentstack
診斷並指導 Contentstack Live Preview 和 Visual Builder 的實作。追蹤預覽上下文,識別中斷的合約,並建議…
cms-releases
contentstack
指導開發人員使用 Contentstack Releases 進行協調、原子化的內容部署。涵蓋版本建立、項目管理、分階段部署等內容。
cms-roles-permissions
contentstack
為開發人員提供關於在Contentstack中設計角色、權限、團隊和Token存取權限的建議。解釋內建角色、自訂角色、權限合併等。
cms-taxonomy
contentstack
為開發人員提供關於使用 Contentstack Taxonomy 進行結構化、階層式內容分類及傳遞端篩選的建議。涵蓋 taxonomy 與 tags 的比較,…
cms-tokens-authentication
contentstack
為開發人員提供建議,協助他們為前端、後端、自動化及第三方應用程式使用情境選擇正確的Contentstack驗證方法與權杖類型。…