Utilities

Introduction

The previous parts of this guide describe structures and the algorithms that run on them. This part covers the tooling around them: looking at a structure, describing one in a file, and understanding the errors the library reports.

All of it lives in sds.utils, the top layer of the package. The structures never depend on it: sds.linear or sds.graph work exactly the same whether the tooling is used or not.

        graph LR
    F[JSON / YAML file] -- pysds show --> S[structure]
    P[Python code] --> S
    S -- visualizer --> T[text]
    S -- visualizer --> M[Mermaid]
    S -- visualizer --> D[DOT]
    S -- visualizer --> I[image]

    style S fill:#3498db,color:#fff
    

Chapter	Covers	Needs
Visualizing Structures	Showing any structure as text, Mermaid, DOT or an image, from Python	nothing; image extra for images
The pysds Command	The pysds command and the file format that describes a structure	nothing; yaml extra for YAML files, image extra for images
Errors	The exception hierarchy of the library and how to catch it	nothing

The base install has no dependency. The features that need one, images and YAML files, take it from an extra of the distribution; see Installation for the commands.

• Visualizing Structures
  • Introduction
  • Concepts
  • The Formats
  • Linear Structures
  • Trees
  • Graphs
  • Images
  • Labels
  • Visualizations in Practice
  • Best Practices
  • References
• The pysds Command
  • Introduction
  • The Document Format
  • Using the Command
  • Best Practices
  • References
• Errors
  • Introduction
  • The Hierarchy
  • Arguments versus State
  • Reference
  • Catching Errors
  • Best Practices
  • References