Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
#1,921 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
41
Forks
10
Merge medio
3 d 1 h
PR fusionados (30 d)
14

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Deltares/imod-python

Todos los issues de Deltares/imod-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.