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

Aperta Adatta ai principianti
#3 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
desktop

Direzione di ricerca

Inizia in plotruler/main.py, da _crash_log_path(), e analizza il comportamento del fallback quando LOCALAPPDATA e TEMP non sono impostate su Linux. Scegli e implementa una posizione appropriata per la piattaforma che non possa creare una directory PlotRuler nel repository, quindi verifica che crash.log venga scritto al di fuori dell’albero di lavoro; considera la relativa proposta per .gitignore.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
1
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di endolith/plotruler

Tutte le issue di endolith/plotruler

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.