#!/usr/bin/env python3
"""Topology neighbors command implementation"""
import click
from src.cmd.commands.base import execute_device_command
from src.cmd.commands.decorators import add_common_device_options
from src.cmd.schemas import Command, CommandGroup
from src.cmd.error_providers import CommandErrorProvider
from src.cmd.registries.command_registry import (
register_command,
register_error_provider,
)
from src.logging import get_logger
from src.collectors.topology.neighbors import neighbors
from src.cmd.examples.example_builder import (
ExampleBuilder,
ExampleSet,
)
logger = get_logger(__name__)
def topology_neighbors_examples() -> ExampleSet:
"""Build topology neighbors command examples with common patterns."""
return ExampleBuilder.standard_command_examples(
command=f"{CommandGroup.TOPOLOGY.group_name} {Command.TOPOLOGY_NEIGHBORS.command_name}",
alias=f"t {Command.TOPOLOGY_NEIGHBORS.command_name}",
device="R1",
detail_option=False, # neighbors doesn't use detail flag
batch_operations=True,
output_formats=True,
alias_examples=True,
)
def basic_usage() -> str:
"""Basic usage examples"""
return topology_neighbors_examples().basic_only().to_string()
def detailed_examples() -> str:
"""Detailed examples"""
return topology_neighbors_examples().for_help()
error_provider = CommandErrorProvider(Command.TOPOLOGY_NEIGHBORS)
register_error_provider(Command.TOPOLOGY_NEIGHBORS, error_provider)
def _get_command_help() -> str:
return detailed_examples()
@register_command(Command.TOPOLOGY_NEIGHBORS)
@click.command(help=_get_command_help())
@add_common_device_options
@click.pass_context
def topology_neighbors(ctx, device, output, devices, device_file, all_devices):
"""Get topology neighbors information"""
def operation_func(device_obj, **kwargs):
return neighbors(device_obj)
return execute_device_command(
ctx=ctx,
device=device,
devices=devices,
device_file=device_file,
all_devices=all_devices,
output=output,
operation_func=operation_func,
operation_name="topology neighbors",
)
if __name__ == "__main__":
print(_get_command_help())
