User:Eduralph/Sandbox/Placeholder

From Gramps


Overview

See the parent area overview for where this fits.

Architecture

Component Role Source
Foo what it does gramps/gen/foo.py
Bar what it does gramps/gen/bar.py

Data flow

  1. Caller invokes Foo.frob(x).
  2. Result returned as a Bar instance.

Interface contract

def frob(x: FooHandle) -> Bar | None:
    """Return the Bar for x, or None if x is unknown.

    Raises HandleError if x is malformed.
    """

Conventions

  • Always do X before Y.
  • Never call Foo._internal() from outside the module.

Diagrams and images

See also

Gramps-notes.png

This article's content is incomplete or a placeholder stub.
Please update or expand this section.