codeply-cli 0.3.1 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (375) hide show
  1. package/THIRD_PARTY_NOTICES.md +63 -63
  2. package/bin/codeply.js +127 -0
  3. package/lib/agent.mjs +2139 -2139
  4. package/lib/ai.mjs +6 -6
  5. package/lib/apply-patch.js +217 -217
  6. package/lib/arity-table.json +138 -138
  7. package/lib/arity.js +70 -70
  8. package/lib/auth.mjs +6 -6
  9. package/lib/cloud.mjs +796 -0
  10. package/lib/commands.js +103 -103
  11. package/lib/design-library/assemble-artifact.mjs +21 -21
  12. package/lib/design-library/cleanup.mjs +45 -45
  13. package/lib/design-library/index.json +22379 -22379
  14. package/lib/design-library/make-table-data.mjs +39 -39
  15. package/lib/diagnostics.js +192 -192
  16. package/lib/edit-engine.js +364 -364
  17. package/lib/github-agent.mjs +311 -307
  18. package/lib/history.js +75 -75
  19. package/lib/mcp.js +258 -258
  20. package/lib/native-tools.mjs +189 -189
  21. package/lib/oauth-connectors.js +2 -1
  22. package/lib/permissions.js +109 -109
  23. package/lib/plugins.js +353 -353
  24. package/lib/server.mjs +457 -457
  25. package/lib/session-db.js +220 -220
  26. package/lib/share.js +168 -168
  27. package/lib/skills.js +416 -416
  28. package/lib/snapshot.js +146 -146
  29. package/lib/terminal-hints.js +154 -154
  30. package/lib/tools.mjs +2012 -2012
  31. package/lib/typecheck-worker.js +147 -147
  32. package/lib/web-tools.js +158 -158
  33. package/package.json +49 -47
  34. package/skills/SOURCE.md +58 -58
  35. package/skills/accessibility/SKILL.md +147 -147
  36. package/skills/agent-architecture-audit/SKILL.md +257 -257
  37. package/skills/agent-eval/SKILL.md +147 -147
  38. package/skills/agent-harness-construction/SKILL.md +74 -74
  39. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  40. package/skills/agent-payment-x402/SKILL.md +225 -225
  41. package/skills/agent-self-evaluation/SKILL.md +182 -182
  42. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  43. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  44. package/skills/agent-sort/SKILL.md +216 -216
  45. package/skills/agentic-engineering/SKILL.md +64 -64
  46. package/skills/agentic-os/SKILL.md +388 -388
  47. package/skills/ai-first-engineering/SKILL.md +52 -52
  48. package/skills/ai-regression-testing/SKILL.md +386 -386
  49. package/skills/android-clean-architecture/SKILL.md +340 -340
  50. package/skills/angular-developer/SKILL.md +155 -155
  51. package/skills/angular-developer/references/angular-animations.md +160 -160
  52. package/skills/angular-developer/references/angular-aria.md +410 -410
  53. package/skills/angular-developer/references/cli.md +86 -86
  54. package/skills/angular-developer/references/component-harnesses.md +59 -59
  55. package/skills/angular-developer/references/component-styling.md +91 -91
  56. package/skills/angular-developer/references/components.md +117 -117
  57. package/skills/angular-developer/references/creating-services.md +97 -97
  58. package/skills/angular-developer/references/data-resolvers.md +69 -69
  59. package/skills/angular-developer/references/define-routes.md +67 -67
  60. package/skills/angular-developer/references/defining-providers.md +72 -72
  61. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  62. package/skills/angular-developer/references/e2e-testing.md +56 -56
  63. package/skills/angular-developer/references/effects.md +83 -83
  64. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  65. package/skills/angular-developer/references/host-elements.md +80 -80
  66. package/skills/angular-developer/references/injection-context.md +63 -63
  67. package/skills/angular-developer/references/inputs.md +101 -101
  68. package/skills/angular-developer/references/linked-signal.md +59 -59
  69. package/skills/angular-developer/references/loading-strategies.md +61 -61
  70. package/skills/angular-developer/references/mcp.md +108 -108
  71. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  72. package/skills/angular-developer/references/outputs.md +86 -86
  73. package/skills/angular-developer/references/reactive-forms.md +122 -122
  74. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  75. package/skills/angular-developer/references/resource.md +77 -77
  76. package/skills/angular-developer/references/route-animations.md +56 -56
  77. package/skills/angular-developer/references/route-guards.md +52 -52
  78. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  79. package/skills/angular-developer/references/router-testing.md +87 -87
  80. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  81. package/skills/angular-developer/references/signal-forms.md +795 -795
  82. package/skills/angular-developer/references/signals-overview.md +94 -94
  83. package/skills/angular-developer/references/tailwind-css.md +69 -69
  84. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  85. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  86. package/skills/api-connector-builder/SKILL.md +121 -121
  87. package/skills/api-design/SKILL.md +524 -524
  88. package/skills/architecture-decision-records/SKILL.md +180 -180
  89. package/skills/article-writing/SKILL.md +80 -80
  90. package/skills/automation-audit-ops/SKILL.md +143 -143
  91. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  92. package/skills/autonomous-loops/SKILL.md +611 -611
  93. package/skills/backend-patterns/SKILL.md +562 -562
  94. package/skills/benchmark/SKILL.md +95 -95
  95. package/skills/benchmark-methodology/SKILL.md +191 -191
  96. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  97. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  98. package/skills/blueprint/SKILL.md +106 -106
  99. package/skills/brand-discovery/SKILL.md +145 -145
  100. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  101. package/skills/brand-discovery/references/20_positioning.md +44 -44
  102. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  103. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  104. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  105. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  106. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  107. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  108. package/skills/brand-voice/SKILL.md +98 -98
  109. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  110. package/skills/browser-qa/SKILL.md +105 -105
  111. package/skills/bun-runtime/SKILL.md +85 -85
  112. package/skills/canary-watch/SKILL.md +108 -108
  113. package/skills/carrier-relationship-management/SKILL.md +212 -212
  114. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  115. package/skills/ck/SKILL.md +148 -148
  116. package/skills/claude-devfleet/SKILL.md +112 -112
  117. package/skills/click-path-audit/SKILL.md +245 -245
  118. package/skills/clickhouse-io/SKILL.md +445 -445
  119. package/skills/code-tour/SKILL.md +254 -254
  120. package/skills/codebase-onboarding/SKILL.md +234 -234
  121. package/skills/codehealth-mcp/SKILL.md +167 -167
  122. package/skills/coding-standards/SKILL.md +551 -551
  123. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  124. package/skills/competitive-report-structure/SKILL.md +162 -162
  125. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  126. package/skills/config-gc/SKILL.md +120 -120
  127. package/skills/configure-ecc/SKILL.md +385 -385
  128. package/skills/connections-optimizer/SKILL.md +190 -190
  129. package/skills/content-engine/SKILL.md +132 -132
  130. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  131. package/skills/context-budget/SKILL.md +136 -136
  132. package/skills/continuous-agent-loop/SKILL.md +46 -46
  133. package/skills/continuous-learning/SKILL.md +132 -132
  134. package/skills/continuous-learning-v2/SKILL.md +361 -361
  135. package/skills/contract-first/SKILL.md +287 -287
  136. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  137. package/skills/cost-tracking/SKILL.md +97 -97
  138. package/skills/council/SKILL.md +204 -204
  139. package/skills/cpp-coding-standards/SKILL.md +724 -724
  140. package/skills/cpp-testing/SKILL.md +325 -325
  141. package/skills/crosspost/SKILL.md +112 -112
  142. package/skills/csharp-testing/SKILL.md +322 -322
  143. package/skills/customer-billing-ops/SKILL.md +141 -141
  144. package/skills/customs-trade-compliance/SKILL.md +263 -263
  145. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  146. package/skills/dashboard-builder/SKILL.md +109 -109
  147. package/skills/data-scraper-agent/SKILL.md +765 -765
  148. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  149. package/skills/database-migrations/SKILL.md +430 -430
  150. package/skills/deep-research/SKILL.md +160 -160
  151. package/skills/defi-amm-security/SKILL.md +167 -167
  152. package/skills/delivery-gate/SKILL.md +126 -126
  153. package/skills/deployment-patterns/SKILL.md +428 -428
  154. package/skills/design-system/SKILL.md +83 -83
  155. package/skills/django-celery/SKILL.md +458 -458
  156. package/skills/django-patterns/SKILL.md +735 -735
  157. package/skills/django-security/SKILL.md +644 -644
  158. package/skills/django-tdd/SKILL.md +730 -730
  159. package/skills/django-verification/SKILL.md +470 -470
  160. package/skills/dmux-workflows/SKILL.md +192 -192
  161. package/skills/docker-patterns/SKILL.md +365 -365
  162. package/skills/documentation-lookup/SKILL.md +91 -91
  163. package/skills/dotnet-patterns/SKILL.md +322 -322
  164. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  165. package/skills/e2e-testing/SKILL.md +327 -327
  166. package/skills/ecc-guide/SKILL.md +190 -190
  167. package/skills/ecc-recipes/SKILL.md +149 -149
  168. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  169. package/skills/email-ops/SKILL.md +122 -122
  170. package/skills/energy-procurement/SKILL.md +228 -228
  171. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  172. package/skills/error-handling/SKILL.md +377 -377
  173. package/skills/eval-harness/SKILL.md +271 -271
  174. package/skills/evm-token-decimals/SKILL.md +131 -131
  175. package/skills/exa-search/SKILL.md +108 -108
  176. package/skills/fal-ai-media/SKILL.md +289 -289
  177. package/skills/fastapi-patterns/SKILL.md +514 -514
  178. package/skills/finance-billing-ops/SKILL.md +128 -128
  179. package/skills/flox-environments/SKILL.md +497 -497
  180. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  181. package/skills/foundation-models-on-device/SKILL.md +243 -243
  182. package/skills/frontend-a11y/SKILL.md +446 -446
  183. package/skills/frontend-design-direction/SKILL.md +93 -93
  184. package/skills/frontend-patterns/SKILL.md +657 -657
  185. package/skills/frontend-slides/SKILL.md +185 -185
  186. package/skills/fsharp-testing/SKILL.md +281 -281
  187. package/skills/gan-style-harness/SKILL.md +279 -279
  188. package/skills/gateguard/SKILL.md +133 -133
  189. package/skills/generating-python-installer/SKILL.md +820 -820
  190. package/skills/git-workflow/SKILL.md +716 -716
  191. package/skills/github-ops/SKILL.md +145 -145
  192. package/skills/golang-patterns/SKILL.md +676 -676
  193. package/skills/golang-testing/SKILL.md +721 -721
  194. package/skills/google-workspace-ops/SKILL.md +96 -96
  195. package/skills/growth-log/SKILL.md +128 -128
  196. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  197. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  198. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  199. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  200. package/skills/hermes-imports/SKILL.md +89 -89
  201. package/skills/hexagonal-architecture/SKILL.md +277 -277
  202. package/skills/hipaa-compliance/SKILL.md +79 -79
  203. package/skills/homelab-network-readiness/SKILL.md +170 -170
  204. package/skills/homelab-network-setup/SKILL.md +130 -130
  205. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  206. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  207. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  208. package/skills/hookify-rules/SKILL.md +128 -128
  209. package/skills/inherit-legacy-style/SKILL.md +157 -157
  210. package/skills/intent-driven-development/SKILL.md +360 -360
  211. package/skills/inventory-demand-planning/SKILL.md +247 -247
  212. package/skills/investor-materials/SKILL.md +97 -97
  213. package/skills/investor-outreach/SKILL.md +92 -92
  214. package/skills/ios-icon-gen/SKILL.md +158 -158
  215. package/skills/iterative-retrieval/SKILL.md +212 -212
  216. package/skills/ito-basket-compare/SKILL.md +64 -64
  217. package/skills/ito-compute/SKILL.md +129 -129
  218. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  219. package/skills/ito-market-intelligence/SKILL.md +61 -61
  220. package/skills/ito-trade-planner/SKILL.md +68 -68
  221. package/skills/java-coding-standards/SKILL.md +384 -384
  222. package/skills/jira-integration/SKILL.md +303 -303
  223. package/skills/jpa-patterns/SKILL.md +152 -152
  224. package/skills/knowledge-ops/SKILL.md +155 -155
  225. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  226. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  227. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  228. package/skills/kotlin-patterns/SKILL.md +712 -712
  229. package/skills/kotlin-testing/SKILL.md +825 -825
  230. package/skills/kubernetes-patterns/SKILL.md +756 -756
  231. package/skills/laravel-patterns/SKILL.md +416 -416
  232. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  233. package/skills/laravel-security/SKILL.md +948 -948
  234. package/skills/laravel-tdd/SKILL.md +675 -675
  235. package/skills/laravel-verification/SKILL.md +180 -180
  236. package/skills/latency-critical-systems/SKILL.md +75 -75
  237. package/skills/lead-intelligence/SKILL.md +322 -322
  238. package/skills/liquid-glass-design/SKILL.md +279 -279
  239. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  240. package/skills/logistics-exception-management/SKILL.md +222 -222
  241. package/skills/loop-design-check/SKILL.md +143 -143
  242. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  243. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  244. package/skills/manim-video/SKILL.md +90 -90
  245. package/skills/market-research/SKILL.md +76 -76
  246. package/skills/marketing-campaign/SKILL.md +114 -114
  247. package/skills/mcp-server-patterns/SKILL.md +70 -70
  248. package/skills/messages-ops/SKILL.md +105 -105
  249. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  250. package/skills/mle-workflow/SKILL.md +348 -348
  251. package/skills/motion-advanced/SKILL.md +596 -596
  252. package/skills/motion-foundations/SKILL.md +299 -299
  253. package/skills/motion-patterns/SKILL.md +434 -434
  254. package/skills/motion-ui/SKILL.md +576 -576
  255. package/skills/mysql-patterns/SKILL.md +413 -413
  256. package/skills/nanoclaw-repl/SKILL.md +34 -34
  257. package/skills/nestjs-patterns/SKILL.md +231 -231
  258. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  259. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  260. package/skills/network-config-validation/SKILL.md +211 -211
  261. package/skills/network-interface-health/SKILL.md +153 -153
  262. package/skills/nextjs-turbopack/SKILL.md +58 -58
  263. package/skills/nodejs-keccak256/SKILL.md +103 -103
  264. package/skills/nutrient-document-processing/SKILL.md +168 -168
  265. package/skills/nuxt4-patterns/SKILL.md +101 -101
  266. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  267. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  268. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  269. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  270. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  271. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  272. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  273. package/skills/opensource-pipeline/SKILL.md +256 -256
  274. package/skills/orch-add-feature/SKILL.md +45 -45
  275. package/skills/orch-build-mvp/SKILL.md +49 -49
  276. package/skills/orch-change-feature/SKILL.md +43 -43
  277. package/skills/orch-fix-defect/SKILL.md +43 -43
  278. package/skills/orch-pipeline/SKILL.md +121 -121
  279. package/skills/orch-refine-code/SKILL.md +44 -44
  280. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  281. package/skills/perl-patterns/SKILL.md +505 -505
  282. package/skills/perl-security/SKILL.md +504 -504
  283. package/skills/perl-testing/SKILL.md +476 -476
  284. package/skills/plan-canvas/SKILL.md +153 -153
  285. package/skills/plan-orchestrate/SKILL.md +263 -263
  286. package/skills/plankton-code-quality/SKILL.md +237 -237
  287. package/skills/postgres-patterns/SKILL.md +148 -148
  288. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  289. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  290. package/skills/premium-web-design/SKILL.md +154 -154
  291. package/skills/prisma-patterns/SKILL.md +401 -401
  292. package/skills/product-capability/SKILL.md +142 -142
  293. package/skills/product-lens/SKILL.md +93 -93
  294. package/skills/production-audit/SKILL.md +207 -207
  295. package/skills/production-scheduling/SKILL.md +238 -238
  296. package/skills/project-flow-ops/SKILL.md +112 -112
  297. package/skills/prompt-optimizer/SKILL.md +398 -398
  298. package/skills/python-patterns/SKILL.md +751 -751
  299. package/skills/python-testing/SKILL.md +817 -817
  300. package/skills/pytorch-patterns/SKILL.md +397 -397
  301. package/skills/quality-nonconformance/SKILL.md +260 -260
  302. package/skills/quarkus-patterns/SKILL.md +723 -723
  303. package/skills/quarkus-security/SKILL.md +468 -468
  304. package/skills/quarkus-tdd/SKILL.md +812 -812
  305. package/skills/quarkus-verification/SKILL.md +480 -480
  306. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  307. package/skills/react-native-patterns/SKILL.md +326 -326
  308. package/skills/react-patterns/SKILL.md +342 -342
  309. package/skills/react-performance/SKILL.md +575 -575
  310. package/skills/react-testing/SKILL.md +424 -424
  311. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  312. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  313. package/skills/redis-patterns/SKILL.md +404 -404
  314. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  315. package/skills/remotion-video-creation/SKILL.md +43 -43
  316. package/skills/repo-scan/SKILL.md +79 -79
  317. package/skills/research-ops/SKILL.md +113 -113
  318. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  319. package/skills/rules-distill/SKILL.md +265 -265
  320. package/skills/rust-patterns/SKILL.md +500 -500
  321. package/skills/rust-testing/SKILL.md +501 -501
  322. package/skills/safety-guard/SKILL.md +76 -76
  323. package/skills/santa-method/SKILL.md +307 -307
  324. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  325. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  326. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  327. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  328. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  329. package/skills/search-first/SKILL.md +183 -183
  330. package/skills/security-bounty-hunter/SKILL.md +100 -100
  331. package/skills/security-review/SKILL.md +504 -504
  332. package/skills/security-scan/SKILL.md +166 -166
  333. package/skills/seo/SKILL.md +155 -155
  334. package/skills/skill-comply/SKILL.md +59 -59
  335. package/skills/skill-scout/SKILL.md +141 -141
  336. package/skills/skill-stocktake/SKILL.md +195 -195
  337. package/skills/social-graph-ranker/SKILL.md +155 -155
  338. package/skills/social-publisher/SKILL.md +130 -130
  339. package/skills/springboot-patterns/SKILL.md +315 -315
  340. package/skills/springboot-security/SKILL.md +273 -273
  341. package/skills/springboot-tdd/SKILL.md +159 -159
  342. package/skills/springboot-verification/SKILL.md +232 -232
  343. package/skills/strategic-compact/SKILL.md +142 -142
  344. package/skills/swift-actor-persistence/SKILL.md +144 -144
  345. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  346. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  347. package/skills/swiftui-patterns/SKILL.md +259 -259
  348. package/skills/taste/SKILL.md +264 -264
  349. package/skills/taste/references/genre-taxonomy.md +87 -87
  350. package/skills/tdd-workflow/SKILL.md +583 -583
  351. package/skills/team-agent-orchestration/SKILL.md +111 -111
  352. package/skills/team-builder/SKILL.md +169 -169
  353. package/skills/terminal-ops/SKILL.md +110 -110
  354. package/skills/tinystruct-patterns/SKILL.md +279 -279
  355. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  356. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  357. package/skills/tinystruct-patterns/references/database.md +99 -99
  358. package/skills/tinystruct-patterns/references/routing.md +64 -64
  359. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  360. package/skills/tinystruct-patterns/references/testing.md +72 -72
  361. package/skills/token-budget-advisor/SKILL.md +134 -134
  362. package/skills/ui-demo/SKILL.md +466 -466
  363. package/skills/ui-to-vue/SKILL.md +135 -135
  364. package/skills/uncloud/SKILL.md +344 -344
  365. package/skills/unified-memory/SKILL.md +170 -170
  366. package/skills/unified-notifications-ops/SKILL.md +188 -188
  367. package/skills/verification-loop/SKILL.md +129 -129
  368. package/skills/video-editing/SKILL.md +311 -311
  369. package/skills/videodb/SKILL.md +375 -375
  370. package/skills/visa-doc-translate/SKILL.md +117 -117
  371. package/skills/vite-patterns/SKILL.md +450 -450
  372. package/skills/vue-patterns/SKILL.md +471 -471
  373. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  374. package/skills/workspace-surface-audit/SKILL.md +126 -126
  375. package/skills/x-api/SKILL.md +235 -235
