Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Clean up ``util`` module, move internal utilities to ``imod.common.utilities``

オープン
#1,921 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
tooling

調査の方向性

Start by reading imod.util and the listed modules: dims, expand_repetitions, imports, nested_dict, regrid, time, and path, then search their usages. Determine which developer utilities belong in imod.common.utilities while keeping the public namespaces for functions that are still API; done means internal utilities are relocated without breaking those namespaces.

索引モデルが issue の本文から書いたものです。

説明

refactor

The util module is a legacy utility module, also containing some convenience functions that are public API. These are still used every-so-often, and some of them are very useful (e.g. empty_2d).

Over the past years, we've created a lot more internal utility functions, which are grouped in imod.common.utilities, or imod.msw.utilities/imod.mf6.utilities if they are tailored to these kernels.

However, developer utilities have landed in imod.util, partly because I was being sloppy myself (possibly to work around some circular dependencies):

  • imod.util.dims
  • imod.util.expand_repetitions
  • imod.util.imports
  • imod.util.nested_dict

I think it is better to move these dev utilities into imod.common.utilities. Modules that can possible moved as well:

  • imod.util.regrid
  • imod.util.time
  • imod.util.path

Though these contain some minor parts of the public API, so the namespaces of these utils need to remain available.

主要言語
Python
スター
41
フォーク
11
平均マージ
2日 23時間
マージ済み PR(30日)
13

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Deltares/imod-python のほかの issue

Deltares/imod-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。