gamesheet_sdk.common.cli.teams_lookup_options module

Read-side game options that originate with the teams gateway.

--team-id, --month, --event-data and --availability map onto real query parameters of the teams calendar API and have no counterpart in the admin season-schedule JSON:API. They are declared here once and accepted by both CLIs so a list/get command line stays portable; gamesheet-admin warns on stderr and ignores them (see gamesheet_sdk.common.cli.game_options.warn_unsupported_options()).

gamesheet_sdk.common.cli.teams_lookup_options.availability_options(*, ignored=False)[source]

Build the decorator adding --availability and --team-id to a get command.

Parameters:

ignored (bool) – Whether this CLI ignores both.

Returns:

Callable[[F], F] – The option decorator.

Return type:

Callable[[F], F]

gamesheet_sdk.common.cli.teams_lookup_options.list_filter_options(*, team_required, ignored=False)[source]

Build the decorator adding --team-id, --month and --event-data to a list command.

Parameters:

  • team_required (bool) – Whether --team-id is mandatory. Only gamesheet-teams needs it.

  • ignored (bool) – Whether this CLI ignores all three.

Returns:

Callable[[F], F] – The option decorator.

Return type:

Callable[[F], F]

gamesheet_sdk.common.cli.teams_lookup_options.team_id_option(*, required, ignored=False)[source]

Build the standalone --team-id decorator used by list and get.

Parameters:

  • required (bool) – Whether the option is mandatory.

  • ignored (bool) – Whether to note in the help text that this CLI ignores it.

Returns:

Callable[[F], F] – The option decorator.

Return type:

Callable[[F], F]