MetOffice / MetOffice/primavera-dmt

TODOs in list_files()

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Rewrite dmt_app.utils.common.list_files() to use Path objects rather than functions. It should also be modified to be a generator (using yield). After this is done, update the Pylint test for dmt_app to not ignore todo comments.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with dmt_app.utils.common.list_files() and inspect the Pylint test for dmt_app. Confirm how the current function and TODO-comment ignore are tested, then verify that list_files() uses Path objects, yields results as a generator, and the Pylint test no longer ignores TODO comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.