-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Description
This issue describes how to implement the with (keyword) concept docs.
You can find the related concept exercise issue here
If you have not yet contributed to concept documents, this issue will require some upfront reading to give you the needed background knowledge.
✅ Getting started
Please please read the docs before starting. Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time.
General Contributing Docs:
- Contributing to Exercism | Exercism and GitHub | - Contributor Pull Request Guide
- What are those Weird Task Tags about?
- Exercism Formatting and Style Guide
- Exercism Markdown Specification
- Reputation
Documents on Language Tracks and Concepts:
🎯 Goal
These concept docs are meant to teach an understanding/use of the with keyword and general context-handling in Python.
💡 Learning objectives
- What the
withkeyword is and what it does in Python- context-handling & scope
- setup and teardown processes
- memory and resource allocation
- How to use the
withkeyword - Most common use cases for managing resources with the
withkeyword- file opening/closing/processing
- database connectivity
- error handling
- logging
- testing
- thread management (
threading.Lock())
- Nested
withstatements, and how to use them - Gotchas and drawbacks of using
with
🚫 Out of scope
Concepts and Subjects that are Out of Scope
classes&class customizationclass-inheritancecomprehensionscomprehensionsinlambdascoroutiensdecoratorserror-handlingbeyond examples (error handling will have its own detailed exercise)raising errorsbeyond examples (error raising will have its own detailed exercise)functionsandhigher-order functionsbeyond what might be needed to work withwithfunctoolsand relatedmap(),filter()andfunctools.reduce()generatorsbeyond what might be needed to work withwith(they have their own exercise )lambdas- using an
assignment expressionor "walrus" operator (:=) enumstestingandassert(these will have their own detailed exercise)- The
csvmodule (this will get its own exercise)
🤔 Concepts
Concepts and Related Concepts this Concept Covers
withstatementcontext-managementcompound statements
↩️ Prerequisites
These are the concepts/concept exercises the student should be familiar with before taking on/learning this concept.
Prereqs
basicsboolscomparisonsdictsdict-methodsfunctionsfunctional-toolsgeneratorshigher-order-functionsiterationlistslist-methodsloopsnumberssequencessetsstringsstring-methodstuples
📚 Resources to refer to
Additional Articles
📁 Files to Be Created
File Detail for this Exercise
|
Please see the following for more details on these files: concepts
|
🎶 Implementation Notes
- Example code should only use syntax & concepts introduced within these docs or one of the prerequisite concept exercises or documents. Where possible, please use REPL formatting, unless you are demonstrating pseudo code or a long code block.
Please do not use syntax not previously covered in prerequisite topics or exercises. Please also follow PEP8 guidelines. - Our markdown and JSON files are checked against prettier . We recommend setting prettier up locally and running it prior to submitting your PR to avoid any CI errors.
🆘 Next Steps & Getting Help
If you'd like to work on this issue, comment saying "I'd like to work on this"(there is no real need to wait for a response, just go ahead, we'll assign you and put a[claimed]label on the issue).- If you have any questions while implementing, please post the questions as comments in here, or contact one of the maintainers on our Slack channel.