SDK

This package provides the core functionality for interacting with the FLYNC core modules, including utilities for workspace managment. It exposes a clean, Pythonic API for developers to integrate FLYNC capabilities into their applications.

---

Tip

The FLYNC SDK uses pydantic field annotations as part of the Model to load a configuration. Contributors should consider the page Field Annotations.

---

• flync.sdk
  • FLYNC Workspace
    • FLYNCWorkspace
      • FLYNCWorkspace.load_errors
      • FLYNCWorkspace.load_model()
      • FLYNCWorkspace.safe_load_workspace()
      • FLYNCWorkspace.load_workspace()
      • FLYNCWorkspace.generate_configs()
      • FLYNCWorkspace.is_path_supported()
      • FLYNCWorkspace.is_flync_file()
      • FLYNCWorkspace.name_form_file()
      • FLYNCWorkspace.fill_path_from_object()
      • FLYNCWorkspace.document_id_from_path()
      • FLYNCWorkspace.new_object_path()
      • FLYNCWorkspace.update_objects_path()
      • FLYNCWorkspace.add_list_item_object_path()
      • FLYNCWorkspace.get_object()
      • FLYNCWorkspace.list_objects()
      • FLYNCWorkspace.get_source()
      • FLYNCWorkspace.objects_at()
    • ListObjectsMode
    • WorkspaceConfiguration
      • WorkspaceConfiguration.root_model
      • WorkspaceConfiguration.create_from_config()
  • Document
    • Document
      • Document.parse()
      • Document.update_text()
  • Utils & Helpers
    • get_metadata()
    • get_name()
    • dump_flync_workspace()
• Validation API
  • Imports
  • DiagnosticsResult
    • DiagnosticsResult
      • DiagnosticsResult.state
      • DiagnosticsResult.errors
      • DiagnosticsResult.model
      • DiagnosticsResult.workspace
      • DiagnosticsResult.serialize_workspace()
    • WorkspaceState
      • WorkspaceState.UNKNOWN
      • WorkspaceState.EMPTY
      • WorkspaceState.LOADING
      • WorkspaceState.VALID
      • WorkspaceState.WARNING
      • WorkspaceState.INVALID
      • WorkspaceState.BROKEN
    • Reading results
  • Discovering Node Paths
    • available_flync_nodes()
    • Example
  • Validating a Full Workspace
    • validate_workspace()
    • Example
  • Validating an External Node
    • validate_external_node()
    • Example — using a type
    • Example — using a string name
  • Validating a Partial (In-Workspace) Node
    • validate_node()
    • Path syntax reference
    • Example
  • Node metadata reference
    • NodeInfo
      • NodeInfo.name
      • NodeInfo.python_type
      • NodeInfo.flync_paths
      • NodeInfo.serialize_type()
  • Function reference
    • validate_workspace()
    • validate_external_node()
    • validate_node()
    • available_flync_nodes()
    • type_from_input()
• Object Mapping
  • Object IDs
  • List Item IDs and ListObjectsMode
    • ListObjectsMode
      • ListObjectsMode.INDEX
      • ListObjectsMode.NAME
    • FLYNCWorkspace.add_list_item_object_path()
    • Modes
    • Source of the name
    • Configuring the mode
    • Example — dual IDs in practice
  • Source Types
    • SourceRef
      • SourceRef.uri
      • SourceRef.range
    • Range
      • Range.start
      • Range.end
    • Position
      • Position.line
      • Position.character
    • SemanticObject
    • ObjectId
  • Runtime Retrieval
    • List all object IDs
      • FLYNCWorkspace.list_objects()
    • Retrieve a semantic object
      • FLYNCWorkspace.get_object()
    • Retrieve the source location
      • FLYNCWorkspace.get_source()
    • Look up objects by file position
      • FLYNCWorkspace.objects_at()
  • Object Path Helpers
    • FLYNCWorkspace.document_id_from_path()
    • FLYNCWorkspace.new_object_path()
    • FLYNCWorkspace.update_objects_path()
    • FLYNCWorkspace.fill_path_from_object()
  • Data structure summary