ros2doctor.api package

Submodules

• ros2doctor.api.action module
  • ActionReport
    • ActionReport.category()
    • ActionReport.report()
• ros2doctor.api.environment module
  • EnvironmentReport
    • EnvironmentReport.category()
    • EnvironmentReport.report()
• ros2doctor.api.format module
  • CustomWarningFormat
  • compute_padding()
  • custom_warning_format()
  • doctor_error()
  • doctor_warn()
  • format_print()
• ros2doctor.api.network module
  • InterfaceFlags
  • NetworkCheck
    • NetworkCheck.category()
    • NetworkCheck.check()
  • NetworkReport
    • NetworkReport.category()
    • NetworkReport.report()
• ros2doctor.api.package module
  • PackageCheck
    • PackageCheck.category()
    • PackageCheck.check()
  • PackageReport
    • PackageReport.category()
    • PackageReport.report()
  • compare_versions()
  • get_distro_package_versions()
  • get_local_package_versions()
• ros2doctor.api.platform module
  • PlatformCheck
    • PlatformCheck.category()
    • PlatformCheck.check()
  • PlatformReport
    • PlatformReport.category()
    • PlatformReport.report()
  • RosdistroReport
    • RosdistroReport.category()
    • RosdistroReport.report()
• ros2doctor.api.qos_compatibility module
  • QoSCompatibilityCheck
    • QoSCompatibilityCheck.category()
    • QoSCompatibilityCheck.check()
  • QoSCompatibilityReport
    • QoSCompatibilityReport.category()
    • QoSCompatibilityReport.report()
• ros2doctor.api.rmw module
  • RMWReport
    • RMWReport.category()
    • RMWReport.report()
• ros2doctor.api.service module
  • ServiceReport
    • ServiceReport.category()
    • ServiceReport.report()
• ros2doctor.api.topic module
  • TopicCheck
    • TopicCheck.category()
    • TopicCheck.check()
  • TopicReport
    • TopicReport.category()
    • TopicReport.report()

Module contents

class ros2doctor.api.DoctorCheck

Bases: object

Abstract base class of ros2doctor check.

category() → str

Returns:

string linking checks and reports.

check() → Result

Returns:

Result indicating result of checks.

class ros2doctor.api.DoctorReport

Bases: object

Abstract base class of ros2doctor report.

category() → str

Returns:

string linking checks and reports.

report() → Report

Returns:

Report object storing report content.

class ros2doctor.api.Report(name: str)

Bases: object

Stores report name and content.

add_to_report(item_name: str, item_info: int | str) → None

Add report content to items list (list of string tuples).

items: List[Tuple[str, str | int]]

name

class ros2doctor.api.Result

Bases: object

Stores check result.

add_error() → None

add_warning() → None

error

warning

ros2doctor.api.generate_reports(*, categories=None, exclude_packages: bool = False) → List[Report]

Print all reports or reports of failed checks to terminal.

Returns:

list of Report objects

ros2doctor.api.get_service_names(skip_services: List[str] = []) → List[str]

Get all service names using rclpy API.

ros2doctor.api.get_topic_names(skip_topics: List[str] = []) → List[str]

Get all topic names using rclpy API.

ros2doctor.api.print_warning_notice() → None

ros2doctor.api.run_checks(*, include_warnings: bool = False, exclude_packages: bool = False) → Tuple[Set[str], int, int]

Run all checks and return check results.

Returns:

3-tuple (categories of failed checks, number of failed checks, total number of checks)