Skip to content

[New Concept Docs]: itertools Module #3089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BethanyG opened this issue Jun 11, 2022 · 0 comments · May be fixed by #3288
Closed

[New Concept Docs]: itertools Module #3089

BethanyG opened this issue Jun 11, 2022 · 0 comments · May be fixed by #3288

Comments

@BethanyG
Copy link
Member

This issue describes how to implement the itertools module 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:

Documents on Language Tracks and Concepts:


🎯 Goal

These concept docs are meant to teach an understanding/use of the itertools module in Python.


💡 Learning objectives

Learn more about iteration tools the Python Standard Library provides through the itertools module.

Build and understanding of and use the following functions from the module, as well as practicing some of the recipes included :

  • At least one of the infinite itertators count(),cycle(),, or repeat()
  • accumulate()
  • product()
  • chain() & chain.from_iterable()
  • groupby()
  • islice()
  • zip_longest() and the zip() built-in
  • permutations()
  • combinations()

🚫 Out of scope


Concepts & Subjects that are Out of Scope (click to expand)
  • classes & class customization beyond the use of the itertools methods.
  • class-inheritance beyond what is needed to customize iteration using itertools
  • comprehensions beyond what is needed to work with itertools
  • comprehensions in lambdas
  • coroutines
  • decorators beyond what is needed to work with itertools
  • functions and higher-order functions beyond what might be needed to work with itertools
  • functools and related map(), filter() and functools.reduce()(they have their own exercise which is a prerequisite to this one)
  • generators beyond what might be needed to work with itertools (they have their own exercise which is a prerequisite to this one)
  • lambdas beyond what might be needed to work with itertools
  • using an assignment expression or "walrus" operator (:=)
  • class decorators
  • enums

🤔 Concepts

  • iteration
  • iterators
  • itertools

↩️ Prerequisites

These are the concepts/concept exercises the student should be familiar with before taking on/learning this concept.

Exercise Prerequisites (click to expand)
  • basics
  • booleans
  • comparisons
  • rich-comparisons
  • dicts
  • dict-methods
  • functions
  • functional tools
  • generators
  • higher-order functions
  • Identity methods is and is not
  • iteration
  • lists
  • list-methods
  • loops
  • numbers
  • sequences
  • sets
  • strings
  • string-methods
  • tuples

📚 Resources to refer to

Resources (click to expand)

📁 Files to Be Created

File Detail for this Exercise

Please see the following for more details on these files: concepts

  • links.json

    For more information, see concept links file

    • The same resources listed in this issue can be used as a starting point for the concepts/links.json file, if it doesn't already exist.
    • If there are particularly good/interesting information sources for this concept that extend or supplement the concept exercise material & the resources already listed -- please add them to the links.json document.
  • Concept about.md

    For more information, see Concept about.md

    • 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.
  • Concept introduction.md

    For more information, see Concept introduction.md

    • 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.
  • Concept .meta/config.json Entries

    For more information, see Concept .meta/config.json

    • 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.

🎶 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

  1. 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).
  2. 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.
@BethanyG BethanyG added x:action/create Work on something from scratch x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/concept Work on Concepts x:type/content Work on content (e.g. exercises, concepts) x:size/large Large amount of work help wanted We'd like your help with this. new reference doc ✨ x:rep/large Large amount of reputation labels Jun 11, 2022
@exercism exercism deleted a comment from github-actions bot Jun 11, 2022
@BethanyG BethanyG removed x:action/create Work on something from scratch x:knowledge/intermediate Quite a bit of Exercism knowledge required x:module/concept Work on Concepts x:type/content Work on content (e.g. exercises, concepts) x:size/large Large amount of work help wanted We'd like your help with this. x:rep/large Large amount of reputation labels Nov 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant