René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[New Concept Docs]: `itertools` Module","articleBody":"This issue describes how to implement the `itertools` module  **concept docs**.\r\nYou can find the related **concept exercise** issue [here](https://github.com/exercism/python/issues/3088)\r\n\r\nIf you have not yet contributed to concept documents, this issue will require some upfront reading to give you the needed background knowledge.\r\n\r\n## ✅   Getting started\r\n\r\n**`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. \r\n\r\n**General Contributing Docs:**\r\n\r\n- [Contributing to Exercism](https://exercism.org/docs/building) | [Exercism and GitHub](https://exercism.org/docs/building/github) | - [Contributor Pull Request Guide](https://exercism.org/docs/building/github/contributors-pull-request-guide)\r\n- [What are those Weird Task Tags about?](https://exercism.org/docs/building/product/tasks)\r\n- [Exercism Formatting and Style Guide](https://exercism.org/docs/building/markdown/style-guide)\r\n- [Exercism Markdown Specification](https://exercism.org/docs/building/markdown/markdown)\r\n- [Reputation](https://exercism.org/docs/using/product/reputation)  \r\n\r\n**Documents on Language Tracks and Concepts:**\r\n\r\n- [Building Language Tracks: An Overview](https://exercism.org/docs/building/tracks) \r\n- [What are Concepts?](https://exercism.org/docs/building/tracks/concepts)\r\n- [Concept Specifications](https://exercism.org/docs/building/tracks/concepts) \r\n\r\n\u003cbr\u003e\r\n\r\n## 🎯   Goal\r\n\r\nThese concept docs are meant to teach an understanding/use of the `itertools` module  in Python. \r\n\r\n\u003cbr\u003e\r\n\r\n## 💡   Learning objectives\r\n\r\nLearn more about `iteration` tools the Python Standard Library provides through the `itertools` module.\r\n\r\nBuild and understanding of and use the following functions  from the module, as well as practicing some of the [recipes](https://docs.python.org/3/library/itertools.html#itertools-recipes) included :\r\n\r\n- At least one of the _infinite itertators_ `count()`,`cycle()`,, or `repeat()`\r\n- `accumulate()`\r\n- `product()`\r\n- `chain()` \u0026 `chain.from_iterable()`\r\n- `groupby()`\r\n- `islice()`\r\n- `zip_longest()` and the `zip() built-in`\r\n- `permutations()`\r\n- `combinations()`\r\n\r\n\u003cbr\u003e\r\n\r\n## 🚫  Out of scope\r\n\r\n\u003cbr\u003e\r\n\u003cdetails\u003e\r\n\u003csummary\u003eConcepts \u0026 Subjects that are Out of Scope (\u003cem\u003eclick to expand\u003c/em\u003e)\u003c/summary\u003e\r\n\u003cbr\u003e\r\n\r\n- `classes`  \u0026 `class customization` beyond the use of the `itertools`  methods.\r\n- `class-inheritance` beyond what is needed to customize `iteration` using `itertools`\r\n- `comprehensions` beyond what is needed to work with `itertools`\r\n- `comprehensions` in `lambdas`\r\n- `coroutines` \r\n- `decorators` beyond what is needed to work with `itertools`\r\n- `functions` and `higher-order functions`  beyond what might be needed to work with `itertools`\r\n-  `functools` and related `map()`, `filter()` and `functools.reduce()`(_they have their own exercise which is a prerequisite to this one_)\r\n- `generators` beyond what might be needed to work with `itertools` (_they have their own exercise which is a prerequisite to this one_)\r\n- `lambdas`  beyond what might be needed to work with `itertools`\r\n- using an `assignment expression` or \"walrus\" operator (`:=`) \r\n- class decorators \r\n- `enums`\r\n\r\n\u003c/details\u003e\r\n\u003cbr\u003e\r\n\r\n## 🤔  Concepts\r\n\r\n- `iteration`\r\n- `iterators`\r\n- `itertools`\r\n\r\n\u003cbr\u003e\r\n\r\n## ↩️   Prerequisites\r\n\r\nThese are the concepts/concept exercises the student should be familiar with before taking on/learning this concept.  \r\n\r\n\u003cdetails\u003e\r\n\u003csummary\u003eExercise Prerequisites (\u003cem\u003eclick to expand\u003c/em\u003e)\u003c/summary\u003e\r\n\u003cbr\u003e\r\n\r\n- `basics`\r\n- `booleans`\r\n- `comparisons`\r\n- `rich-comparisons`\r\n- `dicts`\r\n- `dict-methods`\r\n- `functions`\r\n- `functional tools`\r\n- `generators`\r\n- `higher-order functions`\r\n- Identity methods `is` and `is not`\r\n- `iteration`\r\n- `lists`\r\n- `list-methods`\r\n- `loops`\r\n- `numbers`\r\n- `sequences`\r\n- `sets`\r\n- `strings`\r\n- `string-methods`\r\n- `tuples`\r\n\r\n\u003c/details\u003e\r\n\r\n\u003cbr\u003e\r\n\r\n## 📚  Resources to refer to\r\n\r\n\u003cdetails\u003e\r\n\u003csummary\u003eResources (\u003cem\u003eclick to expand\u003c/em\u003e)\u003c/b\u003e\u003c/summary\u003e\r\n\u003cbr\u003e\r\n\r\n- [Python Docs: iterator definition](https://docs.python.org/3/glossary.html#term-iterator) | [Python Docs: iterator types](https://docs.python.org/3/library/stdtypes.html#iterator-types) \r\n  -  [Python Functional Programming HOWTO: Iterators](https://docs.python.org/3/howto/functional.html#iterators)\r\n  -  [Trey Hunner: The Iterator Protocol: How `for` Loops Work in Python](https://treyhunner.com/2016/12/python-iterator-protocol-how-for-loops-work/)\r\n  -  [Dan Bader: Python Iterators - A Step-by-Step Introduction](https://dbader.org/blog/python-iterators)\r\n  -   [Python Docs: sequence](https://docs.python.org/3/glossary.html#term-sequence)\r\n- [Python Docs: `itertools` module](https://docs.python.org/3/library/itertools.html#module-itertools)\r\n- [Python Docs:`itertools` Recipes](https://docs.python.org/3/library/itertools.html#itertools-recipes)\r\n- [Python Module of the Week: `itertools`](https://pymotw.com/3/itertools/)\r\n- [Florian Dahlitz:  Python Introduction to Itertools](https://florian-dahlitz.de/blog/introduction-to-itertools)\r\n- [Real Python: Itertools in Python 3, By Example](https://docs.python.org/3/library/itertools.html#module-itertools)\r\n- [Python Docs: eumulating container types](https://docs.python.org/3/reference/datamodel.html#emulating-container-types)\r\n  - [Trey Hunner: How to make an `iterator` in Python](https://treyhunner.com/2018/06/how-to-make-an-iterator-in-python/)\r\n  - [Python Patterns Guide: Gang of Four `iterator` Pattern](https://python-patterns.guide/gang-of-four/iterator/)\r\n\r\n\u003c/details\u003e\r\n\u003cbr\u003e\r\n\r\n##  📁  Files to Be Created\r\n\r\n\u003cdetails open\u003e\r\n\u003csummary\u003e\u003cb\u003eFile Detail for this Exercise\u003c/b\u003e\u003c/summary\u003e\r\n\u003ctable\u003e\r\n\u003ctd\u003e\r\n\u003cbr\u003e\r\n\r\nPlease see the following for more details on these files:  [concepts](https://exercism.org/docs/building/tracks/concepts)\r\n\r\n* ### `links.json`\r\n\r\n  For more information, see [concept links file](https://github.com/exercism/docs/blob/main/building/tracks/concepts.md#file-linksjson)\r\n\r\n  -  The same resources listed in this issue can be used as a starting point for the [ `concepts/links.json`](https://github.com/exercism/docs/blob/main/building/tracks/concepts.md#file-linksjson)  file, if it doesn't already exist.\r\n  -  If there are particularly good/interesting information sources for this concept that extend or supplement the concept exercise material \u0026 the resources already listed -- please add them to the `links.json` document.\r\n\r\n\r\n* ### Concept `about.md`\r\n\r\n  For more information, see [Concept `about.md`](https://github.com/exercism/docs/blob/main/anatomy/tracks/concepts.md#file-aboutmd)\r\n\r\n  - This file provides information about this concept for a student who has completed the corresponding concept exercise.  It is intended as a reference for continued learning.  \r\n\r\n\r\n* ### Concept `introduction.md`\r\n\r\n  For more information, see [Concept `introduction.md`](https://github.com/exercism/docs/blob/main/building/tracks/concepts.md#file-aboutmd)\r\n\r\n  * This can also be a summary/paraphrase of the  `about.md` document listed above, and will provide a brief introduction of the concept for a student who has **not yet** completed the associated concept or practice exercises.   It should contain a good summation of the concept, but not go into lots of detail.\r\n\r\n\r\n* ### Concept `.meta/config.json` Entries\r\n \r\n  For more information, see [Concept `.meta/config.json`](https://github.com/exercism/docs/blob/main/building/tracks/concepts.md#file-metaconfigjson)\r\n\r\n  * This file is likely already stubbed out.  Remember to add a concept **blurb** of less than 350 characters.  Please also add your GitHub username to the \"authors\" array, and any contributor GitHub usernames to the \"contributors\" array.\r\n\r\n\u003cbr\u003e\r\n\u003c/td\u003e\r\n\u003c/table\u003e\r\n\u003c/details\u003e\r\n\r\n## 🎶  Implementation Notes\r\n\r\n- Example code  should **only use syntax \u0026 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.\r\n  Please **do not use** syntax not previously covered in prerequisite topics or exercises.  Please also follow [PEP8](https://www.python.org/dev/peps/pep-0008/) guidelines.\r\n- Our markdown and JSON files are checked against [prettier](https://prettier.io/) .  We recommend [setting prettier up locally](https://prettier.io/docs/en/install.html) and running it prior to submitting your PR  to avoid any CI errors.\r\n\r\n\u003cbr\u003e\r\n\r\n##  🆘  Next Steps \u0026 Getting Help\r\n\r\n1.  **`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_).\r\n2. 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.\r\n\r\n\r\n\r\n","author":{"url":"https://github.com/BethanyG","@type":"Person","name":"BethanyG"},"datePublished":"2022-06-11T01:26:51.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/3089/python/issues/3089"}