Core API

Boussole is mainly a commandeline tool but it relies on a core API that may be used to implement another frontend.

This part of Boussole should not concern end users because they don’t directly exploit it, it documents some behaviors but they should be better documented from Tutorial.

The core API should be 100% covered for documentation and unittests.

Modules

• Exceptions
• BoussoleBaseException
• InvalidImportRule
• FinderException
• UnresolvablePath
• UnclearResolution
• CircularImport
• SettingsDiscoveryError
• SettingsBackendError
• SettingsInvalidError
• Parser
• ScssImportsParser
  • ScssImportsParser.REGEX_IMPORT_RULE
  • ScssImportsParser.REGEX_COMMENTS
  • ScssImportsParser.strip_quotes()
  • ScssImportsParser.remove_comments()
  • ScssImportsParser.filter_rules()
  • ScssImportsParser.flatten_rules()
  • ScssImportsParser.parse()
• SassImportsParser
  • SassImportsParser.REGEX_IMPORT_RULE
• Resolver
• ImportPathsResolver
  • ImportPathsResolver.CANDIDATE_EXTENSIONS
  • ImportPathsResolver.STRICT_PATH_VALIDATION
  • ImportPathsResolver.is_allowed_source()
  • ImportPathsResolver.candidate_paths()
  • ImportPathsResolver.check_candidate_exists()
  • ImportPathsResolver.resolve()
• Inspector
• ScssInspector
  • ScssInspector._CHILDREN_MAP
  • ScssInspector._PARENTS_MAP
  • ScssInspector.parsers
  • ScssInspector.get_parser()
  • ScssInspector.reset()
  • ScssInspector.look_source()
  • ScssInspector.inspect()
  • ScssInspector._get_recursive_dependancies()
  • ScssInspector.children()
  • ScssInspector.parents()
• Finder
• paths_by_depth()
• ScssFinder
  • ScssFinder.FINDER_STYLESHEET_EXTS
  • ScssFinder.get_relative_from_paths()
  • ScssFinder.is_partial()
  • ScssFinder.is_allowed()
  • ScssFinder.match_conditions()
  • ScssFinder.append_suffix()
  • ScssFinder.change_extension()
  • ScssFinder.get_destination()
  • ScssFinder.compilable_sources()
  • ScssFinder.mirror_sources()
• Logging
• init_logger()
• Project configuration
• Settings model
• Settings
  • Settings.clean()
  • Settings.set_settings()
  • Settings.update()
• Settings backend post processing
• SettingsPostProcessor
  • SettingsPostProcessor.post_process()
  • SettingsPostProcessor._patch_expand_path()
  • SettingsPostProcessor._patch_expand_paths()
  • SettingsPostProcessor._validate_path()
  • SettingsPostProcessor._validate_paths()
  • SettingsPostProcessor._validate_required()
  • SettingsPostProcessor._patch_hash_suffix()
• Base settings backend
• SettingsBackendBase
  • SettingsBackendBase._default_filename
  • SettingsBackendBase._kind_name
  • SettingsBackendBase._file_extension
  • SettingsBackendBase.parse_filepath()
  • SettingsBackendBase.check_filepath()
  • SettingsBackendBase.open()
  • SettingsBackendBase.parse()
  • SettingsBackendBase.dump()
  • SettingsBackendBase.clean()
  • SettingsBackendBase.load()
• JSON settings backend
• SettingsBackendJson
  • SettingsBackendJson._default_filename
  • SettingsBackendJson._kind_name
  • SettingsBackendJson._file_extension
  • SettingsBackendJson.dump()
  • SettingsBackendJson.parse()
• YAML settings backend
• SettingsBackendYaml
  • SettingsBackendYaml._default_filename
  • SettingsBackendYaml._kind_name
  • SettingsBackendYaml._file_extension
  • SettingsBackendYaml.dump()
  • SettingsBackendYaml.parse()
• Backend discover
• Discover
  • Discover.scan_backends()
  • Discover.get_engine()
  • Discover.guess_filename()
  • Discover.search()
• Sass compile helper
• SassCompileHelper
  • SassCompileHelper.safe_compile()
  • SassCompileHelper.write_content()
• Source watcher
• SassLibraryEventHandler
  • SassLibraryEventHandler.settings
  • SassLibraryEventHandler.logger
  • SassLibraryEventHandler.inspector
  • SassLibraryEventHandler.finder
  • SassLibraryEventHandler.compiler
  • SassLibraryEventHandler.compilable_files
  • SassLibraryEventHandler.source_files
  • SassLibraryEventHandler._event_error
  • SassLibraryEventHandler.is_valid_event()
  • SassLibraryEventHandler.index()
  • SassLibraryEventHandler.compile_source()
  • SassLibraryEventHandler.compile_dependencies()
  • SassLibraryEventHandler.on_any_event()
  • SassLibraryEventHandler.on_moved()
  • SassLibraryEventHandler.on_created()
  • SassLibraryEventHandler.on_modified()
  • SassLibraryEventHandler.on_deleted()
• SassProjectEventHandler
  • SassProjectEventHandler.compile_dependencies()
• WatchdogLibraryEventHandler
• WatchdogProjectEventHandler
• Project management
• ProjectBase
  • ProjectBase._engines
  • ProjectBase.backend_name
  • ProjectBase.backend_engine
  • ProjectBase.get_backend_engine()
• ProjectStarter
  • ProjectStarter.valid_paths()
  • ProjectStarter.expand()
  • ProjectStarter.commit()
  • ProjectStarter.init()