NeuroMorphoFilePlan

NeuroMorphoFilePlan#

class braincell.io.NeuroMorphoFilePlan(kind, url, filename, skip=False, reason=None)[source]#

A planned file download for a single neuron.

Plan records are returned by plan_neuron_files() and NeuroMorphoClient.file_plan(). A plan with skip=True is

a deliberate non-download (e.g. the neuron has no original file) and reason describes why.

Parameters:
  • kind (str) – Which file the plan refers to.

  • url (str) – Direct download URL. Empty when skip is True.

  • filename (str) – Suggested filename inside the cache folder.

  • skip (bool) – True if the file cannot be downloaded.

  • reason (str | None) – Explanation when skip is True, otherwise None.