crash.log written into repo root on Linux (breaks Syncthing casing sync)

Abierto Apto para principiantes
#3 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
desktop

Línea de trabajo

Empieza en plotruler/main.py, en _crash_log_path(), e inspecciona cómo se comporta el fallback cuando LOCALAPPDATA y TEMP no están definidos en Linux. Elige e implementa una ubicación adecuada para la plataforma que no pueda crear un directorio PlotRuler con mayúscula inicial en el repositorio; después, verifica que crash.log se escriba fuera del árbol de trabajo; considera la sugerencia relacionada de .gitignore.

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

Descripción

Summary

When run on Linux with LOCALAPPDATA/TEMP unset, _crash_log_path() falls back to ".", so the crash log is written to ./PlotRuler/crash.log inside the repository working tree.

Code

plotruler/__main__.py:

def _crash_log_path():
    base = os.environ.get("LOCALAPPDATA") or os.environ.get("TEMP") or "."
    return os.path.join(base, "PlotRuler", "crash.log")
  • Windows: LOCALAPPDATA is set → %LOCALAPPDATA%\PlotRuler\crash.log (fine).
  • Linux/macOS: neither var is set → logs to ./PlotRuler/crash.log.

Problem

The repo root already contains the lowercase package plotruler/. On case-insensitive filesystems (Windows/macOS) the two collide, and tools that sync the tree — e.g. Syncthing — report a casing conflict:

remote "Programming\GraphRuler\PlotRuler" uses different upper or lowercase characters than local "Programming\GraphRuler\plotruler"

so the items never sync until the stray PlotRuler/ dir is deleted manually.

Suggestion

Use a platform-appropriate XDG path on non-Windows, e.g.:

base = os.environ.get("LOCALAPPDATA") or os.environ.get("XDG_STATE_HOME", os.path.expanduser("~/.local/state"))

and/or log with the app name directly rather than a capital-cased dir that can shadow the lowercase package. Also consider ignoring the runtime dir in .gitignore as a belt-and-suspenders measure.

Lenguaje dominante
Python
Estrellas
1
Forks
0
Métricas de merge de PR
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 endolith/plotruler

Todos los issues de endolith/plotruler

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.