Skip to content

[New Concept Docs]: Functional Tools in Python #3107

@BethanyG

Description

@BethanyG

This issue describes how to implement the functional tools in Python 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 core functional tools (e.g, map(), filter(), and functools.reduce() in Python.


💡 Learning objectives

  • Understand/use the built-in map() function.
    • constructing a lambda or callback function used as the argument.
    • comparisons to set, dict or list comprehensions
    • when and when not to use - considering performance & readability
  • Understand/use the built-in filter() function.
    • constructing a lambda or callback function used as the argument.
    • comparisons to set, dict or list comprehensions
    • when and when not to use - considering performance & readability
  • Understand/use the functools.reduce() function
    • constructing a lambda or callback function used as the argument.
    • using initializer as a "first call" or to guard against TypeErrors when the passed iterable is empty.
    • comparisons to sum(), min(), max(), any(), all(), math.prod() and to intertools.accumulate()
    • when and when not to use - considering performance & readability

🚫 Out of scope

Concepts & Subjects that are Out of Scope (click to open)
  • comprehensions
  • comprehensions in lambdas
  • map(), filter() or functools.reduce() within a comprehension
  • functools beyond functools.reduce()(this will get its own exercise)
  • generators
  • map(), filter() or functools.reduce() within a generator expression
  • using an assignment expression or "walrus" operator (:=) in a lambda (walrus in general is OK if it is explained, just not inside a lambda)

🤔 Concepts

Concepts & Related Concepts Covered (click to open)
  • functional tools in python
  • built-ins
    • any() & all()
    • sum()
    • min() & max()
    • map()
    • filter()
  • functools.reduce()
  • itertools.accumulate()

↩️ Prerequisites

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

Prereqs (click to open)
  • basics
  • bools
  • comparisons
  • dicts
  • dict-methods
  • functions
  • function-arguments
  • higher-order-functions
  • iteration
  • lambdas
  • lists
  • list-methods
  • numbers
  • sequences
  • sets
  • strings
  • string-methods
  • tuples

📚 Resources to refer to

Resources (click to open)
Additional Articles (click to open)

📁 Files to Be Created

File Detail for this Exercise (click to collapse)

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions