SDK

This package provides the core functionality for interacting with the FLYNC core modules, including utilities for workspace management. 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
  • Workspace Configuration
    • Overview
    • Configuration File Format
    • The Root Model Is Not Configurable From File
    • Configuration Resolution Priority
    • Persisting Configuration
    • Configuration Fields
    • Error Handling
    • API Reference
      • WorkspaceConfiguration
        • WorkspaceConfiguration.model_config
        • WorkspaceConfiguration.flync_file_extension
        • WorkspaceConfiguration.allowed_extensions
        • WorkspaceConfiguration.exclude_unset
        • WorkspaceConfiguration.root_model
        • WorkspaceConfiguration.map_objects
        • WorkspaceConfiguration.list_objects_mode
        • WorkspaceConfiguration.persist_config
        • WorkspaceConfiguration.version
        • WorkspaceConfiguration.validate_root_model()
        • WorkspaceConfiguration.validate_list_objects_mode()
        • WorkspaceConfiguration.serialize_list_objects_mode()
        • WorkspaceConfiguration.from_yaml_file()
        • WorkspaceConfiguration.from_workspace()
        • WorkspaceConfiguration.to_yaml_file()
        • WorkspaceConfiguration.create_from_config()
      • ListObjectsMode
        • ListObjectsMode.INDEX
        • ListObjectsMode.NAME
    • See Also
  • FLYNC Workspace
    • FLYNCWorkspace
      • FLYNCWorkspace.load_model()
      • FLYNCWorkspace.safe_load_workspace()
      • FLYNCWorkspace.load_workspace()
      • FLYNCWorkspace.add_list_item_object_path()
      • FLYNCWorkspace.document_id_from_path()
      • FLYNCWorkspace.fill_path_from_object()
      • FLYNCWorkspace.find_path_from_field()
      • FLYNCWorkspace.generate_configs()
      • FLYNCWorkspace.get_child_ids()
      • FLYNCWorkspace.get_definition()
      • FLYNCWorkspace.get_metadata()
      • FLYNCWorkspace.get_object()
      • FLYNCWorkspace.get_references_of()
      • FLYNCWorkspace.get_semantic_object_from_model()
      • FLYNCWorkspace.get_semantic_objects_from_model()
      • FLYNCWorkspace.get_semantic_objects_ids_from_model()
      • FLYNCWorkspace.get_source()
      • FLYNCWorkspace.has_object()
      • FLYNCWorkspace.is_flync_file()
      • FLYNCWorkspace.is_path_supported()
      • FLYNCWorkspace.list_objects()
      • FLYNCWorkspace.load_errors
      • FLYNCWorkspace.load_flync_model()
      • FLYNCWorkspace.name_form_file()
      • FLYNCWorkspace.new_object_path()
      • FLYNCWorkspace.objects_at()
      • FLYNCWorkspace.revalidate_references_of()
      • FLYNCWorkspace.save_workspace_config()
      • FLYNCWorkspace.update_document()
      • FLYNCWorkspace.update_objects_path()
    • ObjectMetadata
      • ObjectMetadata
        • ObjectMetadata.type_name
        • ObjectMetadata.name
        • ObjectMetadata.parent_id
        • ObjectMetadata.child_ids
        • ObjectMetadata.source
        • ObjectMetadata.fields
        • ObjectMetadata.to_dict()
  • Document
    • Document
      • Document.parse()
      • Document.update_text()
      • Document.assign_ast()
      • Document.source_nodes()
      • Document.normalize_uri()
  • Utils & Helpers
    • get_metadata()
    • get_name()
    • get_field_name_from_alias()
    • DocstringJsonSchema
      • DocstringJsonSchema.model_schema()
    • schema_file_name()
    • build_model_schemas()
    • dump_model_schemas()
    • safe_issubclass()
    • is_union()
    • Factory
    • FLYNCFactory
      • FLYNCFactory.get_provider_map()
      • FLYNCFactory.build()
    • ExternalConnectionFactory
      • ExternalConnectionFactory.build()
    • BASET1Factory
      • BASET1Factory.build()
    • dump_flync_workspace()
    • generate_external_node()
    • generate_node()
• Validation API
  • Imports
  • DiagnosticsResult
    • DiagnosticsResult
      • DiagnosticsResult.state
      • DiagnosticsResult.errors
      • DiagnosticsResult.model
      • DiagnosticsResult.workspace
      • DiagnosticsResult.passed
      • DiagnosticsResult.serialize_workspace()
    • WorkspaceState
      • WorkspaceState.UNKNOWN
      • WorkspaceState.EMPTY
      • WorkspaceState.LOADING
      • WorkspaceState.VALID
      • WorkspaceState.WARNING
      • WorkspaceState.INVALID
      • WorkspaceState.BROKEN
    • Reading results
  • Discovering Node Paths
    • Example
  • Validating a Full Workspace
    • Example
  • Validating an External Node
    • Example — using a type
    • Example — using a string name
  • Validating a Partial (In-Workspace) Node
    • Path syntax reference
    • Example
  • Node metadata reference
    • NodeInfo
      • NodeInfo.name
      • NodeInfo.python_type
      • NodeInfo.flync_paths
      • NodeInfo.discriminator_fields
      • 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
    • 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
      • SemanticObject.id
      • SemanticObject.model
    • ObjectId
  • Runtime Retrieval
    • List all object IDs
    • Retrieve a semantic object
    • Retrieve the source location
    • Look up objects by file position
  • Object Path Helpers
  • Data structure summary