8.5.1. pymodaq_utils.plugin_tools package

• 8.5.1.1. pymodaq_utils.plugin_tools.checks module
  • PluginLoadError
  • CheckResult
    • CheckResult.failing()
    • CheckResult.findings
    • CheckResult.item
    • CheckResult.ok
    • CheckResult.problems
    • CheckResult.warnings
  • PluginModule
    • PluginModule.class_name
    • PluginModule.import_path
    • PluginModule.kind
    • PluginModule.module_name
    • PluginModule.name
    • PluginModule.package
    • PluginModule.prefix
  • PluginReport
    • PluginReport.format()
    • PluginReport.to_dict()
    • PluginReport.fail_on
    • PluginReport.failures
    • PluginReport.ok
    • PluginReport.package
    • PluginReport.results
    • PluginReport.strict_imports
    • PluginReport.todos
  • check_move_class()
  • check_package_layout()
  • check_package_sources()
  • check_plugin_file()
  • check_plugin_module()
  • check_plugin_package()
  • check_viewer_class()
  • find_plugin_modules()
  • guess_package_name()
  • is_installed()
  • load_plugin_class()
  • main()
  • resolve_file()
  • resolve_target()
• 8.5.1.2. pymodaq_utils.plugin_tools.contract module
  • PluginMethod
    • PluginMethod.kind
    • PluginMethod.legacy_name
    • PluginMethod.mandatory
    • PluginMethod.name
    • PluginMethod.purpose
    • PluginMethod.returns
  • contract_as_rst()
  • legacy_names()
  • mandatory_methods()
  • methods_of()
  • recommended_methods()
• 8.5.1.3. pymodaq_utils.plugin_tools.extension_checks module
  • check_extension_files()
  • find_extension_files()
  • is_core_extension()
  • main()
• 8.5.1.4. pymodaq_utils.plugin_tools.platforms module
  • classifiers_for()
  • declared_in_class()
  • describe()
  • dynamic_classifiers()
  • invalid_values()
  • normalize_architecture()
  • package_platforms()
  • platforms_as_rst()
  • pyproject_os_classifiers()
  • python_classifiers()
  • unsupported_reason()
  • update_pyproject_classifiers()
  • windows_only_files()
  • ARCHITECTURES
  • PLATFORMS
  • PYTHON_VERSIONS
• 8.5.1.5. pymodaq_utils.plugin_tools.rules module
  • Finding
    • Finding.format()
    • Finding.code
    • Finding.column
    • Finding.hint
    • Finding.line
    • Finding.location
    • Finding.message
    • Finding.path
    • Finding.severity
  • Severity
    • Severity.ERROR
    • Severity.TODO
    • Severity.WARNING
  • check_extension_source()
  • check_extensions()
  • check_file_names()
  • check_leftovers()
  • check_os_classifiers()
  • check_package_sources()
  • check_plugin_source()
  • check_pyproject()
  • check_python_code()
  • colorize()
  • is_valid_unit()
  • package_root()
  • project_root()
  • syntax_error_finding()
  • use_color()
• 8.5.1.6. pymodaq_utils.plugin_tools.scaffold module
  • create_instrument()
  • find_package_folder()
  • main()

Tools to develop and maintain PyMoDAQ instrument plugins.

• contract: the methods of a plugin (single definition)

• rules: the static rules (PMQxxx codes)

• checks: the report on a plugin package (check_plugin command)

• scaffold: creation of new plugin modules

They read the source files of the plugins and do not import pymodaq. The previous locations (pymodaq_utils.plugin_tools.checks, plugin_rules and plugin_scaffold) still work.

Added in version 5.3.5.