linkahead package

Subpackages

• linkahead.common package
  • Submodules
    • linkahead.common.administration module
      • PermissionRule
      • generate_password()
      • get_server_properties()
      • get_server_property()
      • set_server_property()
    • linkahead.common.datatype module
      • LIST()
      • get_id_of_datatype()
      • get_list_datatype()
      • get_referenced_recordtype()
      • is_list_datatype()
      • is_reference()
    • linkahead.common.models module
      • ACI
      • ACL
      • Container
      • DropOffBox
      • Entity
      • File
      • Info
      • Message
      • Messages
      • Parent
      • Permission
      • Permissions
      • Property
      • Query
      • QueryTemplate
      • Record
      • RecordType
      • UserInfo
      • delete()
      • execute_query()
      • get_global_acl()
      • get_known_permissions()
      • parse_xml()
      • raise_errors()
      • sync_global_acl()
    • linkahead.common.state module
      • State
      • Transition
    • linkahead.common.timezone module
      • TimeZone
    • linkahead.common.utils module
      • is_int()
      • uuid()
      • xml2str()
    • linkahead.common.versioning module
      • Version
  • Module contents
• linkahead.connection package
  • Subpackages
    • linkahead.connection.authentication package
      • Submodules
      • Module contents
  • Submodules
    • linkahead.connection.connection module
      • configure_connection()
      • get_connection()
    • linkahead.connection.encode module
      • MultipartParam
      • ReadableMultiparts
      • encode_and_quote()
      • encode_file_header()
      • encode_string()
      • gen_boundary()
      • get_body_size()
      • get_headers()
      • multipart_encode()
    • linkahead.connection.interface module
      • CaosDBHTTPResponse
      • CaosDBServerConnection
    • linkahead.connection.mockup module
      • MockUpResponse
      • MockUpServerConnection
    • linkahead.connection.utils module
      • auth_token_to_cookie()
      • make_uri_path()
      • parse_auth_token()
      • parse_url()
      • quote()
      • unquote()
      • urlencode()
  • Module contents
• linkahead.utils package
  • Submodules
    • linkahead.utils.caosdb_admin module
    • linkahead.utils.checkFileSystemConsistency module
      • CLIError
      • main()
      • runCheck()
    • linkahead.utils.create_revision module
      • bend_references()
      • create_revision()
    • linkahead.utils.escape module
      • escape_dquoted_text()
      • escape_quoted_text()
      • escape_squoted_text()
    • linkahead.utils.get_entity module
      • get_entity_by_id()
      • get_entity_by_name()
      • get_entity_by_path()
    • linkahead.utils.git_utils module
      • get_branch_in()
      • get_commit_in()
      • get_diff_in()
      • get_origin_url_in()
    • linkahead.utils.linkahead_admin module
    • linkahead.utils.plantuml module
      • Grouped
      • get_description()
      • recordtypes_to_plantuml_string()
      • retrieve_substructure()
      • to_graphics()
    • linkahead.utils.register_tests module
    • linkahead.utils.server_side_scripting module
      • ScriptingResponse
      • run_server_side_script()
  • Module contents

Submodules

• linkahead.apiutils module
  • EntityMergeConflictError
  • apply_to_ids()
  • compare_entities()
  • create_flat_list()
  • create_id_query()
  • describe_diff()
  • empty_diff()
  • getBranchIn()
  • getCommitIn()
  • getDiffIn()
  • getOriginUrlIn()
  • get_type_of_entity_with()
  • id_query()
  • merge_entities()
  • new_record()
  • resolve_reference()
  • retrieve_entities_with_ids()
  • retrieve_entity_with_id()
• linkahead.cached module
  • AccessType
    • AccessType.EID
    • AccessType.NAME
    • AccessType.PATH
    • AccessType.QUERY
  • cache_clear()
  • cache_fill()
  • cache_info()
  • cache_initialize()
  • cached_get_entity_by()
  • cached_query()
• linkahead.configuration module
  • config_to_yaml()
  • configure()
  • get_config()
  • validate_yaml_schema()
• linkahead.exceptions module
  • AmbiguousEntityError
  • AuthorizationError
  • BadQueryError
  • CaosDBConnectionError
  • CaosDBException
  • ConfigurationError
    • ConfigurationError.msg
  • ConsistencyError
  • EmptyUniqueQueryError
  • EntityDoesNotExistError
  • EntityError
    • EntityError.description
  • EntityHasNoDatatypeError
  • HTTPClientError
  • HTTPForbiddenError
  • HTTPResourceNotFoundError
  • HTTPServerError
  • HTTPURITooLongError
  • LinkAheadConnectionError
  • LinkAheadException
  • LoginFailedError
  • MismatchingEntitiesError
  • PagingConsistencyError
  • QueryNotUniqueError
  • ServerConfigurationException
  • TransactionError
    • TransactionError.add_error()
    • TransactionError.has_error()
  • UniqueNamesError
  • UnqualifiedParentsError
  • UnqualifiedPropertiesError
• linkahead.high_level_api module
  • CaosDBMultiProperty
  • CaosDBPropertyMetaData
    • CaosDBPropertyMetaData.datatype
    • CaosDBPropertyMetaData.description
    • CaosDBPropertyMetaData.id
    • CaosDBPropertyMetaData.importance
    • CaosDBPropertyMetaData.unit
  • CaosDBPythonEntity
    • CaosDBPythonEntity.add_parent()
    • CaosDBPythonEntity.attribute_as_list()
    • CaosDBPythonEntity.description
    • CaosDBPythonEntity.deserialize()
    • CaosDBPythonEntity.file
    • CaosDBPythonEntity.get_parents()
    • CaosDBPythonEntity.get_properties()
    • CaosDBPythonEntity.get_property()
    • CaosDBPythonEntity.get_property_metadata()
    • CaosDBPythonEntity.has_parent()
    • CaosDBPythonEntity.id
    • CaosDBPythonEntity.name
    • CaosDBPythonEntity.path
    • CaosDBPythonEntity.property_exists()
    • CaosDBPythonEntity.resolve_references()
    • CaosDBPythonEntity.serialize()
    • CaosDBPythonEntity.set_property()
    • CaosDBPythonEntity.use_parameter()
    • CaosDBPythonEntity.version
  • CaosDBPythonFile
    • CaosDBPythonFile.download()
  • CaosDBPythonProperty
  • CaosDBPythonRecord
  • CaosDBPythonRecordType
  • CaosDBPythonUnresolved
  • CaosDBPythonUnresolvedParent
    • CaosDBPythonUnresolvedParent.id
    • CaosDBPythonUnresolvedParent.name
  • CaosDBPythonUnresolvedReference
  • convert_to_entity()
  • convert_to_python_object()
  • create_entity_container()
  • create_record()
  • high_level_type_for_role()
  • high_level_type_for_standard_type()
  • load_external_record()
  • new_high_level_entity()
  • query()
  • standard_type_for_high_level_type()
• linkahead.yamlapi module
  • append_sublist()
  • dict_to_xml()
  • insert_yaml_file()
  • kv_to_xml()
  • process()
  • yaml_file_to_xml()
  • yaml_to_xml()

Module contents

LinkAhead Python bindings.

Tries to read from the inifile specified in the environment variable PYCAOSDBINI or alternatively in ~/.pylinkahead.ini upon import. After that, the ini file pylinkahead.ini in the current working directory will be read additionally, if it exists.