saturnin._scripts.commands.oids

Typer commands for managing Saturnin’s Object Identifier (OID) registry.

This includes listing registered OIDs, updating the registry from remote specifications, and displaying detailed information about individual OIDs. The OID registry helps in uniquely identifying various entities like vendors, platforms, services, and applications within the Saturnin ecosystem.

Globals

saturnin._scripts.commands.oids.app

Typer command group for OID management commands

Parameters:

• args (Any)

• kwargs (Any)

Return type:

Any

Command functions

saturnin._scripts.commands.oids.list_oids(with_name: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x799ce4775f10>] = '', *, show_oids: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x799ce4776f90>] = False) → None

Lists registered OIDs, optionally filtering by name.

By default, OIDs are displayed as UUIDs. Use the --show-oids option to display them in their dotted decimal notation (e.g., 1.3.6.1.4.1.53446).

Parameters:

• with_name (Annotated[str, <typer.models.OptionInfo object at 0x799ce4774650>])

• show_oids (Annotated[bool, <typer.models.OptionInfo object at 0x799ce4776050>])

Return type:

None

saturnin._scripts.commands.oids.show_oid(oid: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x799ce48a1090>]) → None

Show information about OID.

Parameters:

oid (Annotated[str, <typer.models.ArgumentInfo object at 0x799ce48a7a50>])

Return type:

None

saturnin._scripts.commands.oids.update_oids(url: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x799ce46b5ad0>] = 'https://raw.githubusercontent.com/FirebirdSQL/firebird-uuid/master/root.oid')

Updates the local OID registry by downloading and parsing specifications.

This command fetches OID specifications starting from the given URL. The specifications can be linked, forming a tree of OID definitions. The local registry (stored in oids.toml) is then updated with the parsed information.

Parameters:

url (Annotated[str, <typer.models.ArgumentInfo object at 0x799ce47a0e10>])