@@ -1,751 +1,751 @@
1
- ---
2
- name: python-patterns
3
- description: Pythonic idioms, PEP 8 standards, type hints, and best practices for building robust, efficient, and maintainable Python applications.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Python Development Patterns
9
-
10
- Idiomatic Python patterns and best practices for building robust, efficient, and maintainable applications.
11
-
12
- ## When to Activate
13
-
14
- - Writing new Python code
15
- - Reviewing Python code
16
- - Refactoring existing Python code
17
- - Designing Python packages/modules
18
-
19
- ## Core Principles
20
-
21
- ### 1. Readability Counts
22
-
23
- Python prioritizes readability. Code should be obvious and easy to understand.
24
-
25
- ```python
26
- # Good: Clear and readable
27
- def get_active_users(users: list[User]) -> list[User]:
28
- """Return only active users from the provided list."""
29
- return [user for user in users if user.is_active]
30
-
31
-
32
- # Bad: Clever but confusing
33
- def get_active_users(u):
34
- return [x for x in u if x.a]
35
- ```
36
-
37
- ### 2. Explicit is Better Than Implicit
38
-
39
- Avoid magic; be clear about what your code does.
40
-
41
- ```python
42
- # Good: Explicit configuration
43
- import logging
44
-
45
- logging.basicConfig(
46
- level=logging.INFO,
47
- format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
48
- )
49
-
50
- # Bad: Hidden side effects
51
- import some_module
52
- some_module.setup() # What does this do?
53
- ```
54
-
55
- ### 3. EAFP - Easier to Ask Forgiveness Than Permission
56
-
57
- Python prefers exception handling over checking conditions.
58
-
59
- ```python
60
- # Good: EAFP style
61
- def get_value(dictionary: dict, key: str, default_value: Any = None) -> Any:
62
- try:
63
- return dictionary[key]
64
- except KeyError:
65
- return default_value
66
-
67
- # Bad: LBYL (Look Before You Leap) style
68
- def get_value(dictionary: dict, key: str, default_value: Any = None) -> Any:
69
- if key in dictionary:
70
- return dictionary[key]
71
- else:
72
- return default_value
73
- ```
74
-
75
- ## Type Hints
76
-
77
- ### Basic Type Annotations
78
-
79
- ```python
80
- from typing import Optional, List, Dict, Any
81
-
82
- def process_user(
83
- user_id: str,
84
- data: Dict[str, Any],
85
- active: bool = True
86
- ) -> Optional[User]:
87
- """Process a user and return the updated User or None."""
88
- if not active:
89
- return None
90
- return User(user_id, data)
91
- ```
92
-
93
- ### Modern Type Hints (Python 3.9+)
94
-
95
- ```python
96
- # Python 3.9+ - Use built-in types
97
- def process_items(items: list[str]) -> dict[str, int]:
98
- return {item: len(item) for item in items}
99
-
100
- # Python 3.8 and earlier - Use typing module
101
- from typing import List, Dict
102
-
103
- def process_items(items: List[str]) -> Dict[str, int]:
104
- return {item: len(item) for item in items}
105
- ```
106
-
107
- ### Type Aliases and TypeVar
108
-
109
- ```python
110
- from typing import TypeVar, Union
111
-
112
- # Type alias for complex types
113
- JSON = Union[dict[str, Any], list[Any], str, int, float, bool, None]
114
-
115
- def parse_json(data: str) -> JSON:
116
- return json.loads(data)
117
-
118
- # Generic types
119
- T = TypeVar('T')
120
-
121
- def first(items: list[T]) -> T | None:
122
- """Return the first item or None if list is empty."""
123
- return items[0] if items else None
124
- ```
125
-
126
- ### Protocol-Based Duck Typing
127
-
128
- ```python
129
- from typing import Protocol
130
-
131
- class Renderable(Protocol):
132
- def render(self) -> str:
133
- """Render the object to a string."""
134
-
135
- def render_all(items: list[Renderable]) -> str:
136
- """Render all items that implement the Renderable protocol."""
137
- return "\n".join(item.render() for item in items)
138
- ```
139
-
140
- ## Error Handling Patterns
141
-
142
- ### Specific Exception Handling
143
-
144
- ```python
145
- # Good: Catch specific exceptions
146
- def load_config(path: str) -> Config:
147
- try:
148
- with open(path) as f:
149
- return Config.from_json(f.read())
150
- except FileNotFoundError as e:
151
- raise ConfigError(f"Config file not found: {path}") from e
152
- except json.JSONDecodeError as e:
153
- raise ConfigError(f"Invalid JSON in config: {path}") from e
154
-
155
- # Bad: Bare except
156
- def load_config(path: str) -> Config:
157
- try:
158
- with open(path) as f:
159
- return Config.from_json(f.read())
160
- except:
161
- return None # Silent failure!
162
- ```
163
-
164
- ### Exception Chaining
165
-
166
- ```python
167
- def process_data(data: str) -> Result:
168
- try:
169
- parsed = json.loads(data)
170
- except json.JSONDecodeError as e:
171
- # Chain exceptions to preserve the traceback
172
- raise ValueError(f"Failed to parse data: {data}") from e
173
- ```
174
-
175
- ### Custom Exception Hierarchy
176
-
177
- ```python
178
- class AppError(Exception):
179
- """Base exception for all application errors."""
180
- pass
181
-
182
- class ValidationError(AppError):
183
- """Raised when input validation fails."""
184
- pass
185
-
186
- class NotFoundError(AppError):
187
- """Raised when a requested resource is not found."""
188
- pass
189
-
190
- # Usage
191
- def get_user(user_id: str) -> User:
192
- user = db.find_user(user_id)
193
- if not user:
194
- raise NotFoundError(f"User not found: {user_id}")
195
- return user
196
- ```
197
-
198
- ## Context Managers
199
-
200
- ### Resource Management
201
-
202
- ```python
203
- # Good: Using context managers
204
- def process_file(path: str) -> str:
205
- with open(path, 'r') as f:
206
- return f.read()
207
-
208
- # Bad: Manual resource management
209
- def process_file(path: str) -> str:
210
- f = open(path, 'r')
211
- try:
212
- return f.read()
213
- finally:
214
- f.close()
215
- ```
216
-
217
- ### Custom Context Managers
218
-
219
- ```python
220
- from contextlib import contextmanager
221
-
222
- @contextmanager
223
- def timer(name: str):
224
- """Context manager to time a block of code."""
225
- start = time.perf_counter()
226
- yield
227
- elapsed = time.perf_counter() - start
228
- print(f"{name} took {elapsed:.4f} seconds")
229
-
230
- # Usage
231
- with timer("data processing"):
232
- process_large_dataset()
233
- ```
234
-
235
- ### Context Manager Classes
236
-
237
- ```python
238
- class DatabaseTransaction:
239
- def __init__(self, connection):
240
- self.connection = connection
241
-
242
- def __enter__(self):
243
- self.connection.begin_transaction()
244
- return self
245
-
246
- def __exit__(self, exc_type, exc_val, exc_tb):
247
- if exc_type is None:
248
- self.connection.commit()
249
- else:
250
- self.connection.rollback()
251
- return False # Don't suppress exceptions
252
-
253
- # Usage
254
- with DatabaseTransaction(conn):
255
- user = conn.create_user(user_data)
256
- conn.create_profile(user.id, profile_data)
257
- ```
258
-
259
- ## Comprehensions and Generators
260
-
261
- ### List Comprehensions
262
-
263
- ```python
264
- # Good: List comprehension for simple transformations
265
- names = [user.name for user in users if user.is_active]
266
-
267
- # Bad: Manual loop
268
- names = []
269
- for user in users:
270
- if user.is_active:
271
- names.append(user.name)
272
-
273
- # Complex comprehensions should be expanded
274
- # Bad: Too complex
275
- result = [x * 2 for x in items if x > 0 if x % 2 == 0]
276
-
277
- # Good: Use a generator function
278
- def filter_and_transform(items: Iterable[int]) -> list[int]:
279
- result = []
280
- for x in items:
281
- if x > 0 and x % 2 == 0:
282
- result.append(x * 2)
283
- return result
284
- ```
285
-
286
- ### Generator Expressions
287
-
288
- ```python
289
- # Good: Generator for lazy evaluation
290
- total = sum(x * x for x in range(1_000_000))
291
-
292
- # Bad: Creates large intermediate list
293
- total = sum([x * x for x in range(1_000_000)])
294
- ```
295
-
296
- ### Generator Functions
297
-
298
- ```python
299
- def read_large_file(path: str) -> Iterator[str]:
300
- """Read a large file line by line."""
301
- with open(path) as f:
302
- for line in f:
303
- yield line.strip()
304
-
305
- # Usage
306
- for line in read_large_file("huge.txt"):
307
- process(line)
308
- ```
309
-
310
- ## Data Classes and Named Tuples
311
-
312
- ### Data Classes
313
-
314
- ```python
315
- from dataclasses import dataclass, field
316
- from datetime import datetime
317
-
318
- @dataclass
319
- class User:
320
- """User entity with automatic __init__, __repr__, and __eq__."""
321
- id: str
322
- name: str
323
- email: str
324
- created_at: datetime = field(default_factory=datetime.now)
325
- is_active: bool = True
326
-
327
- # Usage
328
- user = User(
329
- id="123",
330
- name="Alice",
331
- email="alice@example.com"
332
- )
333
- ```
334
-
335
- ### Data Classes with Validation
336
-
337
- ```python
338
- @dataclass
339
- class User:
340
- email: str
341
- age: int
342
-
343
- def __post_init__(self):
344
- # Validate email format
345
- if "@" not in self.email:
346
- raise ValueError(f"Invalid email: {self.email}")
347
- # Validate age range
348
- if self.age < 0 or self.age > 150:
349
- raise ValueError(f"Invalid age: {self.age}")
350
- ```
351
-
352
- ### Named Tuples
353
-
354
- ```python
355
- from typing import NamedTuple
356
-
357
- class Point(NamedTuple):
358
- """Immutable 2D point."""
359
- x: float
360
- y: float
361
-
362
- def distance(self, other: 'Point') -> float:
363
- return ((self.x - other.x) ** 2 + (self.y - other.y) ** 2) ** 0.5
364
-
365
- # Usage
366
- p1 = Point(0, 0)
367
- p2 = Point(3, 4)
368
- print(p1.distance(p2)) # 5.0
369
- ```
370
-
371
- ## Decorators
372
-
373
- ### Function Decorators
374
-
375
- ```python
376
- import functools
377
- import time
378
-
379
- def timer(func: Callable) -> Callable:
380
- """Decorator to time function execution."""
381
- @functools.wraps(func)
382
- def wrapper(*args, **kwargs):
383
- start = time.perf_counter()
384
- result = func(*args, **kwargs)
385
- elapsed = time.perf_counter() - start
386
- print(f"{func.__name__} took {elapsed:.4f}s")
387
- return result
388
- return wrapper
389
-
390
- @timer
391
- def slow_function():
392
- time.sleep(1)
393
-
394
- # slow_function() prints: slow_function took 1.0012s
395
- ```
396
-
397
- ### Parameterized Decorators
398
-
399
- ```python
400
- def repeat(times: int):
401
- """Decorator to repeat a function multiple times."""
402
- def decorator(func: Callable) -> Callable:
403
- @functools.wraps(func)
404
- def wrapper(*args, **kwargs):
405
- results = []
406
- for _ in range(times):
407
- results.append(func(*args, **kwargs))
408
- return results
409
- return wrapper
410
- return decorator
411
-
412
- @repeat(times=3)
413
- def greet(name: str) -> str:
414
- return f"Hello, {name}!"
415
-
416
- # greet("Alice") returns ["Hello, Alice!", "Hello, Alice!", "Hello, Alice!"]
417
- ```
418
-
419
- ### Class-Based Decorators
420
-
421
- ```python
422
- class CountCalls:
423
- """Decorator that counts how many times a function is called."""
424
- def __init__(self, func: Callable):
425
- functools.update_wrapper(self, func)
426
- self.func = func
427
- self.count = 0
428
-
429
- def __call__(self, *args, **kwargs):
430
- self.count += 1
431
- print(f"{self.func.__name__} has been called {self.count} times")
432
- return self.func(*args, **kwargs)
433
-
434
- @CountCalls
435
- def process():
436
- pass
437
-
438
- # Each call to process() prints the call count
439
- ```
440
-
441
- ## Concurrency Patterns
442
-
443
- ### Threading for I/O-Bound Tasks
444
-
445
- ```python
446
- import concurrent.futures
447
- import threading
448
-
449
- def fetch_url(url: str) -> str:
450
- """Fetch a URL (I/O-bound operation)."""
451
- import urllib.request
452
- with urllib.request.urlopen(url) as response:
453
- return response.read().decode()
454
-
455
- def fetch_all_urls(urls: list[str]) -> dict[str, str]:
456
- """Fetch multiple URLs concurrently using threads."""
457
- with concurrent.futures.ThreadPoolExecutor(max_workers=10) as executor:
458
- future_to_url = {executor.submit(fetch_url, url): url for url in urls}
459
- results = {}
460
- for future in concurrent.futures.as_completed(future_to_url):
461
- url = future_to_url[future]
462
- try:
463
- results[url] = future.result()
464
- except Exception as e:
465
- results[url] = f"Error: {e}"
466
- return results
467
- ```
468
-
469
- ### Multiprocessing for CPU-Bound Tasks
470
-
471
- ```python
472
- def process_data(data: list[int]) -> int:
473
- """CPU-intensive computation."""
474
- return sum(x ** 2 for x in data)
475
-
476
- def process_all(datasets: list[list[int]]) -> list[int]:
477
- """Process multiple datasets using multiple processes."""
478
- with concurrent.futures.ProcessPoolExecutor() as executor:
479
- results = list(executor.map(process_data, datasets))
480
- return results
481
- ```
482
-
483
- ### Async/Await for Concurrent I/O
484
-
485
- ```python
486
- import asyncio
487
-
488
- async def fetch_async(url: str) -> str:
489
- """Fetch a URL asynchronously."""
490
- import aiohttp
491
- async with aiohttp.ClientSession() as session:
492
- async with session.get(url) as response:
493
- return await response.text()
494
-
495
- async def fetch_all(urls: list[str]) -> dict[str, str]:
496
- """Fetch multiple URLs concurrently."""
497
- tasks = [fetch_async(url) for url in urls]
498
- results = await asyncio.gather(*tasks, return_exceptions=True)
499
- return dict(zip(urls, results))
500
- ```
501
-
502
- ## Package Organization
503
-
504
- ### Standard Project Layout
505
-
506
- ```
507
- myproject/
508
- ├── src/
509
- │ └── mypackage/
510
- │ ├── __init__.py
511
- │ ├── main.py
512
- │ ├── api/
513
- │ │ ├── __init__.py
514
- │ │ └── routes.py
515
- │ ├── models/
516
- │ │ ├── __init__.py
517
- │ │ └── user.py
518
- │ └── utils/
519
- │ ├── __init__.py
520
- │ └── helpers.py
521
- ├── tests/
522
- │ ├── __init__.py
523
- │ ├── conftest.py
524
- │ ├── test_api.py
525
- │ └── test_models.py
526
- ├── pyproject.toml
527
- ├── README.md
528
- └── .gitignore
529
- ```
530
-
531
- ### Import Conventions
532
-
533
- ```python
534
- # Good: Import order - stdlib, third-party, local
535
- import os
536
- import sys
537
- from pathlib import Path
538
-
539
- import requests
540
- from fastapi import FastAPI
541
-
542
- from mypackage.models import User
543
- from mypackage.utils import format_name
544
-
545
- # Good: Use isort for automatic import sorting
546
- # pip install isort
547
- ```
548
-
549
- ### __init__.py for Package Exports
550
-
551
- ```python
552
- # mypackage/__init__.py
553
- """mypackage - A sample Python package."""
554
-
555
- __version__ = "1.0.0"
556
-
557
- # Export main classes/functions at package level
558
- from mypackage.models import User, Post
559
- from mypackage.utils import format_name
560
-
561
- __all__ = ["User", "Post", "format_name"]
562
- ```
563
-
564
- ## Memory and Performance
565
-
566
- ### Using __slots__ for Memory Efficiency
567
-
568
- ```python
569
- # Bad: Regular class uses __dict__ (more memory)
570
- class Point:
571
- def __init__(self, x: float, y: float):
572
- self.x = x
573
- self.y = y
574
-
575
- # Good: __slots__ reduces memory usage
576
- class Point:
577
- __slots__ = ['x', 'y']
578
-
579
- def __init__(self, x: float, y: float):
580
- self.x = x
581
- self.y = y
582
- ```
583
-
584
- ### Generator for Large Data
585
-
586
- ```python
587
- # Bad: Returns full list in memory
588
- def read_lines(path: str) -> list[str]:
589
- with open(path) as f:
590
- return [line.strip() for line in f]
591
-
592
- # Good: Yields lines one at a time
593
- def read_lines(path: str) -> Iterator[str]:
594
- with open(path) as f:
595
- for line in f:
596
- yield line.strip()
597
- ```
598
-
599
- ### Avoid String Concatenation in Loops
600
-
601
- ```python
602
- # Bad: O(n²) due to string immutability
603
- result = ""
604
- for item in items:
605
- result += str(item)
606
-
607
- # Good: O(n) using join
608
- result = "".join(str(item) for item in items)
609
-
610
- # Good: Using StringIO for building
611
- from io import StringIO
612
-
613
- buffer = StringIO()
614
- for item in items:
615
- buffer.write(str(item))
616
- result = buffer.getvalue()
617
- ```
618
-
619
- ## Python Tooling Integration
620
-
621
- ### Essential Commands
622
-
623
- ```bash
624
- # Code formatting
625
- black .
626
- isort .
627
-
628
- # Linting
629
- ruff check .
630
- pylint mypackage/
631
-
632
- # Type checking
633
- mypy .
634
-
635
- # Testing
636
- pytest --cov=mypackage --cov-report=html
637
-
638
- # Security scanning
639
- bandit -r .
640
-
641
- # Dependency management
642
- pip-audit
643
- safety check
644
- ```
645
-
646
- ### pyproject.toml Configuration
647
-
648
- ```toml
649
- [project]
650
- name = "mypackage"
651
- version = "1.0.0"
652
- requires-python = ">=3.9"
653
- dependencies = [
654
- "requests>=2.31.0",
655
- "pydantic>=2.0.0",
656
- ]
657
-
658
- [project.optional-dependencies]
659
- dev = [
660
- "pytest>=7.4.0",
661
- "pytest-cov>=4.1.0",
662
- "black>=23.0.0",
663
- "ruff>=0.1.0",
664
- "mypy>=1.5.0",
665
- ]
666
-
667
- [tool.black]
668
- line-length = 88
669
- target-version = ['py39']
670
-
671
- [tool.ruff]
672
- line-length = 88
673
- select = ["E", "F", "I", "N", "W"]
674
-
675
- [tool.mypy]
676
- python_version = "3.9"
677
- warn_return_any = true
678
- warn_unused_configs = true
679
- disallow_untyped_defs = true
680
-
681
- [tool.pytest.ini_options]
682
- testpaths = ["tests"]
683
- addopts = "--cov=mypackage --cov-report=term-missing"
684
- ```
685
-
686
- ## Quick Reference: Python Idioms
687
-
688
- | Idiom | Description |
689
- |-------|-------------|
690
- | EAFP | Easier to Ask Forgiveness than Permission |
691
- | Context managers | Use `with` for resource management |
692
- | List comprehensions | For simple transformations |
693
- | Generators | For lazy evaluation and large datasets |
694
- | Type hints | Annotate function signatures |
695
- | Dataclasses | For data containers with auto-generated methods |
696
- | `__slots__` | For memory optimization |
697
- | f-strings | For string formatting (Python 3.6+) |
698
- | `pathlib.Path` | For path operations (Python 3.4+) |
699
- | `enumerate` | For index-element pairs in loops |
700
-
701
- ## Anti-Patterns to Avoid
702
-
703
- ```python
704
- # Bad: Mutable default arguments
705
- def append_to(item, items=[]):
706
- items.append(item)
707
- return items
708
-
709
- # Good: Use None and create new list
710
- def append_to(item, items=None):
711
- if items is None:
712
- items = []
713
- items.append(item)
714
- return items
715
-
716
- # Bad: Checking type with type()
717
- if type(obj) == list:
718
- process(obj)
719
-
720
- # Good: Use isinstance
721
- if isinstance(obj, list):
722
- process(obj)
723
-
724
- # Bad: Comparing to None with ==
725
- if value == None:
726
- process()
727
-
728
- # Good: Use is
729
- if value is None:
730
- process()
731
-
732
- # Bad: from module import *
733
- from os.path import *
734
-
735
- # Good: Explicit imports
736
- from os.path import join, exists
737
-
738
- # Bad: Bare except
739
- try:
740
- risky_operation()
741
- except:
742
- pass
743
-
744
- # Good: Specific exception
745
- try:
746
- risky_operation()
747
- except SpecificError as e:
748
- logger.error(f"Operation failed: {e}")
749
- ```
750
-
751
- __Remember__: Python code should be readable, explicit, and follow the principle of least surprise. When in doubt, prioritize clarity over cleverness.
1
+ ---
2
+ name: python-patterns
3
+ description: Pythonic idioms, PEP 8 standards, type hints, and best practices for building robust, efficient, and maintainable Python applications.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Python Development Patterns
9
+
10
+ Idiomatic Python patterns and best practices for building robust, efficient, and maintainable applications.
11
+
12
+ ## When to Activate
13
+
14
+ - Writing new Python code
15
+ - Reviewing Python code
16
+ - Refactoring existing Python code
17
+ - Designing Python packages/modules
18
+
19
+ ## Core Principles
20
+
21
+ ### 1. Readability Counts
22
+
23
+ Python prioritizes readability. Code should be obvious and easy to understand.
24
+
25
+ ```python
26
+ # Good: Clear and readable
27
+ def get_active_users(users: list[User]) -> list[User]:
28
+ """Return only active users from the provided list."""
29
+ return [user for user in users if user.is_active]
30
+
31
+
32
+ # Bad: Clever but confusing
33
+ def get_active_users(u):
34
+ return [x for x in u if x.a]
35
+ ```
36
+
37
+ ### 2. Explicit is Better Than Implicit
38
+
39
+ Avoid magic; be clear about what your code does.
40
+
41
+ ```python
42
+ # Good: Explicit configuration
43
+ import logging
44
+
45
+ logging.basicConfig(
46
+ level=logging.INFO,
47
+ format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
48
+ )
49
+
50
+ # Bad: Hidden side effects
51
+ import some_module
52
+ some_module.setup() # What does this do?
53
+ ```
54
+
55
+ ### 3. EAFP - Easier to Ask Forgiveness Than Permission
56
+
57
+ Python prefers exception handling over checking conditions.
58
+
59
+ ```python
60
+ # Good: EAFP style
61
+ def get_value(dictionary: dict, key: str, default_value: Any = None) -> Any:
62
+ try:
63
+ return dictionary[key]
64
+ except KeyError:
65
+ return default_value
66
+
67
+ # Bad: LBYL (Look Before You Leap) style
68
+ def get_value(dictionary: dict, key: str, default_value: Any = None) -> Any:
69
+ if key in dictionary:
70
+ return dictionary[key]
71
+ else:
72
+ return default_value
73
+ ```
74
+
75
+ ## Type Hints
76
+
77
+ ### Basic Type Annotations
78
+
79
+ ```python
80
+ from typing import Optional, List, Dict, Any
81
+
82
+ def process_user(
83
+ user_id: str,
84
+ data: Dict[str, Any],
85
+ active: bool = True
86
+ ) -> Optional[User]:
87
+ """Process a user and return the updated User or None."""
88
+ if not active:
89
+ return None
90
+ return User(user_id, data)
91
+ ```
92
+
93
+ ### Modern Type Hints (Python 3.9+)
94
+
95
+ ```python
96
+ # Python 3.9+ - Use built-in types
97
+ def process_items(items: list[str]) -> dict[str, int]:
98
+ return {item: len(item) for item in items}
99
+
100
+ # Python 3.8 and earlier - Use typing module
101
+ from typing import List, Dict
102
+
103
+ def process_items(items: List[str]) -> Dict[str, int]:
104
+ return {item: len(item) for item in items}
105
+ ```
106
+
107
+ ### Type Aliases and TypeVar
108
+
109
+ ```python
110
+ from typing import TypeVar, Union
111
+
112
+ # Type alias for complex types
113
+ JSON = Union[dict[str, Any], list[Any], str, int, float, bool, None]
114
+
115
+ def parse_json(data: str) -> JSON:
116
+ return json.loads(data)
117
+
118
+ # Generic types
119
+ T = TypeVar('T')
120
+
121
+ def first(items: list[T]) -> T | None:
122
+ """Return the first item or None if list is empty."""
123
+ return items[0] if items else None
124
+ ```
125
+
126
+ ### Protocol-Based Duck Typing
127
+
128
+ ```python
129
+ from typing import Protocol
130
+
131
+ class Renderable(Protocol):
132
+ def render(self) -> str:
133
+ """Render the object to a string."""
134
+
135
+ def render_all(items: list[Renderable]) -> str:
136
+ """Render all items that implement the Renderable protocol."""
137
+ return "\n".join(item.render() for item in items)
138
+ ```
139
+
140
+ ## Error Handling Patterns
141
+
142
+ ### Specific Exception Handling
143
+
144
+ ```python
145
+ # Good: Catch specific exceptions
146
+ def load_config(path: str) -> Config:
147
+ try:
148
+ with open(path) as f:
149
+ return Config.from_json(f.read())
150
+ except FileNotFoundError as e:
151
+ raise ConfigError(f"Config file not found: {path}") from e
152
+ except json.JSONDecodeError as e:
153
+ raise ConfigError(f"Invalid JSON in config: {path}") from e
154
+
155
+ # Bad: Bare except
156
+ def load_config(path: str) -> Config:
157
+ try:
158
+ with open(path) as f:
159
+ return Config.from_json(f.read())
160
+ except:
161
+ return None # Silent failure!
162
+ ```
163
+
164
+ ### Exception Chaining
165
+
166
+ ```python
167
+ def process_data(data: str) -> Result:
168
+ try:
169
+ parsed = json.loads(data)
170
+ except json.JSONDecodeError as e:
171
+ # Chain exceptions to preserve the traceback
172
+ raise ValueError(f"Failed to parse data: {data}") from e
173
+ ```
174
+
175
+ ### Custom Exception Hierarchy
176
+
177
+ ```python
178
+ class AppError(Exception):
179
+ """Base exception for all application errors."""
180
+ pass
181
+
182
+ class ValidationError(AppError):
183
+ """Raised when input validation fails."""
184
+ pass
185
+
186
+ class NotFoundError(AppError):
187
+ """Raised when a requested resource is not found."""
188
+ pass
189
+
190
+ # Usage
191
+ def get_user(user_id: str) -> User:
192
+ user = db.find_user(user_id)
193
+ if not user:
194
+ raise NotFoundError(f"User not found: {user_id}")
195
+ return user
196
+ ```
197
+
198
+ ## Context Managers
199
+
200
+ ### Resource Management
201
+
202
+ ```python
203
+ # Good: Using context managers
204
+ def process_file(path: str) -> str:
205
+ with open(path, 'r') as f:
206
+ return f.read()
207
+
208
+ # Bad: Manual resource management
209
+ def process_file(path: str) -> str:
210
+ f = open(path, 'r')
211
+ try:
212
+ return f.read()
213
+ finally:
214
+ f.close()
215
+ ```
216
+
217
+ ### Custom Context Managers
218
+
219
+ ```python
220
+ from contextlib import contextmanager
221
+
222
+ @contextmanager
223
+ def timer(name: str):
224
+ """Context manager to time a block of code."""
225
+ start = time.perf_counter()
226
+ yield
227
+ elapsed = time.perf_counter() - start
228
+ print(f"{name} took {elapsed:.4f} seconds")
229
+
230
+ # Usage
231
+ with timer("data processing"):
232
+ process_large_dataset()
233
+ ```
234
+
235
+ ### Context Manager Classes
236
+
237
+ ```python
238
+ class DatabaseTransaction:
239
+ def __init__(self, connection):
240
+ self.connection = connection
241
+
242
+ def __enter__(self):
243
+ self.connection.begin_transaction()
244
+ return self
245
+
246
+ def __exit__(self, exc_type, exc_val, exc_tb):
247
+ if exc_type is None:
248
+ self.connection.commit()
249
+ else:
250
+ self.connection.rollback()
251
+ return False # Don't suppress exceptions
252
+
253
+ # Usage
254
+ with DatabaseTransaction(conn):
255
+ user = conn.create_user(user_data)
256
+ conn.create_profile(user.id, profile_data)
257
+ ```
258
+
259
+ ## Comprehensions and Generators
260
+
261
+ ### List Comprehensions
262
+
263
+ ```python
264
+ # Good: List comprehension for simple transformations
265
+ names = [user.name for user in users if user.is_active]
266
+
267
+ # Bad: Manual loop
268
+ names = []
269
+ for user in users:
270
+ if user.is_active:
271
+ names.append(user.name)
272
+
273
+ # Complex comprehensions should be expanded
274
+ # Bad: Too complex
275
+ result = [x * 2 for x in items if x > 0 if x % 2 == 0]
276
+
277
+ # Good: Use a generator function
278
+ def filter_and_transform(items: Iterable[int]) -> list[int]:
279
+ result = []
280
+ for x in items:
281
+ if x > 0 and x % 2 == 0:
282
+ result.append(x * 2)
283
+ return result
284
+ ```
285
+
286
+ ### Generator Expressions
287
+
288
+ ```python
289
+ # Good: Generator for lazy evaluation
290
+ total = sum(x * x for x in range(1_000_000))
291
+
292
+ # Bad: Creates large intermediate list
293
+ total = sum([x * x for x in range(1_000_000)])
294
+ ```
295
+
296
+ ### Generator Functions
297
+
298
+ ```python
299
+ def read_large_file(path: str) -> Iterator[str]:
300
+ """Read a large file line by line."""
301
+ with open(path) as f:
302
+ for line in f:
303
+ yield line.strip()
304
+
305
+ # Usage
306
+ for line in read_large_file("huge.txt"):
307
+ process(line)
308
+ ```
309
+
310
+ ## Data Classes and Named Tuples
311
+
312
+ ### Data Classes
313
+
314
+ ```python
315
+ from dataclasses import dataclass, field
316
+ from datetime import datetime
317
+
318
+ @dataclass
319
+ class User:
320
+ """User entity with automatic __init__, __repr__, and __eq__."""
321
+ id: str
322
+ name: str
323
+ email: str
324
+ created_at: datetime = field(default_factory=datetime.now)
325
+ is_active: bool = True
326
+
327
+ # Usage
328
+ user = User(
329
+ id="123",
330
+ name="Alice",
331
+ email="alice@example.com"
332
+ )
333
+ ```
334
+
335
+ ### Data Classes with Validation
336
+
337
+ ```python
338
+ @dataclass
339
+ class User:
340
+ email: str
341
+ age: int
342
+
343
+ def __post_init__(self):
344
+ # Validate email format
345
+ if "@" not in self.email:
346
+ raise ValueError(f"Invalid email: {self.email}")
347
+ # Validate age range
348
+ if self.age < 0 or self.age > 150:
349
+ raise ValueError(f"Invalid age: {self.age}")
350
+ ```
351
+
352
+ ### Named Tuples
353
+
354
+ ```python
355
+ from typing import NamedTuple
356
+
357
+ class Point(NamedTuple):
358
+ """Immutable 2D point."""
359
+ x: float
360
+ y: float
361
+
362
+ def distance(self, other: 'Point') -> float:
363
+ return ((self.x - other.x) ** 2 + (self.y - other.y) ** 2) ** 0.5
364
+
365
+ # Usage
366
+ p1 = Point(0, 0)
367
+ p2 = Point(3, 4)
368
+ print(p1.distance(p2)) # 5.0
369
+ ```
370
+
371
+ ## Decorators
372
+
373
+ ### Function Decorators
374
+
375
+ ```python
376
+ import functools
377
+ import time
378
+
379
+ def timer(func: Callable) -> Callable:
380
+ """Decorator to time function execution."""
381
+ @functools.wraps(func)
382
+ def wrapper(*args, **kwargs):
383
+ start = time.perf_counter()
384
+ result = func(*args, **kwargs)
385
+ elapsed = time.perf_counter() - start
386
+ print(f"{func.__name__} took {elapsed:.4f}s")
387
+ return result
388
+ return wrapper
389
+
390
+ @timer
391
+ def slow_function():
392
+ time.sleep(1)
393
+
394
+ # slow_function() prints: slow_function took 1.0012s
395
+ ```
396
+
397
+ ### Parameterized Decorators
398
+
399
+ ```python
400
+ def repeat(times: int):
401
+ """Decorator to repeat a function multiple times."""
402
+ def decorator(func: Callable) -> Callable:
403
+ @functools.wraps(func)
404
+ def wrapper(*args, **kwargs):
405
+ results = []
406
+ for _ in range(times):
407
+ results.append(func(*args, **kwargs))
408
+ return results
409
+ return wrapper
410
+ return decorator
411
+
412
+ @repeat(times=3)
413
+ def greet(name: str) -> str:
414
+ return f"Hello, {name}!"
415
+
416
+ # greet("Alice") returns ["Hello, Alice!", "Hello, Alice!", "Hello, Alice!"]
417
+ ```
418
+
419
+ ### Class-Based Decorators
420
+
421
+ ```python
422
+ class CountCalls:
423
+ """Decorator that counts how many times a function is called."""
424
+ def __init__(self, func: Callable):
425
+ functools.update_wrapper(self, func)
426
+ self.func = func
427
+ self.count = 0
428
+
429
+ def __call__(self, *args, **kwargs):
430
+ self.count += 1
431
+ print(f"{self.func.__name__} has been called {self.count} times")
432
+ return self.func(*args, **kwargs)
433
+
434
+ @CountCalls
435
+ def process():
436
+ pass
437
+
438
+ # Each call to process() prints the call count
439
+ ```
440
+
441
+ ## Concurrency Patterns
442
+
443
+ ### Threading for I/O-Bound Tasks
444
+
445
+ ```python
446
+ import concurrent.futures
447
+ import threading
448
+
449
+ def fetch_url(url: str) -> str:
450
+ """Fetch a URL (I/O-bound operation)."""
451
+ import urllib.request
452
+ with urllib.request.urlopen(url) as response:
453
+ return response.read().decode()
454
+
455
+ def fetch_all_urls(urls: list[str]) -> dict[str, str]:
456
+ """Fetch multiple URLs concurrently using threads."""
457
+ with concurrent.futures.ThreadPoolExecutor(max_workers=10) as executor:
458
+ future_to_url = {executor.submit(fetch_url, url): url for url in urls}
459
+ results = {}
460
+ for future in concurrent.futures.as_completed(future_to_url):
461
+ url = future_to_url[future]
462
+ try:
463
+ results[url] = future.result()
464
+ except Exception as e:
465
+ results[url] = f"Error: {e}"
466
+ return results
467
+ ```
468
+
469
+ ### Multiprocessing for CPU-Bound Tasks
470
+
471
+ ```python
472
+ def process_data(data: list[int]) -> int:
473
+ """CPU-intensive computation."""
474
+ return sum(x ** 2 for x in data)
475
+
476
+ def process_all(datasets: list[list[int]]) -> list[int]:
477
+ """Process multiple datasets using multiple processes."""
478
+ with concurrent.futures.ProcessPoolExecutor() as executor:
479
+ results = list(executor.map(process_data, datasets))
480
+ return results
481
+ ```
482
+
483
+ ### Async/Await for Concurrent I/O
484
+
485
+ ```python
486
+ import asyncio
487
+
488
+ async def fetch_async(url: str) -> str:
489
+ """Fetch a URL asynchronously."""
490
+ import aiohttp
491
+ async with aiohttp.ClientSession() as session:
492
+ async with session.get(url) as response:
493
+ return await response.text()
494
+
495
+ async def fetch_all(urls: list[str]) -> dict[str, str]:
496
+ """Fetch multiple URLs concurrently."""
497
+ tasks = [fetch_async(url) for url in urls]
498
+ results = await asyncio.gather(*tasks, return_exceptions=True)
499
+ return dict(zip(urls, results))
500
+ ```
501
+
502
+ ## Package Organization
503
+
504
+ ### Standard Project Layout
505
+
506
+ ```
507
+ myproject/
508
+ ├── src/
509
+ │ └── mypackage/
510
+ │ ├── __init__.py
511
+ │ ├── main.py
512
+ │ ├── api/
513
+ │ │ ├── __init__.py
514
+ │ │ └── routes.py
515
+ │ ├── models/
516
+ │ │ ├── __init__.py
517
+ │ │ └── user.py
518
+ │ └── utils/
519
+ │ ├── __init__.py
520
+ │ └── helpers.py
521
+ ├── tests/
522
+ │ ├── __init__.py
523
+ │ ├── conftest.py
524
+ │ ├── test_api.py
525
+ │ └── test_models.py
526
+ ├── pyproject.toml
527
+ ├── README.md
528
+ └── .gitignore
529
+ ```
530
+
531
+ ### Import Conventions
532
+
533
+ ```python
534
+ # Good: Import order - stdlib, third-party, local
535
+ import os
536
+ import sys
537
+ from pathlib import Path
538
+
539
+ import requests
540
+ from fastapi import FastAPI
541
+
542
+ from mypackage.models import User
543
+ from mypackage.utils import format_name
544
+
545
+ # Good: Use isort for automatic import sorting
546
+ # pip install isort
547
+ ```
548
+
549
+ ### __init__.py for Package Exports
550
+
551
+ ```python
552
+ # mypackage/__init__.py
553
+ """mypackage - A sample Python package."""
554
+
555
+ __version__ = "1.0.0"
556
+
557
+ # Export main classes/functions at package level
558
+ from mypackage.models import User, Post
559
+ from mypackage.utils import format_name
560
+
561
+ __all__ = ["User", "Post", "format_name"]
562
+ ```
563
+
564
+ ## Memory and Performance
565
+
566
+ ### Using __slots__ for Memory Efficiency
567
+
568
+ ```python
569
+ # Bad: Regular class uses __dict__ (more memory)
570
+ class Point:
571
+ def __init__(self, x: float, y: float):
572
+ self.x = x
573
+ self.y = y
574
+
575
+ # Good: __slots__ reduces memory usage
576
+ class Point:
577
+ __slots__ = ['x', 'y']
578
+
579
+ def __init__(self, x: float, y: float):
580
+ self.x = x
581
+ self.y = y
582
+ ```
583
+
584
+ ### Generator for Large Data
585
+
586
+ ```python
587
+ # Bad: Returns full list in memory
588
+ def read_lines(path: str) -> list[str]:
589
+ with open(path) as f:
590
+ return [line.strip() for line in f]
591
+
592
+ # Good: Yields lines one at a time
593
+ def read_lines(path: str) -> Iterator[str]:
594
+ with open(path) as f:
595
+ for line in f:
596
+ yield line.strip()
597
+ ```
598
+
599
+ ### Avoid String Concatenation in Loops
600
+
601
+ ```python
602
+ # Bad: O(n²) due to string immutability
603
+ result = ""
604
+ for item in items:
605
+ result += str(item)
606
+
607
+ # Good: O(n) using join
608
+ result = "".join(str(item) for item in items)
609
+
610
+ # Good: Using StringIO for building
611
+ from io import StringIO
612
+
613
+ buffer = StringIO()
614
+ for item in items:
615
+ buffer.write(str(item))
616
+ result = buffer.getvalue()
617
+ ```
618
+
619
+ ## Python Tooling Integration
620
+
621
+ ### Essential Commands
622
+
623
+ ```bash
624
+ # Code formatting
625
+ black .
626
+ isort .
627
+
628
+ # Linting
629
+ ruff check .
630
+ pylint mypackage/
631
+
632
+ # Type checking
633
+ mypy .
634
+
635
+ # Testing
636
+ pytest --cov=mypackage --cov-report=html
637
+
638
+ # Security scanning
639
+ bandit -r .
640
+
641
+ # Dependency management
642
+ pip-audit
643
+ safety check
644
+ ```
645
+
646
+ ### pyproject.toml Configuration
647
+
648
+ ```toml
649
+ [project]
650
+ name = "mypackage"
651
+ version = "1.0.0"
652
+ requires-python = ">=3.9"
653
+ dependencies = [
654
+ "requests>=2.31.0",
655
+ "pydantic>=2.0.0",
656
+ ]
657
+
658
+ [project.optional-dependencies]
659
+ dev = [
660
+ "pytest>=7.4.0",
661
+ "pytest-cov>=4.1.0",
662
+ "black>=23.0.0",
663
+ "ruff>=0.1.0",
664
+ "mypy>=1.5.0",
665
+ ]
666
+
667
+ [tool.black]
668
+ line-length = 88
669
+ target-version = ['py39']
670
+
671
+ [tool.ruff]
672
+ line-length = 88
673
+ select = ["E", "F", "I", "N", "W"]
674
+
675
+ [tool.mypy]
676
+ python_version = "3.9"
677
+ warn_return_any = true
678
+ warn_unused_configs = true
679
+ disallow_untyped_defs = true
680
+
681
+ [tool.pytest.ini_options]
682
+ testpaths = ["tests"]
683
+ addopts = "--cov=mypackage --cov-report=term-missing"
684
+ ```
685
+
686
+ ## Quick Reference: Python Idioms
687
+
688
+ | Idiom | Description |
689
+ |-------|-------------|
690
+ | EAFP | Easier to Ask Forgiveness than Permission |
691
+ | Context managers | Use `with` for resource management |
692
+ | List comprehensions | For simple transformations |
693
+ | Generators | For lazy evaluation and large datasets |
694
+ | Type hints | Annotate function signatures |
695
+ | Dataclasses | For data containers with auto-generated methods |
696
+ | `__slots__` | For memory optimization |
697
+ | f-strings | For string formatting (Python 3.6+) |
698
+ | `pathlib.Path` | For path operations (Python 3.4+) |
699
+ | `enumerate` | For index-element pairs in loops |
700
+
701
+ ## Anti-Patterns to Avoid
702
+
703
+ ```python
704
+ # Bad: Mutable default arguments
705
+ def append_to(item, items=[]):
706
+ items.append(item)
707
+ return items
708
+
709
+ # Good: Use None and create new list
710
+ def append_to(item, items=None):
711
+ if items is None:
712
+ items = []
713
+ items.append(item)
714
+ return items
715
+
716
+ # Bad: Checking type with type()
717
+ if type(obj) == list:
718
+ process(obj)
719
+
720
+ # Good: Use isinstance
721
+ if isinstance(obj, list):
722
+ process(obj)
723
+
724
+ # Bad: Comparing to None with ==
725
+ if value == None:
726
+ process()
727
+
728
+ # Good: Use is
729
+ if value is None:
730
+ process()
731
+
732
+ # Bad: from module import *
733
+ from os.path import *
734
+
735
+ # Good: Explicit imports
736
+ from os.path import join, exists
737
+
738
+ # Bad: Bare except
739
+ try:
740
+ risky_operation()
741
+ except:
742
+ pass
743
+
744
+ # Good: Specific exception
745
+ try:
746
+ risky_operation()
747
+ except SpecificError as e:
748
+ logger.error(f"Operation failed: {e}")
749
+ ```
750
+
751
+ __Remember__: Python code should be readable, explicit, and follow the principle of least surprise. When in doubt, prioritize clarity over cleverness.